Package com.intellij.psi

Interface PsiAnnotationOwner

All Known Subinterfaces:

GrArrayTypeElement, GrBuiltInTypeElement, GrClassTypeElement, GrCodeReferenceElement, GrDisjunctionTypeElement, GrModifierList, GrTypeAnnotationOwner, GrTypeElement, GrTypeParameter, GrWildcardTypeArgument, PsiModifierList, PsiTypeElement, PsiTypeParameter

All Known Implementing Classes:

Bottom, ClsModifierListImpl, ClsTypeElementImpl, ClsTypeParameterImpl, GrArrayTypeElementImpl, GrBuiltInTypeElementImpl, GrClassReferenceType, GrClassTypeElementImpl, GrClosureType, GrCodeReferenceElementImpl, GrDisjunctionTypeElementImpl, GrImmediateTupleType, GrLightClassReferenceElement, GrLightModifierList, GrLightTypeElement, GrLiteralClassType, GrMapType, GrMapTypeFromNamedArgs, GrMapTypeImpl, GrModifierListImpl, GrPsiTypeStub, GrRangeType, GrSyntheticTypeElement, GrTraitType, GrTupleType, GrTypeParameterImpl, GrWildcardTypeArgumentImpl, InferenceVariable, LazyFqnClassType, LightModifierList, LightTypeElement, LightTypeParameter, LightTypeParameterBuilder, PsiArrayType, PsiCapturedWildcardType, PsiClassReferenceType, PsiClassType, PsiClassType.Stub, PsiCompositeModifierList, PsiDiamondType, PsiDiamondTypeElementImpl, PsiDiamondTypeImpl, PsiDisjunctionType, PsiEllipsisType, PsiImmediateClassType, PsiIntersectionType, PsiLambdaExpressionType, PsiLambdaParameterType, PsiMethodReferenceType, PsiModifierListImpl, PsiPrimitiveType, PsiType, PsiType.Stub, PsiTypeElementImpl, PsiTypeParameterImpl, PsiTypeVariable, PsiWildcardType

public interface PsiAnnotationOwner

Method Summary

Modifier and Type	Method and Description
PsiAnnotation	addAnnotation(java.lang.String qualifiedName) Adds a new annotation to this owner.
PsiAnnotation	findAnnotation(java.lang.String qualifiedName) Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.
PsiAnnotation []	getAnnotations() Returns the list of annotations syntactically contained in the element.
PsiAnnotation []	getApplicableAnnotations()
default boolean	hasAnnotation(java.lang.String qualifiedName) Searches the owner for an annotation with the specified fully qualified name and returns true if it is found.

Method Detail

getAnnotations

PsiAnnotation [] getAnnotations()

Returns the list of annotations syntactically contained in the element.

Returns:

the list of annotations.

getApplicableAnnotations

PsiAnnotation [] getApplicableAnnotations()

Returns:

the list of annotations which are applicable to this owner (e.g. type annotations on method belong to its type element, not the method).

findAnnotation

PsiAnnotation findAnnotation(java.lang.String qualifiedName)

Searches the owner for an annotation with the specified fully qualified name and returns one if it is found.

Parameters:

qualifiedName - the fully qualified name of the annotation to find.

Returns:

the annotation instance, or null if no such annotation is found.

hasAnnotation

default boolean hasAnnotation(java.lang.String qualifiedName)

Searches the owner for an annotation with the specified fully qualified name and returns true if it is found.

This method is preferable over findAnnotation(java.lang.String) since implementations are free not to instantiate the PsiAnnotation.

Parameters:

qualifiedName - the fully qualified name of the annotation to find

Returns:

true is such annotation is found, otherwise false

addAnnotation

PsiAnnotation addAnnotation(java.lang.String qualifiedName)

Adds a new annotation to this owner. The annotation class name will be shortened. No attributes will be defined.

Parameters:

qualifiedName - qualifiedName

Returns:

newly added annotation