- All Implemented Interfaces:
Serializable
,Comparable<RetentionPolicy>
,Constable
public enum RetentionPolicy extends Enum<RetentionPolicy>
Annotation retention policy. The constants of this enumerated type
describe the various policies for retaining annotations. They are used
in conjunction with the
Retention
meta-annotation type to specify
how long annotations are to be retained.- Since:
- 1.5
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionAnnotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time.Annotations are to be recorded in the class file by the compiler and retained by the VM at run time, so they may be read reflectively.Annotations are to be discarded by the compiler. -
Method Summary
Modifier and TypeMethodDescriptionstatic RetentionPolicy
Returns the enum constant of this type with the specified name.static RetentionPolicy[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SOURCE
Annotations are to be discarded by the compiler. -
CLASS
Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time. This is the default behavior. -
RUNTIME
Annotations are to be recorded in the class file by the compiler and retained by the VM at run time, so they may be read reflectively.- See Also:
AnnotatedElement
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-