Package com.intellij.codeInspection.reference

Class RefMethodImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInspection.reference.RefEntityImpl

com.intellij.codeInspection.reference.RefElementImpl

com.intellij.codeInspection.reference.RefJavaElementImpl

com.intellij.codeInspection.reference.RefMethodImpl

All Implemented Interfaces:

RefElement, RefEntity, RefJavaElement, RefMethod, WritableRefElement, WritableRefEntity, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

RefImplicitConstructorImpl

public class RefMethodImpl
extends RefJavaElementImpl
implements RefMethod

Field Summary

Fields inherited from class com.intellij.codeInspection.reference.RefElementImpl

IS_REACHABLE_MASK, LOG

Fields inherited from class com.intellij.codeInspection.reference.RefEntityImpl

myChildren, myFlags, myManager

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

EMPTY_ELEMENTS_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefMethodImpl(java.lang.String name, RefClass ownerClass)

Method Summary

Modifier and Type	Method and Description
void	accept(RefVisitor visitor) Accepts the specified visitor and passes self to one of its visit methods.
void	add(RefEntity child)
void	addSuperMethod(RefMethodImpl refSuperMethod)
void	buildReferences()
static PsiMethod	findPsiMethod(PsiManager manager, java.lang.String externalName)
java.util.List<RefEntity>	getChildren() Returns the list of children of the node.
java.util.Collection<RefMethod>	getDerivedMethods() Returns the collection of the overriding methods of this method in the analysis scope.
java.lang.String	getExternalName() Returns a user-readable name for the element corresponding to the node.
java.lang.String	getName() Returns the name of the node.
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.
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	hasSuspiciousCallers()
protected void	initialize()
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.
static boolean	isEmptyExpression(UExpression expression)
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	isReferenced() Checks if this element is referenced by any other elements.
boolean	isReturnValueUsed() Checks if the return value of the method is used by any of its callers.
boolean	isSuspicious()
boolean	isTestMethod() Checks if the method is a test method in a testcase class.
void	markExtended(RefMethodImpl method)
void	referenceRemoved()
void	removeUnThrownExceptions(PsiClass unThrownException)
void	setBodyEmpty(boolean bodyEmpty)
void	setLibraryOverride(boolean libraryOverride)
void	setParametersAreUnknown()
void	updateThrowsList(PsiClassType exceptionType)

Methods inherited from class com.intellij.codeInspection.reference.RefJavaElementImpl

getAccessModifier, getIcon, getName, getOutTypeReferences, isFinal, isProtectedAccessForbidden, isStatic, isSuspiciousRecursive, isSyntheticJSP, markReferenced, setAccessModifier

Methods inherited from class com.intellij.codeInspection.reference.RefElementImpl

addInReference, addOutReference, addSuppression, getContainingEntry, getContainingFile, getInReferences, getModule, getOutReferences, getPointer, getPsiElement, getURL, getVirtualFile, isDeleted, isEntry, isPermanentEntry, isReachable, isSuppressed, isValid, setEntry, setPermanentEntry, setReachable

Methods inherited from class com.intellij.codeInspection.reference.RefEntityImpl

checkFlag, getOwner, getQualifiedName, getRefManager, removeChild, setFlag, setOwner, toString

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

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

getElement

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

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

getIcon, getOwner, getQualifiedName, getRefManager, isValid

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

getUserData, putUserData

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

removeChild, setOwner

Constructor Detail

RefMethodImpl

protected RefMethodImpl(java.lang.String name,
                        RefClass ownerClass)

Method Detail

add

public void add(RefEntity child)

Specified by:

add in interface WritableRefEntity

Overrides:

add in class RefEntityImpl

getChildren

public java.util.List<RefEntity> getChildren()

Description copied from interface: RefEntity

Returns the list of children of the node.

Specified by:

getChildren in interface RefEntity

Overrides:

getChildren in class RefEntityImpl

Returns:

the list of children.

initialize

protected void initialize()

Specified by:

initialize in class RefElementImpl

setParametersAreUnknown

public void setParametersAreUnknown()

getSuperMethods

public java.util.Collection<RefMethod> getSuperMethods()

Description copied from interface: RefMethod

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

Specified by:

getSuperMethods in interface RefMethod

Returns:

the collection of super methods.

See Also:

PsiMethod.findSuperMethods(), RefMethod.hasSuperMethods()

getDerivedMethods

public java.util.Collection<RefMethod> getDerivedMethods()

Description copied from interface: RefMethod

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

Specified by:

getDerivedMethods in interface RefMethod

Returns:

the collection of overriding methods.

isBodyEmpty

public boolean isBodyEmpty()

Description copied from interface: RefMethod

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

Specified by:

isBodyEmpty in interface RefMethod

Returns:

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

isOnlyCallsSuper

public boolean isOnlyCallsSuper()

Description copied from interface: RefMethod

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

Specified by:

isOnlyCallsSuper in interface RefMethod

Returns:

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

hasBody

public boolean hasBody()

Description copied from interface: RefMethod

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

Specified by:

hasBody in interface RefMethod

Returns:

true if the method has a body, false otherwise.

addSuperMethod

public void addSuperMethod(RefMethodImpl refSuperMethod)

markExtended

public void markExtended(RefMethodImpl method)

getParameters

public RefParameter [] getParameters()

Description copied from interface: RefMethod

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

Specified by:

getParameters in interface RefMethod

Returns:

the method parameters.

buildReferences

public void buildReferences()

Overrides:

buildReferences in class RefElementImpl

removeUnThrownExceptions

public void removeUnThrownExceptions(PsiClass unThrownException)

accept

public void accept(RefVisitor visitor)

Description copied from interface: RefEntity

Accepts the specified visitor and passes self to one of its visit methods.

Specified by:

accept in interface RefEntity

Overrides:

accept in class RefEntityImpl

Parameters:

visitor - the visitor to accept.

isExternalOverride

public boolean isExternalOverride()

Description copied from interface: RefMethod

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

Specified by:

isExternalOverride in interface RefMethod

Returns:

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

isAppMain

public boolean isAppMain()

Description copied from interface: RefMethod

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

Specified by:

isAppMain in interface RefMethod

Returns:

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

isAbstract

public boolean isAbstract()

Description copied from interface: RefMethod

Checks if the method is abstract.

Specified by:

isAbstract in interface RefMethod

Returns:

true if the method is abstract, false otherwise.

hasSuperMethods

public boolean hasSuperMethods()

Description copied from interface: RefMethod

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

Specified by:

hasSuperMethods in interface RefMethod

Returns:

true if the method has super methods, false otherwise.

See Also:

RefMethod.getSuperMethods()

isReferenced

public boolean isReferenced()

Description copied from interface: RefElement

Checks if this element is referenced by any other elements.

Specified by:

isReferenced in interface RefElement

Overrides:

isReferenced in class RefElementImpl

Returns:

true if the element is referenced, false otherwise.

hasSuspiciousCallers

public boolean hasSuspiciousCallers()

Overrides:

hasSuspiciousCallers in class RefElementImpl

isConstructor

public boolean isConstructor()

Description copied from interface: RefMethod

Checks if the method is a constructor.

Specified by:

isConstructor in interface RefMethod

Returns:

true if the method is a constructor, false otherwise.

getOwnerClass

public RefClass getOwnerClass()

Description copied from interface: RefMethod

Returns the class to which the method belongs.

Specified by:

getOwnerClass in interface RefMethod

Returns:

the class instance.

getName

public java.lang.String getName()

Description copied from interface: RefEntity

Returns the name of the node.

Specified by:

getName in interface RefEntity

Overrides:

getName in class RefEntityImpl

Returns:

the name of the node.

getExternalName

public java.lang.String getExternalName()

Description copied from interface: RefEntity

Returns a user-readable name for the element corresponding to the node.

Specified by:

getExternalName in interface RefEntity

Overrides:

getExternalName in class RefElementImpl

Returns:

the user-readable name.

findPsiMethod

public static PsiMethod findPsiMethod(PsiManager manager,
                                      java.lang.String externalName)

referenceRemoved

public void referenceRemoved()

Overrides:

referenceRemoved in class RefJavaElementImpl

isSuspicious

public boolean isSuspicious()

Overrides:

isSuspicious in class RefElementImpl

isReturnValueUsed

public boolean isReturnValueUsed()

Description copied from interface: RefMethod

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

Specified by:

isReturnValueUsed in interface RefMethod

Returns:

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

getReturnValueIfSame

public java.lang.String getReturnValueIfSame()

Description copied from interface: RefMethod

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.

Specified by:

getReturnValueIfSame in interface RefMethod

Returns:

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

updateThrowsList

public void updateThrowsList(PsiClassType exceptionType)

getUnThrownExceptions

public PsiClass [] getUnThrownExceptions()

Description copied from interface: RefMethod

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)

Specified by:

getUnThrownExceptions in interface RefMethod

Returns:

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

setLibraryOverride

public void setLibraryOverride(boolean libraryOverride)

setBodyEmpty

public void setBodyEmpty(boolean bodyEmpty)

isTestMethod

public boolean isTestMethod()

Description copied from interface: RefMethod

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

Specified by:

isTestMethod in interface RefMethod

Returns:

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

getUastElement

public UDeclaration getUastElement()

Specified by:

getUastElement in interface RefJavaElement

Specified by:

getUastElement in interface RefMethod

isCalledOnSubClass

public boolean isCalledOnSubClass()

Specified by:

isCalledOnSubClass in interface RefMethod

isEmptyExpression

public static boolean isEmptyExpression(UExpression expression)