Package com.intellij.psi.impl.light

Class LightVariableBuilder<T extends LightVariableBuilder>

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

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:

GrLightParameter, LightFieldBuilder, LightParameter

public class LightVariableBuilder<T extends LightVariableBuilder>
extends LightElement
implements PsiVariable, NavigationItem, OriginInfoAwareElement

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

EMPTY_NAVIGATION_ITEM_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Constructor Summary

Constructors

Constructor and Description
LightVariableBuilder(PsiManager manager, java.lang.String name, PsiType type, Language language)
LightVariableBuilder(java.lang.String name, PsiType type, PsiElement navigationElement)
LightVariableBuilder(java.lang.String name, java.lang.String type, PsiElement navigationElement)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	computeConstantValue() Calculates and returns the constant value of the variable initializer.
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()
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.
protected boolean	isVisibilitySupported()
void	normalizeDeclaration() Ensures that the variable declaration is not combined in the same statement with other declarations.
T	setBaseIcon(javax.swing.Icon baseIcon)
T	setModifierList(LightModifierList modifierList)
T	setModifiers(java.lang.String... modifiers)
PsiElement	setName(java.lang.String name) Renames the element.
void	setOriginInfo(java.lang.String originInfo)
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, copy, delete, findElementAt, getChildren, getContainingFile, getLanguage, getManager, getNavigationElement, getNextSibling, getNode, getParent, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, isPhysical, isValid, 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, 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, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, 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.navigation.NavigationItem

getPresentation

Constructor Detail

LightVariableBuilder

public LightVariableBuilder(java.lang.String name,
                            java.lang.String type,
                            PsiElement navigationElement)

LightVariableBuilder

public LightVariableBuilder(java.lang.String name,
                            PsiType type,
                            PsiElement navigationElement)

LightVariableBuilder

public LightVariableBuilder(PsiManager manager,
                            java.lang.String name,
                            PsiType type,
                            Language language)

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

Specified by:

toString in class LightElement

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.

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.

setModifiers

public T setModifiers(java.lang.String... modifiers)

setModifierList

public T setModifierList(LightModifierList modifierList)

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

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.

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.

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.

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.

isVisibilitySupported

protected boolean isVisibilitySupported()

Overrides:

isVisibilitySupported in class ElementBase

getElementIcon

public javax.swing.Icon getElementIcon(int flags)

Overrides:

getElementIcon in class ElementBase

setBaseIcon

public T setBaseIcon(javax.swing.Icon baseIcon)

getOriginInfo

public java.lang.String getOriginInfo()

Specified by:

getOriginInfo in interface OriginInfoAwareElement

setOriginInfo

public void setOriginInfo(java.lang.String originInfo)