Package com.intellij.codeInspection.unusedReturnValue

Class UnusedReturnValueLocalInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.unusedReturnValue.UnusedReturnValueLocalInspection

All Implemented Interfaces:

BatchSuppressableTool

public class UnusedReturnValueLocalInspection
extends AbstractBaseJavaLocalInspectionTool

Field Summary

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
UnusedReturnValueLocalInspection(UnusedReturnValue global)

Method Summary

Modifier and Type	Method and Description
ProblemDescriptor []	checkMethod(PsiMethod method, InspectionManager manager, boolean isOnTheFly) Override this to report problems at method level.
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
boolean	runForWholeFile() Override this method and return true if your inspection (unlike almost all others) must be called for every element in the whole file for each change, whatever small it was.

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

buildVisitor, checkClass, checkField

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

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

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UnusedReturnValueLocalInspection

public UnusedReturnValueLocalInspection(UnusedReturnValue global)

Method Detail

runForWholeFile

public boolean runForWholeFile()

Description copied from class: LocalInspectionTool

Override this method and return true if your inspection (unlike almost all others) must be called for every element in the whole file for each change, whatever small it was.

For example, 'Field can be local' inspection can report the field declaration when reference to it was added inside method hundreds lines below. Hence, this inspection must be rerun on every change.

Please note that re-scanning the whole file can take considerable time and thus seriously impact the responsiveness, so beg please use this mechanism once in a blue moon.

Overrides:

runForWholeFile in class LocalInspectionTool

Returns:

true if inspection should be called for every element.

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

checkMethod

public ProblemDescriptor [] checkMethod(PsiMethod method,
                                        InspectionManager manager,
                                        boolean isOnTheFly)

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at method level.

Overrides:

checkMethod in class AbstractBaseJavaLocalInspectionTool

Parameters:

method - to check.

manager - InspectionManager to ask for ProblemDescriptors from.

isOnTheFly - true if called during on the fly editor highlighting. Called from Inspect Code action otherwise.

Returns:

null if no problems found or not applicable at method level.