AnnotationTarget (Jandex: Core 3.0.1 API)

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.

Author:

Jason T. Greene

See Also:

ClassInfo, FieldInfo, MethodInfo, MethodParameterInfo

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class AnnotationTarget.Kind
Specifies the kind of object a target represents.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`AnnotationTarget.Kind` Specifies the kind of object a target represents.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`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.
`AnnotationInstance`	`annotation(DotName name)` Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets.
`default AnnotationInstance`	`annotation(String name)` Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets.
`Collection<AnnotationInstance>`	`annotations()` Returns the annotation instances declared on this annotation target and nested annotation targets.
`default Collection<AnnotationInstance>`	`annotations(Class<? extends Annotation> clazz)` Returns the annotation instances of given type declared on this annotation target and nested annotation targets.
`Collection<AnnotationInstance>`	`annotations(DotName name)` Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
`default Collection<AnnotationInstance>`	`annotations(String name)` Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
`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.
`Collection<AnnotationInstance>`	`annotationsWithRepeatable(DotName name, IndexView index)` Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
`default Collection<AnnotationInstance>`	`annotationsWithRepeatable(String name, IndexView index)` Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
`ClassInfo`	`asClass()` Casts and returns this target as a `ClassInfo` if it is of kind `CLASS`
`FieldInfo`	`asField()` Casts and returns this target as a `FieldInfo` if it is of kind `FIELD`
`MethodInfo`	`asMethod()` Casts and returns this target as a `MethodInfo` if it is of kind `METHOD`
`MethodParameterInfo`	`asMethodParameter()` Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER`
`RecordComponentInfo`	`asRecordComponent()` Casts and returns this target as a `RecordComponentInfo` if it is of kind `RECORD_COMPONENT`
`TypeTarget`	`asType()` Casts and returns this target as a `TypeTarget` if it is of kind `TYPE`
`default AnnotationInstance`	`declaredAnnotation(Class<? extends Annotation> clazz)` Returns the annotation instance of given type declared on this annotation target.
`AnnotationInstance`	`declaredAnnotation(DotName name)` Returns the annotation instance with given name declared on this annotation target.
`default AnnotationInstance`	`declaredAnnotation(String name)` Returns the annotation instance with given name declared on this annotation target.
`Collection<AnnotationInstance>`	`declaredAnnotations()` Returns the annotation instances declared on this annotation target.
`default Collection<AnnotationInstance>`	`declaredAnnotationsWithRepeatable(Class<? extends Annotation> clazz, IndexView index)` Returns the annotation instances of given type declared on this annotation target.
`Collection<AnnotationInstance>`	`declaredAnnotationsWithRepeatable(DotName name, IndexView index)` Returns the annotation instances with given name declared on this annotation target.
`default Collection<AnnotationInstance>`	`declaredAnnotationsWithRepeatable(String name, IndexView index)` Returns the annotation instances with given name declared on this annotation target.
`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.
`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.
`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.
`default boolean`	`hasDeclaredAnnotation(Class<? extends Annotation> clazz)` Returns whether an annotation instance of given type is declared on this annotation target.
`boolean`	`hasDeclaredAnnotation(DotName name)` Returns whether an annotation instance with given name is declared on this annotation target.
`default boolean`	`hasDeclaredAnnotation(String name)` Returns whether an annotation instance with given name is declared on this annotation target.
`AnnotationTarget.Kind`	`kind()` Returns the kind of object this target represents.

- Method Detail
  - kind
```
AnnotationTarget.Kind kind()
```
    Returns the kind of object this target represents.
    
    Returns:
    
    the target kind.
    
    Since:
    
    2.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:
    
    annotation(DotName)
  - 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:
    
    annotation(DotName)
  - 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(DotName)
  - 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:
    
    annotations(DotName)
  - 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:
    
    annotations(DotName)
  - 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(DotName)
  - 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:
    
    annotationsWithRepeatable(DotName, IndexView), annotations()
  - 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:
    
    annotationsWithRepeatable(DotName, IndexView), annotations()
  - 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(DotName, IndexView), annotations()
  - 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:
    
    annotations(DotName), annotations()
  - 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:
    
    annotations(DotName), annotations()
  - 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(DotName), annotations()
  - 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:
    
    hasAnnotation(DotName)
  - 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:
    
    hasAnnotation(DotName)
  - 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:
    
    hasAnnotation(DotName)
  - 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:
    
    annotation(DotName)
  - 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:
    
    annotation(DotName)
  - 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:
    
    annotation(DotName)
  - 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:
    
    annotationsWithRepeatable(DotName, IndexView)
  - 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:
    
    annotationsWithRepeatable(DotName, IndexView)
  - 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:
    
    annotationsWithRepeatable(DotName, IndexView)
  - 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:
    
    annotations()

Interface AnnotationTarget

Nested Class Summary

Method Summary

Method Detail

kind

asClass

asField

asMethod

asMethodParameter

asType

asRecordComponent

hasAnnotation

hasAnnotation

hasAnnotation

annotation

annotation

annotation

annotations

annotations

annotations

annotationsWithRepeatable

annotationsWithRepeatable

annotationsWithRepeatable

annotations

hasDeclaredAnnotation

hasDeclaredAnnotation

hasDeclaredAnnotation

declaredAnnotation

declaredAnnotation

declaredAnnotation

declaredAnnotationsWithRepeatable

declaredAnnotationsWithRepeatable

declaredAnnotationsWithRepeatable

declaredAnnotations