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 interface	AnnotationDescription.AnnotationValue<T,S> A description of an annotation's value.
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.

Method Summary

Modifier and Type	Method and Description
TypeDescription	getAnnotationType() Returns a description of the annotation type of this annotation.
RetentionPolicy	getRetention() Returns this annotation's retention policy.
Object	getValue(MethodDescription.InDefinedShape methodDescription) Returns the value of the given method for this annotation value.
<T> T	getValue(MethodDescription.InDefinedShape methodDescription, Class<T> type) Returns the value of the given method for this annotation value and performs a casting to the given value.
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.

Method Detail

getValue

Object getValue(MethodDescription.InDefinedShape methodDescription)

Returns the value of the given method for this annotation value. Note that all return values are wrapped as described by AnnotationDescription.

Parameters:

methodDescription - The method for the value to be requested.

Returns:

The value for the given method.

getValue

<T> T getValue(MethodDescription.InDefinedShape methodDescription,
               Class<T> type)

Returns the value of the given method for this annotation value and performs a casting to the given value. Note that all return values are wrapped described by AnnotationDescription.

Type Parameters:

T - The given type of the return value.

Parameters:

methodDescription - The method for the value to be requested.

type - The type to which the returned value should be casted.

Returns:

The value for the given method casted to type.

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.

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