Package com.intellij.psi.impl.compiled

Class ClsMethodImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.compiled.ClsElementImpl

com.intellij.psi.impl.compiled.ClsRepositoryPsiElement<T>

com.intellij.psi.impl.compiled.ClsMemberImpl<PsiMethodStub>

com.intellij.psi.impl.compiled.ClsMethodImpl

All Implemented Interfaces:

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

public class ClsMethodImpl
extends ClsMemberImpl<PsiMethodStub>
implements PsiAnnotationMethod

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.psi.impl.compiled.ClsElementImpl

ClsElementImpl.InvalidMirrorException

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.psi.impl.compiled.ClsElementImpl

COMPILED_ELEMENT, NEXT_LINE

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiAnnotationMethod

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.PsiMethod

ARRAY_FACTORY

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
ClsMethodImpl(PsiMethodStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
void	appendMirrorText(int indentLevel, java.lang.StringBuilder buffer)
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.
PsiElement []	getChildren() Returns the array of children for the PSI element.
PsiClass	getContainingClass() Returns the class containing the member.
PsiAnnotationMemberValue	getDefaultValue() Returns the default value of the annotation element defined by the method.
javax.swing.Icon	getElementIcon(int flags)
HierarchicalMethodSignature	getHierarchicalMethodSignature()
PsiModifierList	getModifierList() Returns the list of modifiers for the element.
PsiElement	getNavigationElement() Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested.
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.
PsiMethod	getSourceMirrorMethod()
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	isVarArgs() Checks if the method accepts a variable number of arguments.
protected boolean	isVisibilitySupported()
boolean	processDeclarations(PsiScopeProcessor processor, ResolveState state, PsiElement lastParent, PsiElement place) Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.
void	setMirror(TreeElement element)
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.compiled.ClsMemberImpl

getDocComment, getName, getNameIdentifier, setName

Methods inherited from class com.intellij.psi.impl.compiled.ClsRepositoryPsiElement

getContainingFile, getElementType, getFirstChild, getLastChild, getManager, getNextSibling, getParent, getPrevSibling, getStub, isPhysical

Methods inherited from class com.intellij.psi.impl.compiled.ClsElementImpl

add, addAfter, addBefore, appendText, appendText, checkAdd, checkDelete, copy, delete, findElementAt, findReferenceAt, getChildren, getIndentSize, getLanguage, getMirror, getNode, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isValid, isWritable, replace, setMirror, setMirrorCheckingType, setMirrorIfPresent, setMirrors, setMirrors, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, getContext, getOriginalElement, getProject, getReference, getReferences, getResolveScope, navigate, notNullChild, 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

getName, getNameIdentifier, getParameters, getThrowsTypes, hasParameters, setName

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement

getDocComment

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, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, isPhysical, isValid, isWritable, 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.pom.PomTarget

isValid

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

accept

Constructor Detail

ClsMethodImpl

public ClsMethodImpl(PsiMethodStub stub)

Method Detail

getChildren

public PsiElement [] getChildren()

Description copied from interface: PsiElement

Returns the array of children for the PSI element. Important: In some implementations children are only composite elements, i.e. not a leaf elements

Specified by:

getChildren in interface PsiElement

Overrides:

getChildren in class ClsRepositoryPsiElement<PsiMethodStub>

Returns:

the array of child elements.

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()

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

getHierarchicalMethodSignature

public HierarchicalMethodSignature getHierarchicalMethodSignature()

Specified by:

getHierarchicalMethodSignature in interface PsiMethod

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.

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()

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.

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

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.

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.

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.

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

getDefaultValue

public PsiAnnotationMemberValue getDefaultValue()

Description copied from interface: PsiAnnotationMethod

Returns the default value of the annotation element defined by the method.

Specified by:

getDefaultValue in interface PsiAnnotationMethod

Returns:

the default value of the element, or null if no default value is specified.

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.

appendMirrorText

public void appendMirrorText(int indentLevel,
                             java.lang.StringBuilder buffer)

Specified by:

appendMirrorText in class ClsElementImpl

setMirror

public void setMirror(TreeElement element)
               throws ClsElementImpl.InvalidMirrorException

Specified by:

setMirror in class ClsElementImpl

Throws:

ClsElementImpl.InvalidMirrorException

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 PsiElementBase

Parameters:

visitor - the visitor to pass the element to.

processDeclarations

public boolean processDeclarations(PsiScopeProcessor processor,
                                   ResolveState state,
                                   PsiElement lastParent,
                                   PsiElement place)

Description copied from interface: PsiElement

Passes the declarations contained in this PSI element and its children for processing to the specified scope processor.

Specified by:

processDeclarations in interface PsiElement

Overrides:

processDeclarations in class PsiElementBase

Parameters:

processor - the processor receiving the declarations.

lastParent - the child of this element has been processed during the previous step of the tree up walk (declarations under this element do not need to be processed again)

place - the original element from which the tree up walk was initiated.

Returns:

true if the declaration processing should continue or false if it should be stopped.

getSourceMirrorMethod

public PsiMethod getSourceMirrorMethod()

getNavigationElement

public PsiElement getNavigationElement()

Description copied from interface: PsiElement

Returns the PSI element which should be used as a navigation target when navigation to this PSI element is requested. The method can either return this or substitute a different element if this element does not have an associated file and offset. (For example, if the source code of a library is attached to a project, the navigation element for a compiled library class is its source class.)

Specified by:

getNavigationElement in interface PsiElement

Specified by:

getNavigationElement in interface PsiTarget

Overrides:

getNavigationElement in class PsiElementBase

Returns:

the navigation target element.

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()

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

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)

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

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

Overrides:

toString in class java.lang.Object