Package com.intellij.codeInspection.nullable

Class NullableStuffInspectionBase

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.nullable.NullableStuffInspectionBase

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

NullableStuffInspection

public class NullableStuffInspectionBase
extends AbstractBaseJavaLocalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	IGNORE_EXTERNAL_SUPER_NOTNULL
boolean	REPORT_ANNOTATION_NOT_PROPAGATED_TO_OVERRIDERS Deprecated.
boolean	REPORT_NOT_ANNOTATED_GETTER
boolean	REPORT_NOT_ANNOTATED_METHOD_OVERRIDES_NOTNULL
boolean	REPORT_NOT_ANNOTATED_PARAMETER_OVERRIDES_NOTNULL Deprecated.
boolean	REPORT_NOT_ANNOTATED_SETTER_PARAMETER Deprecated.
boolean	REPORT_NOTNULL_PARAMETER_OVERRIDES_NULLABLE
boolean	REPORT_NOTNULL_PARAMETERS_OVERRIDES_NOT_ANNOTATED
boolean	REPORT_NULLABLE_METHOD_OVERRIDES_NOTNULL Deprecated.
boolean	REPORT_NULLS_PASSED_TO_NON_ANNOTATED_METHOD
boolean	REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER

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
NullableStuffInspectionBase()

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
protected LocalQuickFix	createNavigateToNullParameterUsagesFix(PsiParameter parameter)
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
java.lang.String	getGroupDisplayName()
static java.lang.String	getPresentableAnnoName(PsiAnnotation annotation)
java.lang.String	getShortName() DO NOT OVERRIDE this method.
static boolean	isNullableNotInferred(PsiModifierListOwner owner, boolean checkBases)
static boolean	shouldSkipOverriderAsGenerated(PsiMethod overriding)
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

REPORT_NULLABLE_METHOD_OVERRIDES_NOTNULL

@Deprecated
public boolean REPORT_NULLABLE_METHOD_OVERRIDES_NOTNULL

Deprecated.

REPORT_NOT_ANNOTATED_METHOD_OVERRIDES_NOTNULL

public boolean REPORT_NOT_ANNOTATED_METHOD_OVERRIDES_NOTNULL

REPORT_NOTNULL_PARAMETER_OVERRIDES_NULLABLE

public boolean REPORT_NOTNULL_PARAMETER_OVERRIDES_NULLABLE

REPORT_NOT_ANNOTATED_PARAMETER_OVERRIDES_NOTNULL

@Deprecated
public boolean REPORT_NOT_ANNOTATED_PARAMETER_OVERRIDES_NOTNULL

Deprecated.

REPORT_NOT_ANNOTATED_GETTER

public boolean REPORT_NOT_ANNOTATED_GETTER

IGNORE_EXTERNAL_SUPER_NOTNULL

public boolean IGNORE_EXTERNAL_SUPER_NOTNULL

REPORT_NOTNULL_PARAMETERS_OVERRIDES_NOT_ANNOTATED

public boolean REPORT_NOTNULL_PARAMETERS_OVERRIDES_NOT_ANNOTATED

REPORT_NOT_ANNOTATED_SETTER_PARAMETER

@Deprecated
public boolean REPORT_NOT_ANNOTATED_SETTER_PARAMETER

Deprecated.

REPORT_ANNOTATION_NOT_PROPAGATED_TO_OVERRIDERS

@Deprecated
public boolean REPORT_ANNOTATION_NOT_PROPAGATED_TO_OVERRIDERS

Deprecated.

REPORT_NULLS_PASSED_TO_NON_ANNOTATED_METHOD

public boolean REPORT_NULLS_PASSED_TO_NON_ANNOTATED_METHOD

REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER

public boolean REPORT_NULLS_PASSED_TO_NOT_NULL_PARAMETER

Constructor Detail

NullableStuffInspectionBase

public NullableStuffInspectionBase()

Method Detail

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)

getPresentableAnnoName

public static java.lang.String getPresentableAnnoName(PsiAnnotation annotation)

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

shouldSkipOverriderAsGenerated

public static boolean shouldSkipOverriderAsGenerated(PsiMethod overriding)

isNullableNotInferred

public static boolean isNullableNotInferred(PsiModifierListOwner owner,
                                            boolean checkBases)

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.