java.lang.annotation

Enum RetentionPolicy

java.lang.Object

java.lang.Enum<RetentionPolicy>

java.lang.annotation.RetentionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RetentionPolicy>

public enum RetentionPolicy
extends java.lang.Enum<RetentionPolicy>

This enum is used to control the lifetime of an annotation.

Since:

1.5

See Also:

Retention

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASS Indicates that the annotation should be stored in class files.
RUNTIME Indicates that the annotation should be available at runtime.
SOURCE Indicates that the annotation should only be available when parsing the source code.

Method Summary

Methods

Modifier and Type	Method and Description
static RetentionPolicy	valueOf(java.lang.String name) 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.

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

CLASS

public static final RetentionPolicy CLASS

Indicates that the annotation should be stored in class files.

RUNTIME

public static final RetentionPolicy RUNTIME

Indicates that the annotation should be available at runtime.

SOURCE

public static final RetentionPolicy SOURCE

Indicates that the annotation should only be available when parsing the source code.

Method Detail

values

public static RetentionPolicy[] 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 (RetentionPolicy c : RetentionPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static RetentionPolicy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null