Top Description Inners Fields Methods
net.bytebuddy.description.annotation

public Interface AnnotationDescription

Known Direct Subinterfaces
net.bytebuddy.description.annotation.AnnotationDescription.Loadable
Known Direct Implementers
net.bytebuddy.description.annotation.AnnotationDescription.AbstractBase
Imports
edu.umd.cs.findbugs.annotations.SuppressFBWarnings, net.bytebuddy.ClassFileVersion, net.bytebuddy.build.AccessControllerPlugin, .CachedReturnPlugin, .HashCodeAndEqualsPlugin, net.bytebuddy.description.enumeration.EnumerationDescription, net.bytebuddy.description.method.MethodDescription, .MethodList, net.bytebuddy.description.type.TypeDescription, .TypeList, net.bytebuddy.dynamic.loading.ClassLoadingStrategy, net.bytebuddy.utility.nullability.AlwaysNull, .MaybeNull, net.bytebuddy.utility.privilege.SetAccessibleAction, java.lang.annotation.*, java.lang.reflect.InvocationHandler, .InvocationTargetException, .Method, .Proxy, java.security.PrivilegedAction, java.util.*

An annotation description describes java.lang.annotation.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: An annotation can however be loaded in order to access unwrapped values. This will cause a loading of the classes of these values.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
AnnotationDescription.AbstractBase

An adapter implementation of an annotation.

public static class
AnnotationDescription.AnnotationInvocationHandler<
The type of the handled annotation.
T extends Annotation
>

An java.lang.reflect.InvocationHandler for implementing annotations.

public static class
public static class
AnnotationDescription.ForLoadedAnnotation<
The type of the annotation.
S extends Annotation
>

A description of an already loaded annotation.

public static class
AnnotationDescription.Latent

A latent description of an annotation value that is defined explicitly.

public static interface
AnnotationDescription.Loadable<
The annotation type.
S extends Annotation
>

An annotation description that is linked to a given loaded annotation type which allows its representation as a fully loaded instance.

public static enum
AnnotationDescription.RenderingDispatcher

A rendering dispatcher is responsible for resolving annotation descriptions to String representations.

Field Summary

Modifier and TypeField and Description
public static final AnnotationDescription.Loadable<?>
UNDEFINED

Indicates a nonexistent annotation in a type-safe manner.

Method Summary

Modifier and TypeMethod and Description
public TypeDescription

Returns:

A description of the annotation type of this annotation.
getAnnotationType
()

Returns a description of the annotation type of this annotation.

public Set<ElementType>

Returns:

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

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

public RetentionPolicy

Returns:

This annotation's retention policy.
getRetention
()

Returns this annotation's retention policy.

public AnnotationValue<?, ?>

Returns:

The value for the supplied property.
getValue
(String
The name of the property being accessed.
property
)

Returns a value of this annotation.

public AnnotationValue<?, ?>

Returns:

The value for the supplied property.
getValue
(MethodDescription.InDefinedShape
The property being accessed.
property
)

Returns a value of this annotation.

public boolean

Returns:

true if this annotation is documented.
isDocumented
()

Checks if this annotation is documented.

public boolean

Returns:

true if this annotation is inherited.
isInherited
()

Checks if this annotation is inherited.

public boolean

Returns:

true if the supplied element type is supported by this annotation.
isSupportedOn
(ElementType
The element type to check.
elementType
)

Checks if this annotation is supported on the supplied element type.

public boolean

Returns:

true if the supplied element type is supported by this annotation.
isSupportedOn
(String
The element type to check.
elementType
)

Checks if this annotation is supported on the supplied element type.

public <
The type of the annotation.
T extends Annotation
>
AnnotationDescription.Loadable<T>

Returns:

A loadable version of this annotation description.
prepare
(Class<T>
The loaded annotation type of this annotation description.
annotationType
)

Links this annotation description to a given annotation type such that it can be loaded.