Jandex: Core 3.1.6 · org.jboss.jandex.AnnotationTarget

Modifier and Type	Class and Description
public static enum	AnnotationTarget.Kind Specifies the kind of object a target represents.

Method Summary

Modifier and Type	Method and Description
public AnnotationInstance	Returns: the annotation instance, or `null` if not found annotation(DotName name of the annotation type to look for, must not be `null` name) Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets.
public default AnnotationInstance	Returns: the annotation instance, or `null` if not found annotation(String name of the annotation type to look for, must not be `null` name) Returns the annotation instance with given name declared on this annotation target or any of its nested annotation targets.
public default AnnotationInstance	Returns: the annotation instance, or `null` if not found annotation(Class<? extends Annotation> the annotation type to look for, must not be `null` clazz) Returns the annotation instance of given type declared on this annotation target or any of its nested annotation targets.
public Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotations(DotName name of the annotation type, must not be `null` name) Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotations(String name of the annotation type, must not be `null` name) Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotations(Class<? extends Annotation> the annotation type, must not be `null` clazz) Returns the annotation instances of given type declared on this annotation target and nested annotation targets.
public Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotations() Returns the annotation instances declared on this annotation target and nested annotation targets.
public Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotationsWithRepeatable(DotName name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotationsWithRepeatable(String name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances with given name declared on this annotation target and nested annotation targets.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` annotationsWithRepeatable(Class<? extends Annotation> the annotation type, must not be `null` clazz, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances of given type declared on this annotation target and nested annotation targets.
public ClassInfo	Returns: this instance cast to a class asClass() Casts and returns this target as a `ClassInfo` if it is of kind `CLASS`
public Declaration	Returns: this instance cast to a declaration asDeclaration() Casts and returns this annotation target as a `Declaration` if it is a declaration.
public FieldInfo	Returns: this instance cast to a field asField() Casts and returns this target as a `FieldInfo` if it is of kind `FIELD`
public MethodInfo	Returns: this instance cast to a method asMethod() Casts and returns this target as a `MethodInfo` if it is of kind `METHOD`
public MethodParameterInfo	Returns: this instance cast to a method parameter asMethodParameter() Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER`
public RecordComponentInfo	Returns: this instance cast to a record component asRecordComponent() Casts and returns this target as a `RecordComponentInfo` if it is of kind `RECORD_COMPONENT`
public TypeTarget	Returns: this instance cast to a type target asType() Casts and returns this target as a `TypeTarget` if it is of kind `TYPE`
public AnnotationInstance	Returns: the annotation instance, or `null` if not found declaredAnnotation(DotName name of the annotation type to look for, must not be `null` name) Returns the annotation instance with given name declared on this annotation target.
public default AnnotationInstance	Returns: the annotation instance, or `null` if not found declaredAnnotation(String name of the annotation type to look for, must not be `null` name) Returns the annotation instance with given name declared on this annotation target.
public default AnnotationInstance	Returns: the annotation instance, or `null` if not found declaredAnnotation(Class<? extends Annotation> the annotation type to look for, must not be `null` clazz) Returns the annotation instance of given type declared on this annotation target.
public Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` declaredAnnotations() Returns the annotation instances declared on this annotation target.
public Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` declaredAnnotationsWithRepeatable(DotName name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances with given name declared on this annotation target.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` declaredAnnotationsWithRepeatable(String name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances with given name declared on this annotation target.
public default Collection<AnnotationInstance>	Returns: immutable collection of annotation instances, never `null` declaredAnnotationsWithRepeatable(Class<? extends Annotation> the annotation type, must not be `null` clazz, IndexView index used to obtain the annotation type, must not be `null` index) Returns the annotation instances of given type declared on this annotation target.
public boolean	Returns: `true` if the annotation is present, `false` otherwise hasAnnotation(DotName name of the annotation type to look for, must not be `null` name) Returns whether an annotation instance with given name is declared on this annotation target or any of its nested annotation targets.
public default boolean	Returns: `true` if the annotation is present, `false` otherwise hasAnnotation(String name of the annotation type to look for, must not be `null` name) Returns whether an annotation instance with given name is declared on this annotation target or any of its nested annotation targets.
public default boolean	Returns: `true` if the annotation is present, `false` otherwise hasAnnotation(Class<? extends Annotation> the annotation type to look for, must not be `null` clazz) Returns whether an annotation instance of given type is declared on this annotation target or any of its nested annotation targets.
public boolean	Returns: `true` if the annotation is present, `false` otherwise hasDeclaredAnnotation(DotName name of the annotation type to look for, must not be `null` name) Returns whether an annotation instance with given name is declared on this annotation target.
public default boolean	Returns: `true` if the annotation is present, `false` otherwise hasDeclaredAnnotation(String name of the annotation type to look for, must not be `null` name) Returns whether an annotation instance with given name is declared on this annotation target.
public default boolean	Returns: `true` if the annotation is present, `false` otherwise hasDeclaredAnnotation(Class<? extends Annotation> the annotation type to look for, must not be `null` clazz) Returns whether an annotation instance of given type is declared on this annotation target.
public boolean	Returns: whether this annotation target is a declaration isDeclaration() Returns whether this annotation target is a declaration.
public AnnotationTarget.Kind	Returns: the target kind. kind() Returns the kind of object this target represents.

Method Detail

annotation back to summary

annotation	back to summary
public 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:DotName name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotations(DotName)`

public 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:DotName: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotations(DotName)

annotation back to summary

annotation	back to summary
public 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:String name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotations(DotName)`

public default AnnotationInstance annotation(String name)

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:String: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotations(DotName)

annotation back to summary

annotation	back to summary
public 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:Class<? extends Annotation> the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotations(DotName)`

public 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:Class<? extends Annotation>: the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotations(DotName)

annotations back to summary

annotations	back to summary
public 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:DotName name of the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Since 3.0 See Also `annotationsWithRepeatable(DotName, IndexView)`, `annotations()`

public 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:DotName: name of the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Since

3.0

annotations back to summary

annotations	back to summary
public 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:String name of the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Since 3.0 See Also `annotationsWithRepeatable(DotName, IndexView)`, `annotations()`

public default Collection<AnnotationInstance> annotations(String name)

Parameters

name:String: name of the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Since

3.0

annotations back to summary

annotations	back to summary
public 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:Class<? extends Annotation> the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Since 3.0 See Also `annotationsWithRepeatable(DotName, IndexView)`, `annotations()`

public 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:Class<? extends Annotation>: the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Since

3.0

annotations back to summary

annotations	back to summary
public 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:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Since 3.0

public 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:Collection<AnnotationInstance>: immutable collection of annotation instances, never null
Since: 3.0

annotationsWithRepeatable back to summary

annotationsWithRepeatable	back to summary
public 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:DotName name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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()`

public Collection<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)

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:DotName: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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 back to summary

annotationsWithRepeatable	back to summary
public 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:String name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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()`

public default Collection<AnnotationInstance> annotationsWithRepeatable(String name, IndexView index)

Parameters

name:String: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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 back to summary

annotationsWithRepeatable	back to summary
public 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:Class<? extends Annotation> the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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()`

public default Collection<AnnotationInstance> annotationsWithRepeatable(Class<? extends Annotation> clazz, IndexView index)

Parameters

clazz:Class<? extends Annotation>: the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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()

asClass back to summary

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

public ClassInfo asClass()

Casts and returns this target as a ClassInfo if it is of kind CLASS

Returns:ClassInfo: this instance cast to a class
Since: 2.0

asDeclaration back to summary

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

public Declaration asDeclaration()

Casts and returns this annotation target as a Declaration if it is a declaration.

Returns:Declaration: this instance cast to a declaration
Since: 3.1.0

asField back to summary

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

public FieldInfo asField()

Casts and returns this target as a FieldInfo if it is of kind FIELD

Returns:FieldInfo: this instance cast to a field
Since: 2.0

asMethod back to summary

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

public MethodInfo asMethod()

Casts and returns this target as a MethodInfo if it is of kind METHOD

Returns:MethodInfo: this instance cast to a method
Since: 2.0

asMethodParameter back to summary

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

public MethodParameterInfo asMethodParameter()

Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER

Returns:MethodParameterInfo: this instance cast to a method parameter
Since: 2.0

asRecordComponent back to summary

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

public RecordComponentInfo asRecordComponent()

Casts and returns this target as a RecordComponentInfo if it is of kind RECORD_COMPONENT

Returns:RecordComponentInfo: this instance cast to a record component
Since: 2.4

asType back to summary

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

public TypeTarget asType()

Casts and returns this target as a TypeTarget if it is of kind TYPE

Returns:TypeTarget: this instance cast to a type target
Since: 2.0

declaredAnnotation back to summary

declaredAnnotation	back to summary
public 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:DotName name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotation(DotName)`

public 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:DotName: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotation(DotName)

declaredAnnotation back to summary

declaredAnnotation	back to summary
public 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:String name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotation(DotName)`

public 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:String: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotation(DotName)

declaredAnnotation back to summary

declaredAnnotation	back to summary
public 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:Class<? extends Annotation> the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Since 3.0 See Also `annotation(DotName)`

public 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:Class<? extends Annotation>: the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Since

3.0

See Also

annotation(DotName)

declaredAnnotations back to summary

declaredAnnotations	back to summary
public 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:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Since 3.0 See Also `annotations()`

public 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:Collection<AnnotationInstance>: immutable collection of annotation instances, never null
Since: 3.0
See Also: annotations()

declaredAnnotationsWithRepeatable back to summary

declaredAnnotationsWithRepeatable	back to summary
public 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:DotName name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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)`

public Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(DotName name, IndexView index)

Returns the annotation instances with given name declared on this annotation target.

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

Parameters

name:DotName: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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

declaredAnnotationsWithRepeatable back to summary

declaredAnnotationsWithRepeatable	back to summary
public 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:String name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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)`

public default Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(String name, IndexView index)

Returns the annotation instances with given name declared on this annotation target.

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

Parameters

name:String: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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

declaredAnnotationsWithRepeatable back to summary

declaredAnnotationsWithRepeatable	back to summary
public 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:Class<? extends Annotation> the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:Collection<AnnotationInstance> immutable collection of annotation instances, never `null` Exceptions 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)`

public default Collection<AnnotationInstance> declaredAnnotationsWithRepeatable(Class<? extends Annotation> clazz, IndexView index)

Returns the annotation instances of given type declared on this annotation target.

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

Parameters

clazz:Class<? extends Annotation>: the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:Collection<AnnotationInstance>

immutable collection of annotation instances, never null

Exceptions

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

hasAnnotation back to summary

hasAnnotation	back to summary
public 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:DotName name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `annotation(DotName)`

public 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:DotName: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

annotation(DotName)

hasAnnotation back to summary

hasAnnotation	back to summary
public 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:String name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `annotation(DotName)`

public 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:String: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

annotation(DotName)

hasAnnotation back to summary

hasAnnotation	back to summary
public 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:Class<? extends Annotation> the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `annotation(DotName)`

public 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:Class<? extends Annotation>: the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

annotation(DotName)

hasDeclaredAnnotation back to summary

hasDeclaredAnnotation	back to summary
public 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:DotName name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `hasAnnotation(DotName)`

public 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:DotName: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

hasAnnotation(DotName)

hasDeclaredAnnotation back to summary

hasDeclaredAnnotation	back to summary
public 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:String name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `hasAnnotation(DotName)`

public 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:String: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

hasAnnotation(DotName)

hasDeclaredAnnotation back to summary

hasDeclaredAnnotation	back to summary
public 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:Class<? extends Annotation> the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Since 3.0 See Also `hasAnnotation(DotName)`

public 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:Class<? extends Annotation>: the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Since

3.0

See Also

hasAnnotation(DotName)

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

isDeclaration

back to summary

public boolean isDeclaration()

Returns whether this annotation target is a declaration.

Returns:boolean: whether this annotation target is a declaration
Since: 3.1.0

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

kind

back to summary

public AnnotationTarget.Kind kind()

Returns the kind of object this target represents.

Returns:AnnotationTarget.Kind: the target kind.
Since: 2.0

Modifier and Type	Field and Description
public static final AnnotationTarget.Kind	CLASS An object of type `org.jboss.jandex.ClassInfo`
public static final AnnotationTarget.Kind	FIELD An object of type `org.jboss.jandex.FieldInfo`
public static final AnnotationTarget.Kind	METHOD An object of type `org.jboss.jandex.MethodInfo`
public static final AnnotationTarget.Kind	METHOD_PARAMETER An object of type `org.jboss.jandex.MethodParameterInfo`
public static final AnnotationTarget.Kind	RECORD_COMPONENT An object of type `org.jboss.jandex.RecordComponentInfo`
public static final AnnotationTarget.Kind	TYPE An object of type `org.jboss.jandex.TypeTarget`

Modifier and Type	Method and Description
public static AnnotationTarget.Kind	valueOf(String name)
public static AnnotationTarget.Kind[]	values()

public Interface AnnotationTarget

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum AnnotationTarget.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail