Class TypeTarget
- All Implemented Interfaces:
AnnotationTarget
- Direct Known Subclasses:
EmptyTypeTarget
,PositionBasedTypeTarget
It is expected that callers will traverse the full tree from the specified starting point, since this context is important in interpreting the meaning of the type annotation
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Specifies a form of usage of a type annotationNested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget
AnnotationTarget.Kind
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionTypeTarget
(AnnotationTarget enclosingTarget) TypeTarget
(AnnotationTarget enclosingTarget, Type target) -
Method Summary
Modifier and TypeMethodDescriptionannotation
(DotName name) Returns the annotation instance with given name declared on this type usage.Returns the annotation instances declared on this type usage.annotations
(DotName name) Returns the annotation instances with given name declared on this type usage.annotationsWithRepeatable
(DotName name, IndexView index) Returns the annotation instances with given name declared on this type usage.final ClassInfo
asClass()
Casts and returns this target as aClassInfo
if it is of kindCLASS
Casts and returns this type target as aClassExtendsTypeTarget
.Casts and returns this annotation target as aDeclaration
if it is a declaration.asEmpty()
final FieldInfo
asField()
Casts and returns this target as aFieldInfo
if it is of kindFIELD
final MethodInfo
asMethod()
Casts and returns this target as aMethodInfo
if it is of kindMETHOD
final MethodParameterInfo
Casts and returns this target as aMethodParameterInfo
if it is of kindMETHOD_PARAMETER
Casts and returns this type target as aMethodParameterTypeTarget
.final RecordComponentInfo
Casts and returns this target as aRecordComponentInfo
if it is of kindRECORD_COMPONENT
asThrows()
Casts and returns this type target as aThrowsTypeTarget
.final TypeTarget
asType()
Casts and returns this target as aTypeTarget
if it is of kindTYPE
Casts and returns this type target as aTypeParameterTypeTarget
.Casts and returns this type target as aTypeParameterBoundTypeTarget
.declaredAnnotation
(DotName name) Returns the annotation instance with given name declared on this type usage.Returns the annotation instances declared on this type usage.declaredAnnotationsWithRepeatable
(DotName name, IndexView index) Returns the annotation instances with given name declared on this type usage.Returns the enclosing target that contains the type referred to by thetarget()
method.boolean
hasAnnotation
(DotName name) Returns whether an annotation instance with given name is declared on this type usage.boolean
hasDeclaredAnnotation
(DotName name) Returns whether an annotation instance with given name is declared on this type usage.boolean
Returns whether this annotation target is a declaration.final AnnotationTarget.Kind
kind()
Returns the kind of object this target represents.(package private) void
target()
Returns the type which contains the respective annotation.abstract TypeTarget.Usage
usage()
Returns the kind of usage of this type target.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jboss.jandex.AnnotationTarget
annotation, annotation, annotations, annotations, annotationsWithRepeatable, annotationsWithRepeatable, declaredAnnotation, declaredAnnotation, declaredAnnotationsWithRepeatable, declaredAnnotationsWithRepeatable, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation
-
Field Details
-
enclosingTarget
-
target
-
-
Constructor Details
-
TypeTarget
TypeTarget(AnnotationTarget enclosingTarget, Type target) -
TypeTarget
TypeTarget(AnnotationTarget enclosingTarget)
-
-
Method Details
-
setTarget
-
kind
Description copied from interface:AnnotationTarget
Returns the kind of object this target represents.- Specified by:
kind
in interfaceAnnotationTarget
- Returns:
- the target kind.
-
isDeclaration
public boolean isDeclaration()Description copied from interface:AnnotationTarget
Returns whether this annotation target is a declaration.- Specified by:
isDeclaration
in interfaceAnnotationTarget
- Returns:
- whether this annotation target is a declaration
-
asDeclaration
Description copied from interface:AnnotationTarget
Casts and returns this annotation target as aDeclaration
if it is a declaration.- Specified by:
asDeclaration
in interfaceAnnotationTarget
- Returns:
- this instance cast to a declaration
-
enclosingTarget
Returns the enclosing target that contains the type referred to by thetarget()
method.- Returns:
- the enclosing target
-
target
Returns the type which contains the respective annotation. In some cases this may be null (e.g. in the case of a bridge method, which erases type information so there is no target to map to)- Returns:
- the type containing the respective annotation
-
usage
Returns the kind of usage of this type target. This allows a caller to use a switch statement as opposed togetClass()
comparisons.- Returns:
- the kind of usage of this type target
-
asEmpty
-
asClassExtends
Casts and returns this type target as aClassExtendsTypeTarget
. If this type target is not aClassExtendsTypeTarget
, then an exception will be thrown.- Returns:
- an instance of
ClassExtendsTypeTarget
- Throws:
IllegalArgumentException
- if this is not aClassExtendsTypeTarget
-
asMethodParameterType
Casts and returns this type target as aMethodParameterTypeTarget
. If this type target is not aMethodParameterTypeTarget
, then an exception will be thrown.- Returns:
- an instance of
MethodParameterTypeTarget
- Throws:
IllegalArgumentException
- if this is not aMethodParameterTypeTarget
-
asTypeParameter
Casts and returns this type target as aTypeParameterTypeTarget
. If this type target is not aTypeParameterTypeTarget
, then an exception will be thrown.- Returns:
- an instance of
TypeParameterTypeTarget
- Throws:
IllegalArgumentException
- if this is not aTypeParameterTypeTarget
-
asTypeParameterBound
Casts and returns this type target as aTypeParameterBoundTypeTarget
. If this type target is not aTypeParameterBoundTypeTarget
, then an exception will be thrown.- Returns:
- an instance of
TypeParameterBoundTypeTarget
- Throws:
IllegalArgumentException
- if this is not aTypeParameterBoundTypeTarget
-
asThrows
Casts and returns this type target as aThrowsTypeTarget
. If this type target is not aThrowsTypeTarget
, then an exception will be thrown.- Returns:
- an instance of
ThrowsTypeTarget
- Throws:
IllegalArgumentException
- if this is not aTypeParameterBoundTypeTarget
-
asClass
Description copied from interface:AnnotationTarget
Casts and returns this target as aClassInfo
if it is of kindCLASS
- Specified by:
asClass
in interfaceAnnotationTarget
- Returns:
- this instance cast to a class
-
asField
Description copied from interface:AnnotationTarget
Casts and returns this target as aFieldInfo
if it is of kindFIELD
- Specified by:
asField
in interfaceAnnotationTarget
- Returns:
- this instance cast to a field
-
asMethod
Description copied from interface:AnnotationTarget
Casts and returns this target as aMethodInfo
if it is of kindMETHOD
- Specified by:
asMethod
in interfaceAnnotationTarget
- Returns:
- this instance cast to a method
-
asMethodParameter
Description copied from interface:AnnotationTarget
Casts and returns this target as aMethodParameterInfo
if it is of kindMETHOD_PARAMETER
- Specified by:
asMethodParameter
in interfaceAnnotationTarget
- Returns:
- this instance cast to a method parameter
-
asType
Description copied from interface:AnnotationTarget
Casts and returns this target as aTypeTarget
if it is of kindTYPE
- Specified by:
asType
in interfaceAnnotationTarget
- Returns:
- this instance cast to a type target
-
asRecordComponent
Description copied from interface:AnnotationTarget
Casts and returns this target as aRecordComponentInfo
if it is of kindRECORD_COMPONENT
- Specified by:
asRecordComponent
in interfaceAnnotationTarget
- Returns:
- this instance cast to a record component
-
hasAnnotation
Returns whether an annotation instance with given name is declared on this type usage.Note that unlike other
AnnotationTarget
s, this method doesn't inspect nested annotation targets, even though array types, parameterized types, type variables and wildcard types may contain other types inside them. In other words, this method is equivalent tohasDeclaredAnnotation(DotName)
.- Specified by:
hasAnnotation
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type to look for, must not benull
- Returns:
true
if the annotation is present,false
otherwise- Since:
- 3.0
- See Also:
-
annotation
Returns the annotation instance with given name declared on this type usage.Note that unlike other
AnnotationTarget
s, this method doesn't inspect nested annotation targets, even though array types, parameterized types, type variables and wildcard types may contain other types inside them. In other words, this method is equivalent todeclaredAnnotation(DotName)
.- Specified by:
annotation
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type to look for, must not benull
- Returns:
- the annotation instance, or
null
if not found - Since:
- 3.0
- See Also:
-
annotations
Returns the annotation instances with given name declared on this type usage.Note that unlike other
AnnotationTarget
s, this method doesn't inspect nested annotation targets, even though array types, parameterized types, type variables and wildcard types may contain other types inside them. In other words, this method is equivalent toannotation(DotName)
anddeclaredAnnotation(DotName)
, except it returns a list.- Specified by:
annotations
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type, must not benull
- Returns:
- immutable list of annotation instances, never
null
- Since:
- 3.0
- See Also:
-
annotationsWithRepeatable
Returns the annotation instances with given name declared on this type usage.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.Note that unlike other
AnnotationTarget
s, this method doesn't inspect nested annotation targets, even though array types, parameterized types, type variables and wildcard types may contain other types inside them. In other words, this method is equivalent todeclaredAnnotationsWithRepeatable(DotName, IndexView)
.- Specified by:
annotationsWithRepeatable
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type, must not benull
index
- index used to obtain the annotation type, must not benull
- Returns:
- immutable list of annotation instances, never
null
- Throws:
IllegalArgumentException
- if the index isnull
, if the index does not contain the annotation type or ifname
does not identify an annotation type- Since:
- 3.0
- See Also:
-
annotations
Returns the annotation instances declared on this type usage.Note that unlike other
AnnotationTarget
s, this method doesn't inspect nested annotation targets, even though array types, parameterized types, type variables and wildcard types may contain other types inside them. In other words, this method is equivalent todeclaredAnnotations()
.- Specified by:
annotations
in interfaceAnnotationTarget
- Returns:
- immutable list of annotation instances, never
null
- Since:
- 3.0
-
hasDeclaredAnnotation
Returns whether an annotation instance with given name is declared on this type usage.- Specified by:
hasDeclaredAnnotation
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type to look for, must not benull
- Returns:
true
if the annotation is present,false
otherwise- Since:
- 3.0
- See Also:
-
declaredAnnotation
Returns the annotation instance with given name declared on this type usage.- Specified by:
declaredAnnotation
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type to look for, must not benull
- Returns:
- the annotation instance, or
null
if not found - Since:
- 3.0
- See Also:
-
declaredAnnotationsWithRepeatable
Returns the annotation instances with given name declared on this type usage.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.- Specified by:
declaredAnnotationsWithRepeatable
in interfaceAnnotationTarget
- Parameters:
name
- name of the annotation type, must not benull
index
- index used to obtain the annotation type, must not benull
- Returns:
- immutable list of annotation instances, never
null
- Throws:
IllegalArgumentException
- if the index isnull
, if the index does not contain the annotation type or ifname
does not identify an annotation type- Since:
- 3.0
- See Also:
-
declaredAnnotations
Returns the annotation instances declared on this type usage.- Specified by:
declaredAnnotations
in interfaceAnnotationTarget
- Returns:
- immutable list of annotation instances, never
null
- Since:
- 3.0
- See Also:
-