Package org.jboss.jandex

Interface AnnotationTarget

All Known Subinterfaces:
Declaration
All Known Implementing Classes:
ClassExtendsTypeTarget, ClassInfo, EmptyTypeTarget, FieldInfo, MethodInfo, MethodParameterInfo, MethodParameterTypeTarget, PositionBasedTypeTarget, RecordComponentInfo, ThrowsTypeTarget, TypeParameterBoundTypeTarget, TypeParameterTypeTarget, TypeTarget
public interface AnnotationTarget
Represents an object that can be a target of an annotation.

Overall, two distinct kinds of annotation targets exist: declarations and types. To refer to declarations only, the Declaration interface may be used.

Author:
Jason T. Greene
See Also:

  • Method Details

    • kind

      AnnotationTarget.Kind kind()
      Returns the kind of object this target represents.
      Returns:
      the target kind.
      Since:
      2.0

    • isDeclaration

      boolean isDeclaration()
      Returns whether this annotation target is a declaration.
      Returns:
      whether this annotation target is a declaration
      Since:
      3.1.0

    • asDeclaration

      Declaration asDeclaration()
      Casts and returns this annotation target as a Declaration if it is a declaration.
      Returns:
      this instance cast to a declaration
      Since:
      3.1.0

    • asClass

      ClassInfo asClass()
      Casts and returns this target as a ClassInfo if it is of kind CLASS
      Returns:
      this instance cast to a class
      Since:
      2.0

    • asField

      FieldInfo asField()
      Casts and returns this target as a FieldInfo if it is of kind FIELD
      Returns:
      this instance cast to a field
      Since:
      2.0

    • asMethod

      MethodInfo asMethod()
      Casts and returns this target as a MethodInfo if it is of kind METHOD
      Returns:
      this instance cast to a method
      Since:
      2.0

    • asMethodParameter

      MethodParameterInfo asMethodParameter()
      Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER
      Returns:
      this instance cast to a method parameter
      Since:
      2.0

    • asType

      TypeTarget asType()
      Casts and returns this target as a TypeTarget if it is of kind TYPE
      Returns:
      this instance cast to a type target
      Since:
      2.0

    • asRecordComponent

      RecordComponentInfo asRecordComponent()
      Casts and returns this target as a RecordComponentInfo if it is of kind RECORD_COMPONENT
      Returns:
      this instance cast to a record component
      Since:
      2.4

    • hasAnnotation

      boolean hasAnnotation(DotName name)
      Returns whether an annotation instance with given name is declared on this annotation target or any of its nested annotation targets.
      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • hasAnnotation

      default boolean hasAnnotation(String name)
      Returns whether an annotation instance with given name is declared on this annotation target or any of its nested annotation targets.
      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • hasAnnotation

      default boolean hasAnnotation(Class<? extends Annotation> clazz)
      Returns whether an annotation instance of given type is declared on this annotation target or any of its nested annotation targets.
      Parameters:
      clazz - the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • annotation

      AnnotationInstance annotation(DotName name)
      Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets. The target() method of the returned annotation instance may be used to determine the exact location of the annotation instance.

      In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, annotations(DotName) is preferable.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • annotation

      default AnnotationInstance annotation(String name)
      Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets. The target() method of the returned annotation instance may be used to determine the exact location of the annotation instance.

      In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, annotations(DotName) is preferable.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • annotation

      default AnnotationInstance annotation(Class<? extends Annotation> clazz)
      Returns the annotation instance of given type declared on this annotation target or any of its nested annotation targets. The target() method of the returned annotation instance may be used to determine the exact location of the annotation instance.

      In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, annotations(DotName) is preferable.

      Parameters:
      clazz - the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • annotations

      Collection<AnnotationInstance> annotations(DotName name)
      Returns the annotation instances with given name declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
      Parameters:
      name - name of the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Since:
      3.0
      See Also:

    • annotations

      default Collection<AnnotationInstance> annotations(String name)
      Returns the annotation instances with given name declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
      Parameters:
      name - name of the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Since:
      3.0
      See Also:

    • annotations

      default Collection<AnnotationInstance> annotations(Class<? extends Annotation> clazz)
      Returns the annotation instances of given type declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
      Parameters:
      clazz - the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Since:
      3.0
      See Also:

    • annotationsWithRepeatable

      Collection<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)
      Returns the annotation instances with given name declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Parameters:
      name - name of the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • annotationsWithRepeatable

      default Collection<AnnotationInstance> annotationsWithRepeatable(String name, IndexView index)
      Returns the annotation instances with given name declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Parameters:
      name - name of the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • annotationsWithRepeatable

      default Collection<AnnotationInstance> annotationsWithRepeatable(Class<? extends Annotation> clazz, IndexView index)
      Returns the annotation instances of given type declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Parameters:
      clazz - the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • annotations

      Collection<AnnotationInstance> annotations()
      Returns the annotation instances declared on this annotation target and nested annotation targets. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
      Returns:
      immutable collection of annotation instances, never null
      Since:
      3.0

    • hasDeclaredAnnotation

      boolean hasDeclaredAnnotation(DotName name)
      Returns whether an annotation instance with given name is declared on this annotation target.

      Unlike hasAnnotation(DotName), this method ignores annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • hasDeclaredAnnotation

      default boolean hasDeclaredAnnotation(String name)
      Returns whether an annotation instance with given name is declared on this annotation target.

      Unlike hasAnnotation(DotName), this method ignores annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • hasDeclaredAnnotation

      default boolean hasDeclaredAnnotation(Class<? extends Annotation> clazz)
      Returns whether an annotation instance of given type is declared on this annotation target.

      Unlike hasAnnotation(DotName), this method ignores annotations declared on nested annotation targets.

      Parameters:
      clazz - the annotation type to look for, must not be null
      Returns:
      true if the annotation is present, false otherwise
      Since:
      3.0
      See Also:

    • declaredAnnotation

      AnnotationInstance declaredAnnotation(DotName name)
      Returns the annotation instance with given name declared on this annotation target.

      Unlike annotation(DotName), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • declaredAnnotation

      default AnnotationInstance declaredAnnotation(String name)
      Returns the annotation instance with given name declared on this annotation target.

      Unlike annotation(DotName), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • declaredAnnotation

      default AnnotationInstance declaredAnnotation(Class<? extends Annotation> clazz)
      Returns the annotation instance of given type declared on this annotation target.

      Unlike annotation(DotName), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      clazz - the annotation type to look for, must not be null
      Returns:
      the annotation instance, or null if not found
      Since:
      3.0
      See Also:

    • declaredAnnotationsWithRepeatable

      Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(DotName name, IndexView index)
      Returns the annotation instances with given name declared on this annotation target.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Unlike annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • declaredAnnotationsWithRepeatable

      default Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(String name, IndexView index)
      Returns the annotation instances with given name declared on this annotation target.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Unlike annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      name - name of the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • declaredAnnotationsWithRepeatable

      default Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(Class<? extends Annotation> clazz, IndexView index)
      Returns the annotation instances of given type declared on this annotation target.

      If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.

      Unlike annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on nested annotation targets.

      Parameters:
      clazz - the annotation type, must not be null
      index - index used to obtain the annotation type, must not be null
      Returns:
      immutable collection of annotation instances, never null
      Throws:
      IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
      Since:
      3.0
      See Also:

    • declaredAnnotations

      Collection<AnnotationInstance> declaredAnnotations()
      Returns the annotation instances declared on this annotation target.

      Unlike annotations(), this method doesn't return annotations declared on nested annotation targets.

      Returns:
      immutable collection of annotation instances, never null
      Since:
      3.0
      See Also: