Package com.intellij.codeInspection.deprecation

Class DeprecatedApiUsageProcessor

java.lang.Object

com.intellij.codeInspection.deprecation.DeprecatedApiUsageProcessor

All Implemented Interfaces:

ApiUsageProcessor

public final class DeprecatedApiUsageProcessor
extends java.lang.Object
implements ApiUsageProcessor

PSI visitor that detects usages of deprecated APIs, which are deprecated with @Deprecated, @ScheduledForRemoval annotations or @deprecated Javadoc tag.

Constructor Summary

Constructors

Constructor and Description
DeprecatedApiUsageProcessor(ProblemsHolder holder, boolean ignoreInsideDeprecated, boolean ignoreAbstractDeprecatedOverrides, boolean ignoreImportStatements, boolean ignoreMethodsOfDeprecated, boolean ignoreInSameOutermostClass, boolean forRemoval, HighlightSeverity severity)

Method Summary

Modifier and Type	Method and Description
void	processConstructorInvocation(UElement sourceNode, PsiClass instantiatedClass, PsiMethod constructor, UClass subclassDeclaration) Process constructor invocation of a class. The invoked constructor may be the default constructor, which is not declared in source code. The constructor invocation may be implicit: in declaration of a subclass with no constructors defined, in declaration of an anonymous class, as implicit super() invocation in subclass' constructor, etc.
void	processImportReference(UElement sourceNode, PsiModifierListOwner target) Process reference to an imported API element.
void	processJavaModuleReference(PsiJavaModuleReference javaModuleReference, PsiJavaModule target) Process reference to a Java module found in module-info.java file.
void	processMethodOverriding(UMethod method, PsiMethod overriddenMethod) Process overriding of a super class' method.
void	processReference(UElement sourceNode, PsiModifierListOwner target, UExpression qualifier) Process reference to a class, method (not constructor), field or any other API element found in source code.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeprecatedApiUsageProcessor

public DeprecatedApiUsageProcessor(ProblemsHolder holder,
                                   boolean ignoreInsideDeprecated,
                                   boolean ignoreAbstractDeprecatedOverrides,
                                   boolean ignoreImportStatements,
                                   boolean ignoreMethodsOfDeprecated,
                                   boolean ignoreInSameOutermostClass,
                                   boolean forRemoval,
                                   HighlightSeverity severity)

Method Detail

processReference

public void processReference(UElement sourceNode,
                             PsiModifierListOwner target,
                             UExpression qualifier)

Description copied from interface: ApiUsageProcessor

Process reference to a class, method (not constructor), field or any other API element found in source code.

Specified by:

processReference in interface ApiUsageProcessor

Parameters:

sourceNode - can be used to get actual PSI element to highlight in inspections via sourceNode.sourcePsi

target - resolved API element

qualifier - is optionally a qualified expression of the reference.

processImportReference

public void processImportReference(UElement sourceNode,
                                   PsiModifierListOwner target)

Description copied from interface: ApiUsageProcessor

Process reference to an imported API element.

Specified by:

processImportReference in interface ApiUsageProcessor

Parameters:

sourceNode - can be used to get actual PSI element to highlight in inspections via sourceNode.sourcePsi

target - resolved API element being imported

processConstructorInvocation

public void processConstructorInvocation(UElement sourceNode,
                                         PsiClass instantiatedClass,
                                         PsiMethod constructor,
                                         UClass subclassDeclaration)

Description copied from interface: ApiUsageProcessor

Process constructor invocation of a class.
The invoked constructor may be the default constructor, which is not declared in source code.
The constructor invocation may be implicit: in declaration of a subclass with no constructors defined, in declaration of an anonymous class, as implicit super() invocation in subclass' constructor, etc.

Specified by:

processConstructorInvocation in interface ApiUsageProcessor

Parameters:

sourceNode - can be used to get actual PSI element to highlight in inspections via sourceNode.sourcePsi

instantiatedClass - class being instantiated

constructor - PSI constructor defined in source code, or null if the default constructor is being invoked.

subclassDeclaration - declaration of a subclass or anonymous subclass where the constructor invocation's happens, or null if the constructor is being invoked explicitly.

processMethodOverriding

public void processMethodOverriding(UMethod method,
                                    PsiMethod overriddenMethod)

Description copied from interface: ApiUsageProcessor

Process overriding of a super class' method.

Specified by:

processMethodOverriding in interface ApiUsageProcessor

Parameters:

method - method that overrides the parent's method. method.uastAnchor.sourcePsi can be be used to highlight name declaration.

overriddenMethod - super class' method being overridden

processJavaModuleReference

public void processJavaModuleReference(PsiJavaModuleReference javaModuleReference,
                                       PsiJavaModule target)

Description copied from interface: ApiUsageProcessor

Process reference to a Java module found in module-info.java file.

Specified by:

processJavaModuleReference in interface ApiUsageProcessor

Parameters:

javaModuleReference - Java module reference

target - resolved Java module