Package com.intellij.psi.impl.light

Class LightFieldBuilder

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

com.intellij.psi.impl.light.LightFieldBuilder

All Implemented Interfaces:

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

Direct Known Subclasses:

GrPropertyForCompletion

public class LightFieldBuilder
extends LightVariableBuilder<LightFieldBuilder>
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
LightFieldBuilder(PsiManager manager, java.lang.String name, PsiType type)
LightFieldBuilder(java.lang.String name, PsiType type, PsiElement navigationElement)
LightFieldBuilder(java.lang.String name, java.lang.String type, PsiElement navigationElement)

Method Summary

Modifier and Type	Method and Description
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.
PsiElement	getParent() Returns the parent of the PSI element.
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.
LightFieldBuilder	setContainingClass(PsiClass psiClass)
LightFieldBuilder	setDocComment(PsiDocComment docComment)
void	setInitializer(PsiExpression initializer) Adds initializer to the field declaration or, if initializer parameter is null, removes the initializer from the field declaration.
LightFieldBuilder	setIsDeprecated(boolean isDeprecated)

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

computeConstantValue, getElementIcon, getModifierList, getName, getNameIdentifier, getOriginInfo, getType, getTypeElement, hasInitializer, hasModifierProperty, isVisibilitySupported, normalizeDeclaration, setBaseIcon, setModifierList, setModifiers, setName, setOriginInfo, toString

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, 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, 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, getType

Methods inherited from interface com.intellij.psi.PsiJvmModifiersOwner

getAnnotation, getAnnotations, getSourceElement, hasAnnotation, hasModifier

Methods inherited from interface com.intellij.psi.PsiVariable

computeConstantValue, getTypeElement, hasInitializer, normalizeDeclaration, setName

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

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, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isPhysical, isValid, isWritable, 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.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

LightFieldBuilder

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

LightFieldBuilder

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

LightFieldBuilder

public LightFieldBuilder(PsiManager manager,
                         java.lang.String name,
                         PsiType type)

Method Detail

setContainingClass

public LightFieldBuilder setContainingClass(PsiClass psiClass)

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.

getInitializer

public PsiExpression getInitializer()

Description copied from interface: PsiVariable

Returns the initializer for the variable.

Specified by:

getInitializer in interface PsiVariable

Overrides:

getInitializer in class LightVariableBuilder<LightFieldBuilder>

Returns:

the initializer expression, or null if it has no initializer.

See Also:

PsiVariable.hasInitializer()

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

setDocComment

public LightFieldBuilder setDocComment(PsiDocComment docComment)

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

setIsDeprecated

public LightFieldBuilder setIsDeprecated(boolean isDeprecated)

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

getParent

public PsiElement getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Overrides:

getParent in class LightElement

Returns:

the parent of the element, or null if the element has no parent.

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