Package com.intellij.psi.impl.source

Class PsiEnumConstantImpl

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

com.intellij.psi.impl.source.PsiEnumConstantImpl

All Implemented Interfaces:

JvmAnnotatedElement, JvmElement, JvmEnumField, JvmField, JvmMember, JvmModifiersOwner, JvmNamedElement, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, NavigatablePsiElement, PsiCall, PsiConstructorCall, PsiDocCommentOwner, PsiElement, PsiEnumConstant, PsiField, PsiJavaDocumentedElement, PsiJvmMember, PsiJvmModifiersOwner, PsiMember, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiTarget, PsiVariable, StubBasedPsiElement<PsiFieldStub>, java.lang.Cloneable

public class PsiEnumConstantImpl
extends JavaStubPsiElement<PsiFieldStub>
implements PsiEnumConstant

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

ARRAY_FACTORY, EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_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.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiEnumConstantImpl(ASTNode node)
PsiEnumConstantImpl(PsiFieldStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
PsiExpressionList	getArgumentList() Returns the list of arguments passed to the constructor of the enum type to create the instance of the constant.
PsiClass	getContainingClass() Returns the class containing the member.
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)
PsiExpression	getInitializer() Returns the initializer for the variable.
PsiEnumConstantInitializer	getInitializingClass() Returns the class body attached to the enum constant declaration.
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.
PsiEnumConstantInitializer	getOrCreateInitializingClass()
ItemPresentation	getPresentation()
PsiReference	getReference() Returns the reference from this PSI element to another PSI element (or elements), if one exists.
PsiType	getType() Returns the type of the variable.
PsiTypeElement	getTypeElement() Returns the type element declaring the type of the variable.
boolean	hasInitializer() Checks if the variable has an initializer.
boolean	hasModifierProperty(java.lang.String name) Checks if the element has the specified modifier.
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.
protected boolean	isVisibilitySupported()
void	normalizeDeclaration() Ensures that the variable declaration is not combined in the same statement with other declarations.
PsiMethod	resolveConstructor() Resolves the reference to the called constructor and returns the constructor.
PsiMethod	resolveMethod() Resolves the reference to the called method and returns the method.
JavaResolveResult	resolveMethodGenerics() Resolves the reference to the called method and returns the resolve result containing the method and the substitutor for generic type parameters.
void	setInitializer(PsiExpression initializer) Adds initializer to the field declaration or, if initializer parameter is null, removes the initializer from the field declaration.
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.source.JavaStubPsiElement

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

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

getContainingFile, getElementType, getGreenStub, getManager, getNode, 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, subtreeChanged, textContains, textMatches, textToCharArray

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

canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getNavigationElement, getOriginalElement, getReferences, getResolveScope, getUseScope, 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.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

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

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

canNavigate, canNavigateToSource, navigate

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

accept

Methods inherited from interface com.intellij.psi.StubBasedPsiElement

getElementType, getStub

Constructor Detail

PsiEnumConstantImpl

public PsiEnumConstantImpl(PsiFieldStub stub)

PsiEnumConstantImpl

public PsiEnumConstantImpl(ASTNode node)

Method Detail

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

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.

getArgumentList

public PsiExpressionList getArgumentList()

Description copied from interface: PsiEnumConstant

Returns the list of arguments passed to the constructor of the enum type to create the instance of the constant.

Specified by:

getArgumentList in interface PsiCall

Specified by:

getArgumentList in interface PsiEnumConstant

Returns:

the list of arguments, or null

getInitializingClass

public PsiEnumConstantInitializer getInitializingClass()

Description copied from interface: PsiEnumConstant

Returns the class body attached to the enum constant declaration.

Specified by:

getInitializingClass in interface PsiEnumConstant

Returns:

the enum constant class body, or null if the enum constant does not have one.

getOrCreateInitializingClass

public PsiEnumConstantInitializer getOrCreateInitializingClass()

Specified by:

getOrCreateInitializingClass in interface PsiEnumConstant

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

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 StubBasedPsiElementBase<PsiFieldStub>

Returns:

the resolve context element.

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

getType

public PsiType getType()

Description copied from interface: PsiVariable

Returns the type of the variable.

Specified by:

getType in interface JvmField

Specified by:

getType in interface PsiField

Specified by:

getType in interface PsiVariable

Returns:

the variable type.

See Also:

Field.getGenericType(), Field.getAnnotatedType()

getTypeElement

public PsiTypeElement getTypeElement()

Description copied from interface: PsiVariable

Returns the type element declaring the type of the variable.

Specified by:

getTypeElement in interface PsiVariable

Returns:

the type element for the variable type.

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.

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.

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.

resolveMethod

public PsiMethod resolveMethod()

Description copied from interface: PsiCall

Resolves the reference to the called method and returns the method.

Specified by:

resolveMethod in interface PsiCall

Returns:

the called method, or null if the resolve failed.

resolveMethodGenerics

public JavaResolveResult resolveMethodGenerics()

Description copied from interface: PsiCall

Resolves the reference to the called method and returns the resolve result containing the method and the substitutor for generic type parameters.

Specified by:

resolveMethodGenerics in interface PsiCall

Returns:

the resolve result, or JavaResolveResult.EMPTY if unresolved

getNameIdentifier

public PsiIdentifier getNameIdentifier()

Description copied from interface: PsiVariable

Returns the identifier declaring the name of the variable.

Specified by:

getNameIdentifier in interface PsiField

Specified by:

getNameIdentifier in interface PsiNameIdentifierOwner

Specified by:

getNameIdentifier in interface PsiVariable

Returns:

the variable name identifier.

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface JvmField

Specified by:

getName in interface JvmMember

Specified by:

getName in interface JvmNamedElement

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiField

Specified by:

getName in interface PsiNamedElement

Overrides:

getName in class PsiElementBase

Returns:

the element name.

See Also:

Member.getName()

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

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

getReference

public PsiReference getReference()

Description copied from interface: PsiElement

Returns the reference from this PSI element to another PSI element (or elements), if one exists. If the element has multiple associated references (see PsiElement.getReferences() for an example), returns the first associated reference.

Specified by:

getReference in interface PsiElement

Overrides:

getReference in class PsiElementBase

Returns:

the reference instance, or null if the PSI element does not have any associated references.

See Also:

ReferencesSearch

resolveConstructor

public PsiMethod resolveConstructor()

Description copied from interface: PsiConstructorCall

Resolves the reference to the called constructor and returns the constructor. Equivalent to PsiCall.resolveMethod().

Specified by:

resolveConstructor in interface PsiConstructorCall

Returns:

the called constructor, or null if the resolve failed.

getElementIcon

public javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

getPresentation

public ItemPresentation getPresentation()

Specified by:

getPresentation in interface NavigationItem

Overrides:

getPresentation in class PsiElementBase

setInitializer

public void setInitializer(PsiExpression initializer)
                    throws IncorrectOperationException

Description copied from interface: PsiField

Adds initializer to the field declaration or, if initializer parameter is null, removes the initializer from the field declaration.

Specified by:

setInitializer in interface PsiField

Specified by:

setInitializer in interface PsiVariable

Parameters:

initializer - the initializer to add.

Throws:

IncorrectOperationException - if the modifications fails for some reason.

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