Package com.intellij.codeInspection.apiUsage

Interface ApiUsageProcessor

All Known Implementing Classes:

DeprecatedApiUsageProcessor

public interface ApiUsageProcessor

Processes usages of APIs in source code of UAST-supporting languages, which are detected by ApiUsageUastVisitor.

Method Summary

Modifier and Type	Method and Description
default 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.
default void	processImportReference(UElement sourceNode, PsiModifierListOwner target) Process reference to an imported API element.
default void	processJavaModuleReference(PsiJavaModuleReference javaModuleReference, PsiJavaModule target) Process reference to a Java module found in module-info.java file.
default void	processMethodOverriding(UMethod method, PsiMethod overriddenMethod) Process overriding of a super class' method.
default 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.

Method Detail

processReference

default 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.

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

default void processImportReference(UElement sourceNode,
                                    PsiModifierListOwner target)

Process reference to an imported API element.

Parameters:

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

target - resolved API element being imported

processConstructorInvocation

default 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.

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

default void processMethodOverriding(UMethod method,
                                     PsiMethod overriddenMethod)

Process overriding of a super class' method.

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

default void processJavaModuleReference(PsiJavaModuleReference javaModuleReference,
                                        PsiJavaModule target)

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

Parameters:

javaModuleReference - Java module reference

target - resolved Java module