Package com.intellij.psi.impl.light

Class LightVariableBase

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

All Implemented Interfaces:

NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, PomNamedTarget, PomRenameableTarget<PsiElement>, PomTarget, NavigatablePsiElement, OriginInfoAwareElement, PsiElement, PsiModifierListOwner, PsiNamedElement, PsiNameIdentifierOwner, PsiTarget, PsiVariable, java.lang.Cloneable

Direct Known Subclasses:

GrImplicitVariableImpl, ImplicitVariableImpl

public abstract class LightVariableBase
extends LightElement
implements PsiVariable, OriginInfoAwareElement

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
protected PsiModifierList	myModifierList
protected PsiIdentifier	myNameIdentifier
protected PsiElement	myScope
protected PsiType	myType
protected boolean	myWritable

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

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

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

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
LightVariableBase(PsiManager manager, PsiIdentifier nameIdentifier, Language language, PsiType type, boolean writable, PsiElement scope)
LightVariableBase(PsiManager manager, PsiIdentifier nameIdentifier, PsiType type, boolean writable, PsiElement scope)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
protected PsiType	computeType()
protected PsiModifierList	createModifierList()
PsiElement	getDeclarationScope()
javax.swing.Icon	getElementIcon(int flags)
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	getOriginInfo()
java.lang.String	getText() Returns the text of the PSI element.
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	isValid() Checks if this PSI element is valid.
protected boolean	isVisibilitySupported()
boolean	isWritable() Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)
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	setOriginInfo(java.lang.String originInfo)

Methods inherited from class com.intellij.psi.impl.light.LightElement

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

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, getUseScope, isEquivalentTo, 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.PsiVariable

setInitializer

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

getAnnotation, getAnnotations, hasAnnotation, hasModifier

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, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, 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.Navigatable

canNavigate, canNavigateToSource, navigate

Field Detail

myScope

protected PsiElement myScope

myNameIdentifier

protected PsiIdentifier myNameIdentifier

myType

protected PsiType myType

myModifierList

protected final PsiModifierList myModifierList

myWritable

protected boolean myWritable

Constructor Detail

LightVariableBase

public LightVariableBase(PsiManager manager,
                         PsiIdentifier nameIdentifier,
                         PsiType type,
                         boolean writable,
                         PsiElement scope)

LightVariableBase

public LightVariableBase(PsiManager manager,
                         PsiIdentifier nameIdentifier,
                         Language language,
                         PsiType type,
                         boolean writable,
                         PsiElement scope)

Method Detail

createModifierList

protected PsiModifierList createModifierList()

getDeclarationScope

public PsiElement getDeclarationScope()

getNameIdentifier

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

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)

getName

public java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PomNamedTarget

Specified by:

getName in interface PsiNamedElement

Overrides:

getName in class PsiElementBase

Returns:

the element name.

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.

getType

public PsiType getType()

Description copied from interface: PsiVariable

Returns the type of the variable.

Specified by:

getType in interface PsiVariable

Returns:

the variable type.

computeType

protected PsiType computeType()

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.

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)

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.

isWritable

public boolean isWritable()

Description copied from interface: PsiElement

Checks if the contents of the element can be modified (if it belongs to a non-read-only source file.)

Specified by:

isWritable in interface PomRenameableTarget<PsiElement>

Specified by:

isWritable in interface PsiElement

Overrides:

isWritable in class LightElement

Returns:

true if the element can be modified, false otherwise.

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

getElementIcon

public javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

getOriginInfo

public java.lang.String getOriginInfo()

Specified by:

getOriginInfo in interface OriginInfoAwareElement

setOriginInfo

public void setOriginInfo(java.lang.String originInfo)