net.bytebuddy.description.annotation

Interface AnnotationDescription

All Known Subinterfaces:

AnnotationDescription.Loadable<S>

All Known Implementing Classes:

AnnotationDescription.AbstractBase, AnnotationDescription.AbstractBase.ForPrepared, AnnotationDescription.ForLoadedAnnotation, AnnotationDescription.Latent, AnnotationDescription.Latent.Loadable

public interface AnnotationDescription

An annotation description describes Annotation meta data of a class without this class being required to be loaded. All values of an annotation are therefore represented in unloaded state:

• Class instances are represented as TypeDescriptions.
• Enum instances are represented as EnumerationDescriptions.
• Annotations are described as AnnotationDescriptions.
• All primitive types are represented as their wrapper types.

An annotation can however be loaded in order to access unwrapped values. This will cause a loading of the classes of these values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnnotationDescription.AbstractBase An adapter implementation of an annotation.
static class	AnnotationDescription.AnnotationInvocationHandler<T extends Annotation> An InvocationHandler for implementing annotations.
static class	AnnotationDescription.Builder A builder for pragmatically creating AnnotationDescription.
static class	AnnotationDescription.ForLoadedAnnotation<S extends Annotation> A description of an already loaded annotation.
static class	AnnotationDescription.Latent A latent description of an annotation value that is defined explicitly.
static interface	AnnotationDescription.Loadable<S extends Annotation> An annotation description that is linked to a given loaded annotation type which allows its representation as a fully loaded instance.

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationDescription.Loadable<?>	UNDEFINED Indicates an inexistent annotation in a type-safe manner.

Method Summary

Modifier and Type	Method and Description
TypeDescription	getAnnotationType() Returns a description of the annotation type of this annotation.
Set<ElementType>	getElementTypes() Returns a set of all ElementTypes that can declare this annotation.
RetentionPolicy	getRetention() Returns this annotation's retention policy.
AnnotationValue<?,?>	getValue(MethodDescription.InDefinedShape property) Returns the value of this annotation.
boolean	isDocumented() Checks if this annotation is documented.
boolean	isInherited() Checks if this annotation is inherited.
<T extends Annotation> AnnotationDescription.Loadable<T>	prepare(Class<T> annotationType) Links this annotation description to a given annotation type such that it can be loaded.

Field Detail

UNDEFINED

static final AnnotationDescription.Loadable<?> UNDEFINED

Indicates an inexistent annotation in a type-safe manner.

Method Detail

getValue

AnnotationValue<?,?> getValue(MethodDescription.InDefinedShape property)

Returns the value of this annotation.

Parameters:

property - The property being accessed.

Returns:

The value for the supplied property.

getAnnotationType

TypeDescription getAnnotationType()

Returns a description of the annotation type of this annotation.

Returns:

A description of the annotation type of this annotation.

prepare

<T extends Annotation> AnnotationDescription.Loadable<T> prepare(Class<T> annotationType)

Links this annotation description to a given annotation type such that it can be loaded. This does not cause the values of this annotation to be loaded.

Type Parameters:

T - The type of the annotation.

Parameters:

annotationType - The loaded annotation type of this annotation description.

Returns:

A loadable version of this annotation description.

getRetention

RetentionPolicy getRetention()

Returns this annotation's retention policy.

Returns:

This annotation's retention policy.

getElementTypes

Set<ElementType> getElementTypes()

Returns a set of all ElementTypes that can declare this annotation.

Returns:

A set of all element types that can declare this annotation.

isInherited

boolean isInherited()

Checks if this annotation is inherited.

Returns:

true if this annotation is inherited.

See Also:

Inherited

isDocumented

boolean isDocumented()

Checks if this annotation is documented.

Returns:

true if this annotation is documented.

See Also:

Documented