Package com.intellij.psi.impl.compiled

Class ClsFieldImpl

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

com.intellij.psi.impl.compiled.ClsFieldImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ClsEnumConstantImpl

public class ClsFieldImpl
extends ClsMemberImpl<PsiFieldStub>
implements PsiField, PsiVariableEx, ClsModifierListOwner

Nested Class Summary

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

ClsElementImpl.InvalidMirrorException

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

ARRAY_FACTORY, EMPTY_ARRAY

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

Constructor and Description
ClsFieldImpl(PsiFieldStub 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)
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
java.lang.Object	computeConstantValue(java.util.Set<PsiVariable> visitedVars)
PsiElement []	getChildren() Returns the array of children for the PSI element.
PsiClass	getContainingClass() Returns the class containing the member.
javax.swing.Icon	getElementIcon(int flags)
PsiExpression	getInitializer() Returns the initializer for the variable.
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.
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	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.
void	setInitializer(PsiExpression initializer) Adds initializer to the field declaration or, if initializer parameter is null, removes the initializer from the field declaration.
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, processDeclarations, 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.PsiField

getName, getNameIdentifier

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement

getDocComment

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

accept

Methods inherited from interface com.intellij.psi.PsiVariable

setName

Methods inherited from interface com.intellij.psi.PsiNameIdentifierOwner

getIdentifyingElement

Methods inherited from interface com.intellij.pom.PomRenameableTarget

isWritable

Constructor Detail

ClsFieldImpl

public ClsFieldImpl(PsiFieldStub 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<PsiFieldStub>

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

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.

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.

computeConstantValue

public java.lang.Object computeConstantValue(java.util.Set<PsiVariable> visitedVars)

Specified by:

computeConstantValue in interface PsiVariableEx

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

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.

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.

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.

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.

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