Package com.intellij.psi.impl.light

Class LightMethod

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightMethod

All Implemented Interfaces:

JvmAnnotatedElement, JvmElement, JvmMember, JvmMethod, JvmModifiersOwner, JvmNamedElement, JvmTypeParametersOwner, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, NavigatablePsiElement, PsiDocCommentOwner, PsiElement, PsiJavaDocumentedElement, PsiJvmMember, PsiJvmModifiersOwner, PsiMember, PsiMethod, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiParameterListOwner, PsiTarget, PsiTypeParameterListOwner, java.lang.Cloneable

Direct Known Subclasses:

DelegatedMethod, GrTraitMethod, LightRecordCanonicalConstructor, LightRecordMethod

public class LightMethod
extends LightElement
implements PsiMethod

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
protected PsiClass	myContainingClass
protected PsiMethod	myMethod
protected PsiSubstitutor	mySubstitutor

Fields inherited from class com.intellij.psi.impl.light.LightElement

myManager

Fields inherited from class com.intellij.psi.impl.ElementBase

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiMethod

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Constructor Summary

Constructors

Constructor and Description
LightMethod(PsiClass containingClass, PsiMethod method, PsiSubstitutor substitutor)
LightMethod(PsiManager manager, PsiMethod method, PsiClass containingClass)
LightMethod(PsiManager manager, PsiMethod method, PsiClass containingClass, Language language)
LightMethod(PsiManager manager, PsiMethod method, PsiClass containingClass, Language language, PsiSubstitutor substitutor)
LightMethod(PsiManager manager, PsiMethod method, PsiClass containingClass, PsiSubstitutor substitutor)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
PsiElement	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
PsiMethod	findDeepestSuperMethod() Returns the method in the deepest base superclass or interface of the containing class which this method overrides or implements.
PsiMethod []	findDeepestSuperMethods()
PsiMethod []	findSuperMethods() Searches the superclasses and base interfaces of the containing class to find the methods which this method overrides or implements.
PsiMethod []	findSuperMethods(boolean checkAccess) Searches the superclasses and base interfaces of the containing class to find the methods which this method overrides or implements, optionally omitting the accessibility check.
PsiMethod []	findSuperMethods(PsiClass parentClass) Searches the superclasses and base interfaces of the specified class to find the methods which this method can override or implement.
java.util.List<MethodSignatureBackedByPsiMethod>	findSuperMethodSignaturesIncludingStatic(boolean checkAccess) Searches the superclasses and base interfaces of the containing class to find static and instance methods with the signature matching the signature of this method.
PsiCodeBlock	getBody() Returns the body of the method.
PsiClass	getContainingClass() Returns the class containing the member.
PsiFile	getContainingFile() Returns the file containing the PSI element.
PsiElement	getContext() Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation.
PsiDocComment	getDocComment() Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.
javax.swing.Icon	getElementIcon(int flags)
HierarchicalMethodSignature	getHierarchicalMethodSignature()
PsiModifierList	getModifierList() Returns the list of modifiers for the element.
java.lang.String	getName() Returns the name of the element.
PsiIdentifier	getNameIdentifier() Returns the name identifier for the method.
PsiParameterList	getParameterList() Returns the parameter list for the method.
ItemPresentation	getPresentation()
PsiType	getReturnType() Returns the return type of the method.
PsiTypeElement	getReturnTypeElement() Returns the type element for the return type of the method.
MethodSignature	getSignature(PsiSubstitutor substitutor) Returns the signature of this method, using the specified substitutor to specify values of generic type parameters.
java.lang.String	getText() Returns the text of the PSI element.
TextRange	getTextRange() Returns the text range in the document occupied by the PSI element.
PsiReferenceList	getThrowsList() Returns the list of thrown exceptions for the method.
PsiTypeParameterList	getTypeParameterList() Returns the type parameter list for the element.
PsiTypeParameter []	getTypeParameters() Returns the array of type parameters for the element.
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
boolean	hasTypeParameters() Checks if the element has any type parameters.
boolean	isConstructor() Checks if the method is a constructor.
boolean	isDeprecated() Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.
boolean	isEquivalentTo(PsiElement another) This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric.
boolean	isValid() Checks if this PSI element is valid.
boolean	isVarArgs() Checks if the method accepts a variable number of arguments.
protected boolean	isVisibilitySupported()
PsiElement	setName(java.lang.String name) Renames the element.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.light.LightElement

add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, getTextOffset, isPhysical, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

Methods inherited from class com.intellij.psi.impl.PsiElementBase

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getFirstChild, getLastChild, getOriginalElement, getProject, getReference, getReferences, getResolveScope, navigate, notNullChild, processDeclarations, textContains

Methods inherited from class com.intellij.psi.impl.ElementBase

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, overlayIcons, registerIconLayer, transformFlags

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.psi.PsiMethod

getParameters, getThrowsTypes, hasParameters

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getTextLength, getTextOffset, getTextRangeInParent, isPhysical, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray

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

getUserData, putUserData

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

getIcon

Methods inherited from interface com.intellij.pom.PomRenameableTarget

isWritable

Methods inherited from interface com.intellij.psi.PsiTarget

getNavigationElement

Methods inherited from interface com.intellij.lang.jvm.JvmMethod

accept

Field Detail

myMethod

protected final PsiMethod myMethod

myContainingClass

protected final PsiClass myContainingClass

mySubstitutor

protected final PsiSubstitutor mySubstitutor

Constructor Detail

LightMethod

public LightMethod(PsiClass containingClass,
                   PsiMethod method,
                   PsiSubstitutor substitutor)

LightMethod

public LightMethod(PsiManager manager,
                   PsiMethod method,
                   PsiClass containingClass)

LightMethod

public LightMethod(PsiManager manager,
                   PsiMethod method,
                   PsiClass containingClass,
                   PsiSubstitutor substitutor)

LightMethod

public LightMethod(PsiManager manager,
                   PsiMethod method,
                   PsiClass containingClass,
                   Language language)

LightMethod

public LightMethod(PsiManager manager,
                   PsiMethod method,
                   PsiClass containingClass,
                   Language language,
                   PsiSubstitutor substitutor)

Method Detail

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

hasTypeParameters

public boolean hasTypeParameters()

Description copied from interface: PsiTypeParameterListOwner

Checks if the element has any type parameters.

Specified by:

hasTypeParameters in interface PsiTypeParameterListOwner

Returns:

true if the element has type parameters, false otherwise

getTypeParameters

public PsiTypeParameter [] getTypeParameters()

Description copied from interface: PsiTypeParameterListOwner

Returns the array of type parameters for the element.

Specified by:

getTypeParameters in interface JvmTypeParametersOwner

Specified by:

getTypeParameters in interface PsiTypeParameterListOwner

Returns:

the array of type parameters, or an empty array if the element has no type parameters.

See Also:

GenericDeclaration.getTypeParameters()

getTypeParameterList

public PsiTypeParameterList getTypeParameterList()

Description copied from interface: PsiTypeParameterListOwner

Returns the type parameter list for the element.

Specified by:

getTypeParameterList in interface PsiTypeParameterListOwner

Returns:

the type parameter list, or null if the element has no type parameters.

getDocComment

public PsiDocComment getDocComment()

Description copied from interface: PsiJavaDocumentedElement

Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.

Specified by:

getDocComment in interface PsiJavaDocumentedElement

isDeprecated

public boolean isDeprecated()

Description copied from interface: PsiDocCommentOwner

Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.

Specified by:

isDeprecated in interface PsiDocCommentOwner

setName

public PsiElement setName(java.lang.String name)
                   throws IncorrectOperationException

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PomRenameableTarget<PsiElement>

Specified by:

setName in interface PsiMethod

Specified by:

setName in interface PsiNamedElement

Parameters:

name - the new element name.

Returns:

the element corresponding to this element after the rename (either this or a different element if the rename caused the element to be replaced).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface JvmMember

Specified by:

getName in interface JvmMethod

Specified by:

getName in interface JvmNamedElement

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiMethod

Specified by:

getName in interface PsiNamedElement

Overrides:

getName in class PsiElementBase

Returns:

the element name.

See Also:

Member.getName()

getHierarchicalMethodSignature

public HierarchicalMethodSignature getHierarchicalMethodSignature()

Specified by:

getHierarchicalMethodSignature in interface PsiMethod

hasModifierProperty

public boolean hasModifierProperty(java.lang.String name)

Description copied from interface: PsiModifierListOwner

Checks if the element has the specified modifier. Possible modifiers are defined as constants in the PsiModifier class.

Specified by:

hasModifierProperty in interface PsiModifierListOwner

Parameters:

name - the name of the modifier to check.

Returns:

true if the element has the modifier, false otherwise

getTextRange

public TextRange getTextRange()

Description copied from interface: PsiElement

Returns the text range in the document occupied by the PSI element.

Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getTextRange in interface PsiElement

Overrides:

getTextRange in class LightElement

Returns:

the text range.

getModifierList

public PsiModifierList getModifierList()

Description copied from interface: PsiModifierListOwner

Returns the list of modifiers for the element.

Specified by:

getModifierList in interface PsiMethod

Specified by:

getModifierList in interface PsiModifierListOwner

Returns:

the list of modifiers, or null if the element (for example, an anonymous inner class) does not have the list of modifiers.

getReturnType

public PsiType getReturnType()

Description copied from interface: PsiMethod

Returns the return type of the method.

Specified by:

getReturnType in interface JvmMethod

Specified by:

getReturnType in interface PsiMethod

Returns:

the method return type, or null if the method is a constructor.

See Also:

Method.getGenericReturnType(), Method.getAnnotatedReturnType()

getReturnTypeElement

public PsiTypeElement getReturnTypeElement()

Description copied from interface: PsiMethod

Returns the type element for the return type of the method.

Specified by:

getReturnTypeElement in interface PsiMethod

Returns:

the type element for the return type, or null if the method is a constructor.

getParameterList

public PsiParameterList getParameterList()

Description copied from interface: PsiMethod

Returns the parameter list for the method.

Specified by:

getParameterList in interface PsiMethod

Specified by:

getParameterList in interface PsiParameterListOwner

Returns:

the parameter list instance.

getThrowsList

public PsiReferenceList getThrowsList()

Description copied from interface: PsiMethod

Returns the list of thrown exceptions for the method.

Specified by:

getThrowsList in interface PsiMethod

Returns:

the list of thrown exceptions instance.

getBody

public PsiCodeBlock getBody()

Description copied from interface: PsiMethod

Returns the body of the method.

Specified by:

getBody in interface PsiMethod

Specified by:

getBody in interface PsiParameterListOwner

Returns:

the method body, or null if the method belongs to a compiled class.

isConstructor

public boolean isConstructor()

Description copied from interface: PsiMethod

Checks if the method is a constructor.

Specified by:

isConstructor in interface JvmMethod

Specified by:

isConstructor in interface PsiMethod

Returns:

true if the method is a constructor, false otherwise

isVarArgs

public boolean isVarArgs()

Description copied from interface: PsiMethod

Checks if the method accepts a variable number of arguments.

Specified by:

isVarArgs in interface JvmMethod

Specified by:

isVarArgs in interface PsiMethod

Returns:

true if the method is varargs, false otherwise.

See Also:

Executable.isVarArgs()

getSignature

public MethodSignature getSignature(PsiSubstitutor substitutor)

Description copied from interface: PsiMethod

Returns the signature of this method, using the specified substitutor to specify values of generic type parameters.

Specified by:

getSignature in interface PsiMethod

Parameters:

substitutor - the substitutor.

Returns:

the method signature instance.

getNameIdentifier

public PsiIdentifier getNameIdentifier()

Description copied from interface: PsiMethod

Returns the name identifier for the method.

Specified by:

getNameIdentifier in interface PsiMethod

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

Returns:

the name identifier instance.

findSuperMethods

public PsiMethod [] findSuperMethods()

Description copied from interface: PsiMethod

Searches the superclasses and base interfaces of the containing class to find the methods which this method overrides or implements. Can return multiple results if the base class and/or one or more of the implemented interfaces have a method with the same signature. If the overridden method in turn overrides another method, only the directly overridden method is returned.

Specified by:

findSuperMethods in interface PsiMethod

Returns:

the array of super methods, or an empty array if no methods are found.

findSuperMethods

public PsiMethod [] findSuperMethods(boolean checkAccess)

Description copied from interface: PsiMethod

Searches the superclasses and base interfaces of the containing class to find the methods which this method overrides or implements, optionally omitting the accessibility check. Can return multiple results if the base class and/or one or more of the implemented interfaces have a method with the same signature. If the overridden method in turn overrides another method, only the directly overridden method is returned.

Specified by:

findSuperMethods in interface PsiMethod

Parameters:

checkAccess - if false, the super methods are searched even if this method is private. If true, an empty result list is returned for private methods.

Returns:

the array of super methods, or an empty array if no methods are found.

findSuperMethods

public PsiMethod [] findSuperMethods(PsiClass parentClass)

Description copied from interface: PsiMethod

Searches the superclasses and base interfaces of the specified class to find the methods which this method can override or implement. Can return multiple results if the base class and/or one or more of the implemented interfaces have a method with the same signature.

Specified by:

findSuperMethods in interface PsiMethod

Parameters:

parentClass - the class to search for super methods.

Returns:

the array of super methods, or an empty array if no methods are found.

findSuperMethodSignaturesIncludingStatic

public java.util.List<MethodSignatureBackedByPsiMethod> findSuperMethodSignaturesIncludingStatic(boolean checkAccess)

Description copied from interface: PsiMethod

Searches the superclasses and base interfaces of the containing class to find static and instance methods with the signature matching the signature of this method. Can return multiple results if the base class and/or one or more of the implemented interfaces have a method with the same signature. If the overridden method in turn overrides another method, only the directly overridden method is returned.

Specified by:

findSuperMethodSignaturesIncludingStatic in interface PsiMethod

Parameters:

checkAccess - if false, the super methods are searched even if this method is private. If true, an empty result list is returned for private methods.

Returns:

the array of matching method signatures, or an empty array if no methods are found.

findDeepestSuperMethod

public PsiMethod findDeepestSuperMethod()

Description copied from interface: PsiMethod

Returns the method in the deepest base superclass or interface of the containing class which this method overrides or implements.

Specified by:

findDeepestSuperMethod in interface PsiMethod

Returns:

the overridden or implemented method, or null if this method does not override or implement any other method.

findDeepestSuperMethods

public PsiMethod [] findDeepestSuperMethods()

Specified by:

findDeepestSuperMethods in interface PsiMethod

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Overrides:

getText in class LightElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

accept

public void accept(PsiElementVisitor visitor)

Description copied from interface: PsiElement

Passes the element to the specified visitor.

Specified by:

accept in interface PsiElement

Overrides:

accept in class LightElement

Parameters:

visitor - the visitor to pass the element to.

copy

public PsiElement copy()

Description copied from interface: PsiElement

Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.

Specified by:

copy in interface PsiElement

Overrides:

copy in class LightElement

Returns:

the element in the file copy corresponding to this element.

isValid

public boolean isValid()

Description copied from interface: PsiElement

Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:

• They have been deleted via PSI operation (PsiElement.delete())
• They have been deleted as a result of an incremental reparse (document commit)
• Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch

Specified by:

isValid in interface PomTarget

Specified by:

isValid in interface PsiElement

Overrides:

isValid in class LightElement

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

getContainingClass

public PsiClass getContainingClass()

Description copied from interface: PsiMember

Returns the class containing the member.

Specified by:

getContainingClass in interface JvmMember

Specified by:

getContainingClass in interface PsiJvmMember

Specified by:

getContainingClass in interface PsiMember

Returns:

the containing class.

See Also:

Member.getDeclaringClass()

getContainingFile

public PsiFile getContainingFile()

Description copied from interface: PsiElement

Returns the file containing the PSI element.

Note: this method might need to traverse the whole AST up, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getContainingFile in interface PsiElement

Overrides:

getContainingFile in class LightElement

Returns:

the file instance, or null if the PSI element is not contained in a file (for example, the element represents a package or directory).

toString

public java.lang.String toString()

Description copied from interface: PsiElement

toString() should never be presented to the user.

Specified by:

toString in interface PsiElement

Specified by:

toString in class LightElement

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

getElementIcon

public javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

isEquivalentTo

public boolean isEquivalentTo(PsiElement another)

Description copied from interface: PsiElement

This method shouldn't be called by clients directly, because there are no guarantees of it being symmetric. It's called by PsiManager.areElementsEquivalent(PsiElement, PsiElement) internally, which clients should invoke instead.

Implementations of this method should return true if the parameter is resolve-equivalent to this, i.e. it represents the same entity from the language perspective. See also PsiManager.areElementsEquivalent(PsiElement, PsiElement) documentation.

Specified by:

isEquivalentTo in interface PsiElement

Overrides:

isEquivalentTo in class PsiElementBase

getUseScope

public SearchScope getUseScope()

Description copied from interface: PsiElement

Returns the scope in which references to this element are searched.

Specified by:

getUseScope in interface PsiElement

Overrides:

getUseScope in class PsiElementBase

Returns:

the search scope instance.

See Also:

PsiSearchHelper.getUseScope(PsiElement)

getContext

public PsiElement getContext()

Description copied from interface: PsiElement

Returns the element which should be used as the parent of this element in a tree up walk during a resolve operation. For most elements, this returns getParent(), but the context can be overridden for some elements like code fragments (see JavaCodeFragmentFactory.createCodeBlockCodeFragment(String, PsiElement, boolean)).

Specified by:

getContext in interface PsiElement

Overrides:

getContext in class PsiElementBase

Returns:

the resolve context element.