Package com.intellij.codeInspection.reference

Interface RefMethod

All Superinterfaces:

RefElement, RefEntity, RefJavaElement, UserDataHolder

All Known Subinterfaces:

RefImplicitConstructor

All Known Implementing Classes:

RefImplicitConstructorImpl, RefMethodImpl

public interface RefMethod
extends RefJavaElement

A node in the reference graph corresponding to a Java method.

Field Summary

Fields inherited from interface com.intellij.codeInspection.reference.RefEntity

EMPTY_ELEMENTS_ARRAY

Method Summary

Modifier and Type	Method and Description
java.util.Collection<RefMethod>	getDerivedMethods() Returns the collection of the overriding methods of this method in the analysis scope.
default PsiModifierListOwner	getElement() Deprecated.
RefClass	getOwnerClass() Returns the class to which the method belongs.
RefParameter []	getParameters() Returns the list of reference graph nodes for the method parameters.
java.lang.String	getReturnValueIfSame() If the method always returns the same value, returns that value (the name of a static final field or the text of a literal expression).
java.util.Collection<RefMethod>	getSuperMethods() Returns the collection of the direct super methods of this method in the analysis scope.
default UDeclaration	getUastElement()
PsiClass []	getUnThrownExceptions() Returns the list of exceptions which are included in the throws list of the method but cannot be actually thrown.
boolean	hasBody() Checks if this method has a body (that is, not a method of an interface or an abstract method).
boolean	hasSuperMethods() Checks if the method has super methods either in the analysis scope or outside of it.
boolean	isAbstract() Checks if the method is abstract.
boolean	isAppMain() Checks if the signature of the method matches the signature of the standard main or premain method.
boolean	isBodyEmpty() Checks if the method has no body or its body contains no statements besides (possibly) a call to its super method.
boolean	isCalledOnSubClass()
boolean	isConstructor() Checks if the method is a constructor.
boolean	isExternalOverride() Checks if the method overrides a method outside the current analysis scope.
boolean	isOnlyCallsSuper() Checks if the method has a body which consists only of the call to its super method.
boolean	isReturnValueUsed() Checks if the return value of the method is used by any of its callers.
boolean	isTestMethod() Checks if the method is a test method in a testcase class.

Methods inherited from interface com.intellij.codeInspection.reference.RefJavaElement

getAccessModifier, getOutTypeReferences, getPsiElement, isFinal, isStatic, isSyntheticJSP

Methods inherited from interface com.intellij.codeInspection.reference.RefElement

getContainingEntry, getInReferences, getModule, getOutReferences, getPointer, isEntry, isPermanentEntry, isReachable, isReferenced

Methods inherited from interface com.intellij.codeInspection.reference.RefEntity

accept, getChildren, getExternalName, getIcon, getName, getOwner, getQualifiedName, getRefManager, isValid

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

getSuperMethods

java.util.Collection<RefMethod> getSuperMethods()

Returns the collection of the direct super methods of this method in the analysis scope.

Returns:

the collection of super methods.

See Also:

PsiMethod.findSuperMethods(), hasSuperMethods()

getDerivedMethods

java.util.Collection<RefMethod> getDerivedMethods()

Returns the collection of the overriding methods of this method in the analysis scope.

Returns:

the collection of overriding methods.

hasBody

boolean hasBody()

Checks if this method has a body (that is, not a method of an interface or an abstract method).

Returns:

true if the method has a body, false otherwise.

isBodyEmpty

boolean isBodyEmpty()

Checks if the method has no body or its body contains no statements besides (possibly) a call to its super method.

Returns:

true if the element has no body or the body is empty, false otherwise.

isOnlyCallsSuper

boolean isOnlyCallsSuper()

Checks if the method has a body which consists only of the call to its super method.

Returns:

true if the method only calls its super method, false otherwise.

isTestMethod

boolean isTestMethod()

Checks if the method is a test method in a testcase class.

Returns:

true if the method is a test method, false otherwise.

isAppMain

boolean isAppMain()

Checks if the signature of the method matches the signature of the standard main or premain method.

Returns:

true if the method can be a main function of the application, false otherwise.

hasSuperMethods

boolean hasSuperMethods()

Checks if the method has super methods either in the analysis scope or outside of it.

Returns:

true if the method has super methods, false otherwise.

See Also:

getSuperMethods()

isExternalOverride

boolean isExternalOverride()

Checks if the method overrides a method outside the current analysis scope.

Returns:

true if the method overrides a method not in the analysis scope, false otherwise.

isConstructor

boolean isConstructor()

Checks if the method is a constructor.

Returns:

true if the method is a constructor, false otherwise.

isAbstract

boolean isAbstract()

Checks if the method is abstract.

Returns:

true if the method is abstract, false otherwise.

isReturnValueUsed

boolean isReturnValueUsed()

Checks if the return value of the method is used by any of its callers.

Returns:

true if the method return value is used, false otherwise.

getReturnValueIfSame

java.lang.String getReturnValueIfSame()

If the method always returns the same value, returns that value (the name of a static final field or the text of a literal expression). Otherwise, returns null.

Returns:

the method return value or null if it's different or impossible to determine.

getUnThrownExceptions

PsiClass [] getUnThrownExceptions()

Returns the list of exceptions which are included in the throws list of the method but cannot be actually thrown. To return valid results, requires com.intellij.codeInspection.unneededThrows.RedundantThrowsGraphAnnotator. (Dbl) Annotator registration is possible in InspectionProfileEntry.initialize(com.intellij.codeInspection.GlobalInspectionContext) or GlobalInspectionTool.getAnnotator(RefManager)

Returns:

the list of exceptions declared but not thrown, or null if there are no such exceptions.

getParameters

RefParameter [] getParameters()

Returns the list of reference graph nodes for the method parameters.

Returns:

the method parameters.

getOwnerClass

RefClass getOwnerClass()

Returns the class to which the method belongs.

Returns:

the class instance.

getElement

@Deprecated
default PsiModifierListOwner getElement()

Deprecated.

Specified by:

getElement in interface RefElement

Specified by:

getElement in interface RefJavaElement

getUastElement

default UDeclaration getUastElement()

Specified by:

getUastElement in interface RefJavaElement

isCalledOnSubClass

boolean isCalledOnSubClass()