Package com.intellij.psi

Interface PsiMethod

All Superinterfaces:

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

All Known Subinterfaces:

GrAccessorMethod, GrAnnotationMethod, GrGdkMethod, GrMethod, GrReflectedMethod, JspHolderMethod, PsiAnnotationMethod, PsiJShellHolderMethod

All Known Implementing Classes:

ClsMethodImpl, DelegatedMethod, GrAccessorMethodImpl, GrAnnotationMethodImpl, GrConstructorImpl, GrDynamicImplicitMethod, GrDynamicMethodImpl, GrGdkMethodImpl, GrLightMethodBuilder, GrMethodBaseImpl, GrMethodImpl, GrMethodWrapper, GrReflectedMethodImpl, GrRenamableLightMethodBuilder, GrTraitMethod, LightMethod, LightMethodBuilder, LightRecordCanonicalConstructor, LightRecordMethod, PsiAnnotationMethodImpl, PsiJShellHolderMethodImpl, PsiMethodImpl

public interface PsiMethod
extends PsiMember, PsiNameIdentifierOwner, PsiModifierListOwner, PsiDocCommentOwner, PsiTypeParameterListOwner, PomRenameableTarget<PsiElement>, PsiTarget, PsiParameterListOwner, JvmMethod

Represents a Java method or constructor.

See Also:

PsiClass.getMethods()

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
static ArrayFactory<PsiMethod>	ARRAY_FACTORY
static PsiMethod[]	EMPTY_ARRAY The empty array of PSI methods which can be reused to avoid unnecessary allocations.

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

Method Summary

Modifier and Type	Method and Description
PsiMethod	findDeepestSuperMethod() Deprecated. use findDeepestSuperMethods() instead
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.
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.
default JvmParameter []	getParameters()
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.
PsiReferenceList	getThrowsList() Returns the list of thrown exceptions for the method.
default JvmReferenceType []	getThrowsTypes()
default boolean	hasParameters()
boolean	isConstructor() Checks if the method is a constructor.
boolean	isVarArgs() Checks if the method accepts a variable number of arguments.
PsiElement	setName(java.lang.String name) Renames the element.

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.psi.PsiDocCommentOwner

isDeprecated

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement

getDocComment

Methods inherited from interface com.intellij.psi.PsiTypeParameterListOwner

getTypeParameterList, getTypeParameters, hasTypeParameters

Methods inherited from interface com.intellij.psi.PsiJvmMember

getContainingClass

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

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

hasModifierProperty

Methods inherited from interface com.intellij.psi.PsiElement

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

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

getNavigationElement

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

accept

Field Detail

EMPTY_ARRAY

static final PsiMethod[] EMPTY_ARRAY

The empty array of PSI methods which can be reused to avoid unnecessary allocations.

ARRAY_FACTORY

static final ArrayFactory<PsiMethod> ARRAY_FACTORY

Method Detail

getReturnType

PsiType getReturnType()

Returns the return type of the method.

Specified by:

getReturnType in interface JvmMethod

Returns:

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

See Also:

Method.getGenericReturnType(), Method.getAnnotatedReturnType()

getReturnTypeElement

PsiTypeElement getReturnTypeElement()

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

Returns:

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

getParameterList

PsiParameterList getParameterList()

Returns the parameter list for the method.

Specified by:

getParameterList in interface PsiParameterListOwner

Returns:

the parameter list instance.

getThrowsList

PsiReferenceList getThrowsList()

Returns the list of thrown exceptions for the method.

Returns:

the list of thrown exceptions instance.

getBody

PsiCodeBlock getBody()

Returns the body of the method.

Specified by:

getBody in interface PsiParameterListOwner

Returns:

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

isConstructor

boolean isConstructor()

Checks if the method is a constructor.

Specified by:

isConstructor in interface JvmMethod

Returns:

true if the method is a constructor, false otherwise

isVarArgs

boolean isVarArgs()

Checks if the method accepts a variable number of arguments.

Specified by:

isVarArgs in interface JvmMethod

Returns:

true if the method is varargs, false otherwise.

See Also:

Executable.isVarArgs()

getSignature

MethodSignature getSignature(PsiSubstitutor substitutor)

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

Parameters:

substitutor - the substitutor.

Returns:

the method signature instance.

getNameIdentifier

PsiIdentifier getNameIdentifier()

Returns the name identifier for the method.

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

Returns:

the name identifier instance.

findSuperMethods

PsiMethod [] findSuperMethods()

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.

Returns:

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

findSuperMethods

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

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

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. Can return multiple results if the base class and/or one or more of the implemented interfaces have a method with the same signature.

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

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

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

@Deprecated
PsiMethod findDeepestSuperMethod()

Deprecated. use findDeepestSuperMethods() instead

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

Returns:

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

findDeepestSuperMethods

PsiMethod [] findDeepestSuperMethods()

getModifierList

PsiModifierList getModifierList()

Description copied from interface: PsiModifierListOwner

Returns the list of modifiers for the element.

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.

getName

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 PsiNamedElement

Returns:

the element name.

See Also:

Member.getName()

setName

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

getHierarchicalMethodSignature

HierarchicalMethodSignature getHierarchicalMethodSignature()

hasParameters

default boolean hasParameters()

Specified by:

hasParameters in interface JvmMethod

getParameters

default JvmParameter [] getParameters()

Specified by:

getParameters in interface JvmMethod

See Also:

Executable.getParameters()

getThrowsTypes

default JvmReferenceType [] getThrowsTypes()

Specified by:

getThrowsTypes in interface JvmMethod

See Also:

Method.getGenericExceptionTypes(), Executable.getAnnotatedExceptionTypes()