Package com.intellij.psi.impl.source

Class PsiParameterImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.extapi.psi.ASTDelegatePsiElement

com.intellij.extapi.psi.StubBasedPsiElementBase<T>

com.intellij.psi.impl.source.JavaStubPsiElement<PsiParameterStub>

com.intellij.psi.impl.source.PsiParameterImpl

All Implemented Interfaces:

JvmAnnotatedElement, JvmElement, JvmModifiersOwner, JvmNamedElement, JvmParameter, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, NavigatablePsiElement, PsiElement, PsiJvmModifiersOwner, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiParameter, PsiTarget, PsiVariable, StubBasedPsiElement<PsiParameterStub>, java.lang.Cloneable

public class PsiParameterImpl
extends JavaStubPsiElement<PsiParameterStub>
implements PsiParameter

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

CREATION_TRACE, ourTraceStubAstBinding

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiParameter

ARRAY_FACTORY, EMPTY_ARRAY

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

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
	PsiParameterImpl(ASTNode node)
	PsiParameterImpl(PsiParameterStub stub)
protected	PsiParameterImpl(PsiParameterStub stub, IStubElementType type)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
protected java.lang.Object	clone()
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
PsiElement	getDeclarationScope() Returns the element (method, lambda expression, foreach statement or catch block) in which the parameter is declared.
javax.swing.Icon	getElementIcon(int flags)
PsiExpression	getInitializer() Returns the initializer for the variable.
static PsiType	getLambdaParameterType(PsiParameter param)
PsiModifierList	getModifierList() Returns the list of modifiers for the element.
java.lang.String	getName() Returns the name of the element.
PsiIdentifier	getNameIdentifier() Returns the identifier declaring the name of the variable.
CompositeElement	getNode() Ensures this element is AST-based.
PsiElement	getOriginalElement() Returns the PSI element which corresponds to this element and belongs to either the project source path or class path.
ItemPresentation	getPresentation()
PsiType	getType() Returns the type of the variable.
PsiTypeElement	getTypeElement() Returns the type element declaring the type of the variable.
SearchScope	getUseScope() Returns the scope in which references to this element are searched.
boolean	hasInitializer() Checks if the variable has an initializer.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
boolean	isVarArgs() Checks if the parameter accepts a variable number of arguments.
protected boolean	isVisibilitySupported()
void	normalizeDeclaration() Ensures that the variable declaration is not combined in the same statement with other declarations.
PsiElement	setName(java.lang.String name) Renames the element.
void	subtreeChanged()
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.JavaStubPsiElement

acceptChildren, add, addAfter, addBefore, calcTreeElement, checkAdd, cloneImpl, delete, deleteChildRange, getChildren, getLanguage, getTextOffset, replace

Methods inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

getContainingFile, getContext, getElementType, getGreenStub, getManager, getParent, getParentByStub, getParentByTree, getProject, getRequiredStubOrPsiChild, getStub, getStubOrPsiChild, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiParentOfType, isPhysical, isValid, isWritable, setNode, setSubstrateRef

Methods inherited from class com.intellij.extapi.psi.ASTDelegatePsiElement

addInternal, addRange, addRangeAfter, addRangeBefore, checkDelete, copy, deleteChildInternal, findChildByFilter, findChildByType, findChildByType, findChildrenByType, findChildrenByType, findChildrenByType, findChildrenByType, findElementAt, findLastChildByType, findNotNullChildByType, findNotNullChildByType, getCopyableUserData, getFirstChild, getLastChild, getNextSibling, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextRange, putCopyableUserData, replaceChildInternal, textContains, textMatches, textToCharArray

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

canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getNavigationElement, getReference, getReferences, getResolveScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textMatches

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, copyCopyableDataTo, copyUserDataTo, getUserData, getUserDataString, getUserMap, isUserDataEmpty, 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.PsiParameter

getAnnotations

Methods inherited from interface com.intellij.psi.PsiVariable

setInitializer

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.psi.PsiElement

acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, isEquivalentTo, isPhysical, isValid, 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.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.StubBasedPsiElement

getElementType, getStub

Constructor Detail

PsiParameterImpl

public PsiParameterImpl(PsiParameterStub stub)

PsiParameterImpl

protected PsiParameterImpl(PsiParameterStub stub,
                           IStubElementType type)

PsiParameterImpl

public PsiParameterImpl(ASTNode node)

Method Detail

getLambdaParameterType

public static PsiType getLambdaParameterType(PsiParameter param)

subtreeChanged

public void subtreeChanged()

Overrides:

subtreeChanged in class ASTDelegatePsiElement

clone

protected java.lang.Object clone()

Overrides:

clone in class JavaStubPsiElement<PsiParameterStub>

getName

public final 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 NavigationItem

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiNamedElement

Specified by:

getName in interface PsiParameter

Overrides:

getName in class PsiElementBase

Returns:

the element name.

setName

public final 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

Specified by:

setName in interface PsiVariable

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.

getNameIdentifier

public final PsiIdentifier getNameIdentifier()

Description copied from interface: PsiVariable

Returns the identifier declaring the name of the variable.

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

Specified by:

getNameIdentifier in interface PsiVariable

Returns:

the variable name identifier.

getNode

public CompositeElement getNode()

Description copied from class: StubBasedPsiElementBase

Ensures this element is AST-based. This is an expensive operation that might take significant time and allocate lots of objects, so it should be to be avoided if possible.

Specified by:

getNode in interface PsiElement

Overrides:

getNode in class StubBasedPsiElementBase<PsiParameterStub>

Returns:

an AST node corresponding to this element. If the element is currently operating via stubs, this causes AST to be loaded for the whole file and all stub-based PSI elements in this file (including the current one) to be switched from stub to AST. So, after this call StubBasedPsiElementBase.getStub() will return null.

getType

public PsiType getType()

Description copied from interface: PsiVariable

Returns the type of the variable.

Specified by:

getType in interface JvmParameter

Specified by:

getType in interface PsiParameter

Specified by:

getType in interface PsiVariable

Returns:

the variable type.

See Also:

Parameter.getParameterizedType(), Parameter.getAnnotatedType()

getTypeElement

public PsiTypeElement getTypeElement()

Description copied from interface: PsiParameter

Returns the type element declaring the type of the variable.

Specified by:

getTypeElement in interface PsiParameter

Specified by:

getTypeElement in interface PsiVariable

Returns:

the type element for the variable type.

getModifierList

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

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

getInitializer

public PsiExpression getInitializer()

Description copied from interface: PsiVariable

Returns the initializer for the variable.

Specified by:

getInitializer in interface PsiVariable

Returns:

the initializer expression, or null if it has no initializer.

See Also:

PsiVariable.hasInitializer()

hasInitializer

public boolean hasInitializer()

Description copied from interface: PsiVariable

Checks if the variable has an initializer.

Please note that even when PsiVariable.hasInitializer() returns true, PsiVariable.getInitializer() still can return null, e.g. for implicit initializer in case of enum constant declaration.

Specified by:

hasInitializer in interface PsiVariable

Returns:

true if the variable has an initializer, false otherwise.

computeConstantValue

public java.lang.Object computeConstantValue()

Description copied from interface: PsiVariable

Calculates and returns the constant value of the variable initializer.

Specified by:

computeConstantValue in interface PsiVariable

Returns:

the calculated value, or null if the variable has no initializer or the initializer does not evaluate to a constant.

normalizeDeclaration

public void normalizeDeclaration()
                          throws IncorrectOperationException

Description copied from interface: PsiVariable

Ensures that the variable declaration is not combined in the same statement with other declarations. Also, if the variable is an array, ensures that the array brackets are used in Java style (int[] a) and not in C style (int a[]).

Specified by:

normalizeDeclaration in interface PsiVariable

Throws:

IncorrectOperationException - if the modification fails for some reason.

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.

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

getDeclarationScope

public PsiElement getDeclarationScope()

Description copied from interface: PsiParameter

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

Specified by:

getDeclarationScope in interface PsiParameter

Returns:

the declaration scope for the parameter.

isVarArgs

public boolean isVarArgs()

Description copied from interface: PsiParameter

Checks if the parameter accepts a variable number of arguments.

Specified by:

isVarArgs in interface PsiParameter

Returns:

true if the parameter is a vararg, false otherwise

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

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

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)

getOriginalElement

public PsiElement getOriginalElement()

Description copied from interface: PsiElement

Returns the PSI element which corresponds to this element and belongs to either the project source path or class path. The method can either return this or substitute a different element if this element does not belong to the source path or class path. (For example, the original element for a library source file is the corresponding compiled class file.)

Specified by:

getOriginalElement in interface PsiElement

Overrides:

getOriginalElement in class PsiElementBase

Returns:

the original element.