Package com.intellij.psi.impl.light

Class LightField

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.psi.impl.light.LightElement

com.intellij.psi.impl.light.LightField

All Implemented Interfaces:

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

Direct Known Subclasses:

LightRecordField

public class LightField
extends LightElement
implements PsiField

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.psi.impl.light.LightElement

myManager

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
LightField(PsiManager manager, PsiField field, PsiClass containingClass)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
PsiElement	copy() Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy.
PsiClass	getContainingClass() Returns the class containing the member.
PsiDocComment	getDocComment() Returns the JavaDoc comment for the element, or null when the element has no JavaDoc comment.
PsiExpression	getInitializer() Returns the initializer for the variable.
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.
java.lang.String	getText() Returns the text of the PSI element.
TextRange	getTextRange() Returns the text range in the document occupied by the PSI element.
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.
boolean	isValid() Checks if this PSI element is valid.
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.
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.light.LightElement

accept, add, addAfter, addBefore, checkAdd, checkDelete, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getTextLength, getTextOffset, isPhysical, isWritable, replace, setNavigationElement, textMatches, textMatches, textToCharArray

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

acceptChildren, addRange, addRangeAfter, addRangeBefore, canNavigate, canNavigateToSource, deleteChildRange, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getContext, getFirstChild, getLastChild, getOriginalElement, getPresentation, getProject, getReference, getReferences, getResolveScope, navigate, notNullChild, processDeclarations, textContains

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

buildRowIcon, computeBaseIcon, createLayeredIcon, getAdjustedBaseIcon, getBaseIcon, getElementIcon, getIcon, iconWithVisibilityIfNeeded, isNativeFileType, isVisibilitySupported, 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.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.psi.PsiElement

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

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

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

accept

Constructor Detail

LightField

public LightField(PsiManager manager,
                  PsiField field,
                  PsiClass containingClass)

Method Detail

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.

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)

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

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

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.

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

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.

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.

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.

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

getText

public java.lang.String getText()

Description copied from interface: PsiElement

Returns the text of the PSI element.

Note: This call requires traversing whole subtree, so it can be expensive for composite elements, and should be avoided if possible.

Specified by:

getText in interface PsiElement

Overrides:

getText in class LightElement

Returns:

the element text.

See Also:

PsiElement.textMatches(java.lang.CharSequence), PsiElement.textContains(char)

copy

public PsiElement copy()

Description copied from interface: PsiElement

Creates a copy of the file containing the PSI element and returns the corresponding element in the created copy. Resolve operations performed on elements in the copy of the file will resolve to elements in the copy, not in the original file.

Specified by:

copy in interface PsiElement

Overrides:

copy in class LightElement

Returns:

the element in the file copy corresponding to this element.

getTextRange

public TextRange getTextRange()

Description copied from interface: PsiElement

Returns the text range in the document occupied by the PSI element.

Note: it works in O(tree_depth) time, which can be slow in deep trees, so invoking this method should be avoided if possible.

Specified by:

getTextRange in interface PsiElement

Overrides:

getTextRange in class LightElement

Returns:

the text range.

isValid

public boolean isValid()

Description copied from interface: PsiElement

Checks if this PSI element is valid. Valid elements and their hierarchy members can be accessed for reading and writing. Valid elements can still correspond to underlying documents whose text is different, when those documents have been changed and not yet committed (PsiDocumentManager.commitDocument(com.intellij.openapi.editor.Document)). (In this case an attempt to change PSI will result in an exception). Any access to invalid elements results in PsiInvalidElementAccessException. Once invalid, elements can't become valid again. Elements become invalid in following cases:

• They have been deleted via PSI operation (PsiElement.delete())
• They have been deleted as a result of an incremental reparse (document commit)
• Their containing file has been changed externally, or renamed so that its PSI had to be rebuilt from scratch

Specified by:

isValid in interface PomTarget

Specified by:

isValid in interface PsiElement

Overrides:

isValid in class LightElement

Returns:

true if the element is valid, false otherwise.

See Also:

PsiUtilCore.ensureValid(PsiElement)

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

Specified by:

toString in class LightElement