Package com.intellij.codeInspection.deprecation

Class DeprecationInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.deprecation.DeprecationInspectionBase

com.intellij.codeInspection.deprecation.DeprecationInspection

All Implemented Interfaces:

BatchSuppressableTool

public class DeprecationInspection
extends DeprecationInspectionBase

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
boolean	IGNORE_ABSTRACT_DEPRECATED_OVERRIDES
boolean	IGNORE_IMPORT_STATEMENTS
boolean	IGNORE_INSIDE_DEPRECATED
boolean	IGNORE_METHODS_OF_DEPRECATED
static java.lang.String	IGNORE_METHODS_OF_DEPRECATED_NAME
static java.lang.String	SHORT_NAME

Fields inherited from class com.intellij.codeInspection.deprecation.DeprecationInspectionBase

IGNORE_IN_SAME_OUTERMOST_CLASS

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

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
java.lang.String	getGroupDisplayName()
java.lang.String	getID() If you want to change suppression id you have to define it in XML as well.
java.lang.String	getShortName() DO NOT OVERRIDE this method.

Methods inherited from class com.intellij.codeInspection.deprecation.DeprecationInspectionBase

checkDeprecated, getDescription, getPresentableName, isElementInsideDeprecated, isEnabledByDefault, isForRemovalAttributeSet, isForRemovalAttributeSet

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, checkFile, getAlternativeID, 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, isInitialized, isSuppressedFor, loadDescription, readSettings, showDefaultConfigurationOptions, writeSettings

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

IGNORE_METHODS_OF_DEPRECATED_NAME

public static final java.lang.String IGNORE_METHODS_OF_DEPRECATED_NAME

See Also:

Constant Field Values

IGNORE_INSIDE_DEPRECATED

public boolean IGNORE_INSIDE_DEPRECATED

IGNORE_ABSTRACT_DEPRECATED_OVERRIDES

public boolean IGNORE_ABSTRACT_DEPRECATED_OVERRIDES

IGNORE_IMPORT_STATEMENTS

public boolean IGNORE_IMPORT_STATEMENTS

IGNORE_METHODS_OF_DEPRECATED

public boolean IGNORE_METHODS_OF_DEPRECATED

Constructor Detail

DeprecationInspection

public DeprecationInspection()

Method Detail

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 LocalInspectionTool

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

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

getID

public java.lang.String getID()

Description copied from class: LocalInspectionTool

If you want to change suppression id you have to define it in XML as well.

Inspection tool ID is a descriptive name to be used in "suppress" comments and annotations.

It must satisfy LocalInspectionTool.VALID_ID_PATTERN regexp pattern.

If not defined InspectionProfileEntry.getShortName() is used as tool ID.

Overrides:

getID in class LocalInspectionTool

Returns:

inspection tool ID.

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.