net.bytebuddy.implementation.attribute

Enum AnnotationRetention

java.lang.Object

java.lang.Enum<AnnotationRetention>

net.bytebuddy.implementation.attribute.AnnotationRetention

All Implemented Interfaces:

Serializable, Comparable<AnnotationRetention>

public enum AnnotationRetention
extends Enum<AnnotationRetention>

An annotation retention strategy decides if annotations that are contained within a class file are preserved upon redefining or rebasing a method. When annotations are retained, it is important not to define annotations explicitly that are already defined. When annotations are retained, they are retained in their original format, i.e. default values that were not included in the class file are not added or skipped as determined by a AnnotationValueFilter.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Disables annotation retention, i.e.
ENABLED Enables annotation retention, i.e.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled() Returns true if annotation retention is enabled.
static AnnotationRetention	of(boolean enabled) Resolves an annotation retention from a boolean value.
static AnnotationRetention	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnnotationRetention[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENABLED

public static final AnnotationRetention ENABLED

Enables annotation retention, i.e. annotations within an existing class files are preserved as they are.

DISABLED

public static final AnnotationRetention DISABLED

Disables annotation retention, i.e. annotations within an existing class files are discarded.

Method Detail

values

public static AnnotationRetention[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnnotationRetention c : AnnotationRetention.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnnotationRetention valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

of

public static AnnotationRetention of(boolean enabled)

Resolves an annotation retention from a boolean value.

Parameters:

enabled - true if annotation retention is enabled.

Returns:

An enabled annotation retention if the value is true.

isEnabled

public boolean isEnabled()

Returns true if annotation retention is enabled.

Returns:

true if annotation retention is enabled.