Package com.intellij.codeInspection.dataFlow

Class DataFlowInspectionBase

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.dataFlow.DataFlowInspectionBase

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

DataFlowInspection

public abstract class DataFlowInspectionBase
extends AbstractBaseJavaLocalInspectionTool

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataFlowInspectionBase.ConstantResult
protected static class	DataFlowInspectionBase.ProblemReporter ProblemsHolder wrapper to avoid reporting two problems on the same anchor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	DONT_REPORT_TRUE_ASSERT_STATEMENTS
boolean	IGNORE_ASSERT_STATEMENTS
boolean	REPORT_CONSTANT_REFERENCE_VALUES
boolean	REPORT_NULLABLE_METHODS_RETURNING_NOT_NULL
boolean	REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER
boolean	REPORT_UNSOUND_WARNINGS
boolean	SUGGEST_NULLABLE_ANNOTATIONS
boolean	TREAT_UNKNOWN_MEMBERS_AS_NULLABLE

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool

EMPTY_ARRAY, VALID_ID_PATTERN

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
DataFlowInspectionBase()

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
protected java.util.List<LocalQuickFix>	createCastFixes(PsiTypeCastExpression castExpression, PsiType realType, boolean onTheFly, boolean alwaysFails)
protected LocalQuickFix[]	createConditionalAssignmentFixes(boolean evaluatesToTrue, PsiAssignmentExpression parent, boolean onTheFly)
protected LocalQuickFix	createExplainFix(PsiExpression anchor, TrackingRunner.DfaProblemType problemType)
protected LocalQuickFix	createIntroduceVariableFix()
protected java.util.List<LocalQuickFix>	createMethodReferenceNPEFixes(PsiMethodReferenceExpression methodRef, boolean onTheFly)
protected LocalQuickFix	createMutabilityViolationFix(PsiElement violation, boolean onTheFly)
protected LocalQuickFix	createNavigateToNullParameterUsagesFix(PsiParameter parameter)
protected java.util.List<LocalQuickFix>	createNPEFixes(PsiExpression qualifier, PsiExpression expression, boolean onTheFly)
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
protected LocalQuickFix	createRemoveAssignmentFix(PsiAssignmentExpression assignment)
protected LocalQuickFix	createReplaceWithTrivialLambdaFix(java.lang.Object value)
protected LocalQuickFixOnPsiElement	createSimplifyBooleanFix(PsiElement element, boolean value)
protected static LocalQuickFix	createSimplifyToAssignmentFix()
protected LocalQuickFix	createUnwrapSwitchLabelFix()
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
protected void	reportNullabilityProblems(DataFlowInspectionBase.ProblemReporter reporter, java.util.List<NullabilityProblemKind.NullabilityProblem<?>> problems, java.util.Map<PsiExpression,DataFlowInspectionBase.ConstantResult> expressions)
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

checkClass, checkField, checkMethod

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, checkFile, getAlternativeID, getID, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, initialize, isEnabledByDefault, isInitialized, isSuppressedFor, loadDescription, readSettings, showDefaultConfigurationOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUGGEST_NULLABLE_ANNOTATIONS

public boolean SUGGEST_NULLABLE_ANNOTATIONS

DONT_REPORT_TRUE_ASSERT_STATEMENTS

public boolean DONT_REPORT_TRUE_ASSERT_STATEMENTS

TREAT_UNKNOWN_MEMBERS_AS_NULLABLE

public boolean TREAT_UNKNOWN_MEMBERS_AS_NULLABLE

IGNORE_ASSERT_STATEMENTS

public boolean IGNORE_ASSERT_STATEMENTS

REPORT_CONSTANT_REFERENCE_VALUES

public boolean REPORT_CONSTANT_REFERENCE_VALUES

REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER

public boolean REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER

REPORT_NULLABLE_METHODS_RETURNING_NOT_NULL

public boolean REPORT_NULLABLE_METHODS_RETURNING_NOT_NULL

REPORT_UNSOUND_WARNINGS

public boolean REPORT_UNSOUND_WARNINGS

Constructor Detail

DataFlowInspectionBase

public DataFlowInspectionBase()

Method Detail

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Description copied from class: InspectionProfileEntry

This method is called each time UI is shown.

Overrides:

createOptionsPanel in class InspectionProfileEntry

Returns:

null if no UI options required.

writeSettings

public void writeSettings(Element node)
                   throws WriteExternalException

Description copied from class: InspectionProfileEntry

Store current settings in XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

writeSettings in class InspectionProfileEntry

Parameters:

node - to store settings to.

Throws:

WriteExternalException

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly)

Description copied from class: LocalInspectionTool

Override the method to provide your own inspection visitor. Created visitor must not be recursive (e.g. it must not inherit PsiRecursiveElementVisitor) since it will be fed with every element in the file anyway. Visitor created must be thread-safe since it might be called on several elements concurrently.

Overrides:

buildVisitor in class AbstractBaseJavaLocalInspectionTool

Parameters:

holder - where visitor will register problems found.

isOnTheFly - true if inspection was run in non-batch mode

Returns:

not-null visitor for this inspection.

See Also:

PsiRecursiveVisitor

createNavigateToNullParameterUsagesFix

protected LocalQuickFix createNavigateToNullParameterUsagesFix(PsiParameter parameter)

createCastFixes

protected java.util.List<LocalQuickFix> createCastFixes(PsiTypeCastExpression castExpression,
                                                        PsiType realType,
                                                        boolean onTheFly,
                                                        boolean alwaysFails)

createNPEFixes

protected java.util.List<LocalQuickFix> createNPEFixes(PsiExpression qualifier,
                                                       PsiExpression expression,
                                                       boolean onTheFly)

createMethodReferenceNPEFixes

protected java.util.List<LocalQuickFix> createMethodReferenceNPEFixes(PsiMethodReferenceExpression methodRef,
                                                                      boolean onTheFly)

createUnwrapSwitchLabelFix

protected LocalQuickFix createUnwrapSwitchLabelFix()

createIntroduceVariableFix

protected LocalQuickFix createIntroduceVariableFix()

createRemoveAssignmentFix

protected LocalQuickFix createRemoveAssignmentFix(PsiAssignmentExpression assignment)

createReplaceWithTrivialLambdaFix

protected LocalQuickFix createReplaceWithTrivialLambdaFix(java.lang.Object value)

createMutabilityViolationFix

protected LocalQuickFix createMutabilityViolationFix(PsiElement violation,
                                                     boolean onTheFly)

reportNullabilityProblems

protected void reportNullabilityProblems(DataFlowInspectionBase.ProblemReporter reporter,
                                         java.util.List<NullabilityProblemKind.NullabilityProblem<?>> problems,
                                         java.util.Map<PsiExpression,DataFlowInspectionBase.ConstantResult> expressions)

createExplainFix

protected LocalQuickFix createExplainFix(PsiExpression anchor,
                                         TrackingRunner.DfaProblemType problemType)

createConditionalAssignmentFixes

protected LocalQuickFix[] createConditionalAssignmentFixes(boolean evaluatesToTrue,
                                                           PsiAssignmentExpression parent,
                                                           boolean onTheFly)

createSimplifyToAssignmentFix

protected static LocalQuickFix createSimplifyToAssignmentFix()

createSimplifyBooleanFix

protected LocalQuickFixOnPsiElement createSimplifyBooleanFix(PsiElement element,
                                                             boolean value)

getGroupDisplayName

public java.lang.String getGroupDisplayName()

Overrides:

getGroupDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle

getShortName

public java.lang.String getShortName()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

getShortName in class InspectionProfileEntry

See Also:

InspectionEP.shortName