Package com.intellij.psi.impl.source.tree.java

Class PsiAnnotationImpl

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.psi.impl.ElementBase

com.intellij.psi.impl.PsiElementBase

com.intellij.extapi.psi.ASTDelegatePsiElement

com.intellij.extapi.psi.StubBasedPsiElementBase<T>

com.intellij.psi.impl.source.JavaStubPsiElement<PsiAnnotationStub>

com.intellij.psi.impl.source.tree.java.PsiAnnotationImpl

All Implemented Interfaces:

JvmAnnotation, NavigationItem, Iconable, UserDataHolder, UserDataHolderEx, Navigatable, NavigatablePsiElement, PsiAnnotation, PsiAnnotationMemberValue, PsiElement, StubBasedPsiElement<PsiAnnotationStub>, java.lang.Cloneable

public class PsiAnnotationImpl
extends JavaStubPsiElement<PsiAnnotationStub>
implements PsiAnnotation

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.psi.PsiAnnotation

PsiAnnotation.TargetType

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

CREATION_TRACE, ourTraceStubAstBinding

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

FLAGS_LOCKED, ICON_PLACEHOLDER

Fields inherited from interface com.intellij.psi.PsiAnnotation

ARRAY_FACTORY, DEFAULT_REFERENCED_METHOD_NAME, EMPTY_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.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Constructor and Description
PsiAnnotationImpl(ASTNode node)
PsiAnnotationImpl(PsiAnnotationStub stub)

Method Summary

Modifier and Type	Method and Description
void	accept(PsiElementVisitor visitor) Passes the element to the specified visitor.
PsiAnnotationMemberValue	findAttributeValue(java.lang.String attributeName) Returns the value of the annotation element with the specified name.
PsiAnnotationMemberValue	findDeclaredAttributeValue(java.lang.String attributeName) Returns the value of the annotation element with the specified name.
static java.lang.String	getAnnotationShortName(java.lang.String annoText)
PsiJavaCodeReferenceElement	getNameReferenceElement() Returns the reference element representing the name of the annotation.
PsiAnnotationOwner	getOwner() Returns an owner of the annotation - usually a parent, but for type annotations the owner might be a type element.
PsiAnnotationParameterList	getParameterList() Returns the list of parameters for the annotation.
java.lang.String	getQualifiedName() Returns the fully qualified name of the annotation class.
boolean	hasQualifiedName(java.lang.String qualifiedName)
<T extends PsiAnnotationMemberValue> T	setDeclaredAttributeValue(java.lang.String attributeName, T value) Set annotation attribute value.
java.lang.String	toString() toString() should never be presented to the user.

Methods inherited from class com.intellij.psi.impl.source.JavaStubPsiElement

acceptChildren, add, addAfter, addBefore, calcTreeElement, checkAdd, clone, cloneImpl, delete, deleteChildRange, getChildren, getLanguage, getTextOffset, replace

Methods inherited from class com.intellij.extapi.psi.StubBasedPsiElementBase

getContainingFile, getContext, getElementType, getGreenStub, getManager, getNode, getParent, getParentByStub, getParentByTree, getProject, getRequiredStubOrPsiChild, getStub, getStubOrPsiChild, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiChildren, getStubOrPsiParentOfType, isPhysical, isValid, isWritable, setNode, setSubstrateRef

Methods inherited from class com.intellij.extapi.psi.ASTDelegatePsiElement

addInternal, addRange, addRangeAfter, addRangeBefore, checkDelete, copy, deleteChildInternal, findChildByFilter, findChildByType, findChildByType, findChildrenByType, findChildrenByType, findChildrenByType, findChildrenByType, findElementAt, findLastChildByType, findNotNullChildByType, findNotNullChildByType, getCopyableUserData, getFirstChild, getLastChild, getNextSibling, getPrevSibling, getStartOffsetInParent, getText, getTextLength, getTextRange, putCopyableUserData, replaceChildInternal, subtreeChanged, textContains, textMatches, textToCharArray

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

canNavigate, canNavigateToSource, findChildByClass, findChildrenByClass, findNotNullChildByClass, findReferenceAt, getName, getNavigationElement, getOriginalElement, getPresentation, getReference, getReferences, getResolveScope, getUseScope, isEquivalentTo, navigate, notNullChild, processDeclarations, textMatches

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, copyCopyableDataTo, copyUserDataTo, getUserData, getUserDataString, getUserMap, isUserDataEmpty, 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.PsiAnnotation

getAttributes, getMetaData

Methods inherited from interface com.intellij.psi.PsiElement

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.lang.jvm.JvmAnnotation

findAttribute, hasAttribute

Methods inherited from interface com.intellij.psi.StubBasedPsiElement

getElementType, getStub

Constructor Detail

PsiAnnotationImpl

public PsiAnnotationImpl(PsiAnnotationStub stub)

PsiAnnotationImpl

public PsiAnnotationImpl(ASTNode node)

Method Detail

getNameReferenceElement

public PsiJavaCodeReferenceElement getNameReferenceElement()

Description copied from interface: PsiAnnotation

Returns the reference element representing the name of the annotation.

Specified by:

getNameReferenceElement in interface PsiAnnotation

Returns:

the annotation name element.

findAttributeValue

public PsiAnnotationMemberValue findAttributeValue(java.lang.String attributeName)

Description copied from interface: PsiAnnotation

Returns the value of the annotation element with the specified name.

Specified by:

findAttributeValue in interface PsiAnnotation

Parameters:

attributeName - name of the annotation element for which the value is requested. If it isn't defined in annotation, the default value is returned.

Returns:

the element value, or null if the annotation does not contain a value for the element and the element has no default value.

findDeclaredAttributeValue

public PsiAnnotationMemberValue findDeclaredAttributeValue(java.lang.String attributeName)

Description copied from interface: PsiAnnotation

Returns the value of the annotation element with the specified name.

Specified by:

findDeclaredAttributeValue in interface PsiAnnotation

Parameters:

attributeName - name of the annotation element for which the value is requested, declared in this annotation.

Returns:

the element value, or null if the annotation does not contain a value for the element.

setDeclaredAttributeValue

public <T extends PsiAnnotationMemberValue> T setDeclaredAttributeValue(java.lang.String attributeName,
                                                                        T value)

Description copied from interface: PsiAnnotation

Set annotation attribute value. Adds new name-value pair or uses an existing one, expands unnamed 'value' attribute name if needed.

Specified by:

setDeclaredAttributeValue in interface PsiAnnotation

Parameters:

attributeName - attribute name

value - new value template element

Returns:

new declared attribute value

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

getParameterList

public PsiAnnotationParameterList getParameterList()

Description copied from interface: PsiAnnotation

Returns the list of parameters for the annotation.

Specified by:

getParameterList in interface PsiAnnotation

Returns:

the parameter list instance.

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: PsiAnnotation

Returns the fully qualified name of the annotation class.

Specified by:

getQualifiedName in interface JvmAnnotation

Specified by:

getQualifiedName in interface PsiAnnotation

Returns:

the class name, or null if the annotation is unresolved.

hasQualifiedName

public boolean hasQualifiedName(java.lang.String qualifiedName)

Specified by:

hasQualifiedName in interface PsiAnnotation

Returns:

whether the annotation has the given qualified name. Specific languages may provide efficient implementation that doesn't always create/resolve annotation reference.

accept

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

getOwner

public PsiAnnotationOwner getOwner()

Description copied from interface: PsiAnnotation

Returns an owner of the annotation - usually a parent, but for type annotations the owner might be a type element.

Specified by:

getOwner in interface PsiAnnotation

Returns:

annotation owner

getAnnotationShortName

public static java.lang.String getAnnotationShortName(java.lang.String annoText)