Package com.intellij.psi

Interface PsiAnnotation

All Superinterfaces:

Iconable, JvmAnnotation, PsiAnnotationMemberValue, PsiElement, UserDataHolder

All Known Subinterfaces:

GrAnnotation

All Known Implementing Classes:

ClsAnnotationImpl, GrAnnotationImpl, GrLightAnnotation, PsiAnnotationImpl

public interface PsiAnnotation
extends PsiAnnotationMemberValue, JvmAnnotation

Represents a Java annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PsiAnnotation.TargetType Kinds of element to which an annotation type is applicable (see ElementType).

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static ArrayFactory<PsiAnnotation>	ARRAY_FACTORY
static java.lang.String	DEFAULT_REFERENCED_METHOD_NAME
static PsiAnnotation[]	EMPTY_ARRAY The empty array of PSI annotations which can be reused to avoid unnecessary allocations.

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

Modifier and Type	Method and Description
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.
default java.util.List<JvmAnnotationAttribute>	getAttributes()
default PsiMetaData	getMetaData() Deprecated. don't use or override; it's temporarily left for compatibility with older plugins
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.
default boolean	hasQualifiedName(java.lang.String qualifiedName)
<T extends PsiAnnotationMemberValue> T	setDeclaredAttributeValue(java.lang.String attributeName, T value) Set annotation attribute value.

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

findAttribute, hasAttribute

Field Detail

EMPTY_ARRAY

static final PsiAnnotation[] EMPTY_ARRAY

The empty array of PSI annotations which can be reused to avoid unnecessary allocations.

ARRAY_FACTORY

static final ArrayFactory<PsiAnnotation> ARRAY_FACTORY

DEFAULT_REFERENCED_METHOD_NAME

static final java.lang.String DEFAULT_REFERENCED_METHOD_NAME

See Also:

Constant Field Values

Method Detail

getParameterList

PsiAnnotationParameterList getParameterList()

Returns the list of parameters for the annotation.

Returns:

the parameter list instance.

getQualifiedName

java.lang.String getQualifiedName()

Returns the fully qualified name of the annotation class.

Specified by:

getQualifiedName in interface JvmAnnotation

Returns:

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

getNameReferenceElement

PsiJavaCodeReferenceElement getNameReferenceElement()

Returns the reference element representing the name of the annotation.

Returns:

the annotation name element.

findAttributeValue

PsiAnnotationMemberValue findAttributeValue(java.lang.String attributeName)

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

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

PsiAnnotationMemberValue findDeclaredAttributeValue(java.lang.String attributeName)

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

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

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

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

Parameters:

attributeName - attribute name

value - new value template element

Returns:

new declared attribute value

getOwner

PsiAnnotationOwner getOwner()

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

Returns:

annotation owner

getAttributes

default java.util.List<JvmAnnotationAttribute> getAttributes()

Specified by:

getAttributes in interface JvmAnnotation

hasQualifiedName

default boolean hasQualifiedName(java.lang.String qualifiedName)

Returns:

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

getMetaData

@Deprecated
default PsiMetaData getMetaData()

Deprecated. don't use or override; it's temporarily left for compatibility with older plugins