Package com.intellij.psi

Interface PsiParameter

All Superinterfaces:

Iconable, JvmAnnotatedElement, JvmElement, JvmModifiersOwner, JvmNamedElement, JvmParameter, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, PsiElement, PsiJvmModifiersOwner, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiTarget, PsiVariable, UserDataHolder

All Known Subinterfaces:

GrParameter, PsiPatternVariable

All Known Implementing Classes:

ClosureSyntheticParameter, ClsParameterImpl, GrLightParameter, GrParameterImpl, LightCompactConstructorParameter, LightParameter, LightParameterWrapper, PsiParameterImpl, PsiPatternVariableImpl

public interface PsiParameter
extends PsiVariable, JvmParameter, PsiJvmModifiersOwner

Represents the parameter of a Java method, foreach (enhanced for) statement or catch block.

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

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
default PsiAnnotation []	getAnnotations()
PsiElement	getDeclarationScope() Returns the element (method, lambda expression, foreach statement or catch block) in which the parameter is declared.
java.lang.String	getName() Returns the name of the element.
PsiType	getType() Returns the type of the variable.
PsiTypeElement	getTypeElement() Returns the type element declaring the type of the variable.
boolean	isVarArgs() Checks if the parameter accepts a variable number of arguments.

Methods inherited from interface com.intellij.psi.PsiVariable

computeConstantValue, getInitializer, getNameIdentifier, hasInitializer, normalizeDeclaration, setInitializer, setName

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

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

getNavigationElement

Methods inherited from interface com.intellij.pom.PomRenameableTarget

isWritable

Methods inherited from interface com.intellij.pom.PomTarget

isValid

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

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

accept

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

getModifierList, hasModifierProperty

Field Detail

EMPTY_ARRAY

static final PsiParameter[] EMPTY_ARRAY

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

ARRAY_FACTORY

static final ArrayFactory<PsiParameter> ARRAY_FACTORY

Method Detail

getDeclarationScope

PsiElement getDeclarationScope()

Returns the element (method, lambda expression, foreach statement or catch block) in which the parameter is declared.

Returns:

the declaration scope for the parameter.

isVarArgs

boolean isVarArgs()

Checks if the parameter accepts a variable number of arguments.

Returns:

true if the parameter is a vararg, false otherwise

getTypeElement

PsiTypeElement getTypeElement()

Returns the type element declaring the type of the variable.

Specified by:

getTypeElement in interface PsiVariable

Returns:

the type element for the variable type.

getType

PsiType getType()

Description copied from interface: PsiVariable

Returns the type of the variable.

Specified by:

getType in interface JvmParameter

Specified by:

getType in interface PsiVariable

Returns:

the variable type.

See Also:

Parameter.getParameterizedType(), Parameter.getAnnotatedType()

getAnnotations

default PsiAnnotation [] getAnnotations()

Specified by:

getAnnotations in interface JvmAnnotatedElement

Specified by:

getAnnotations in interface PsiJvmModifiersOwner

Specified by:

getAnnotations in interface PsiModifierListOwner

getName

java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface JvmNamedElement

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiNamedElement

Returns:

the element name.