RetentionPolicy (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.lang.annotation
enum RetentionPolicy

java.lang.Object
  java.lang.Enum
      java.lang.annotation.RetentionPolicy

All Implemented Interfaces:: Serializable, Comparable

public final enum RetentionPolicy
extends Enum

Annotation retention policy. The constants of this enumerated type describe the various policies for retaining annotations. They are used in conjunction with the {@link Retention} meta-annotation type to specify how long annotations are to be retained.

Field Summary
`static RetentionPolicy`	`CLASS` Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time.
`static RetentionPolicy`	`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.
`static RetentionPolicy`	`SOURCE` Annotations are to be discarded by the compiler.

Method Summary
`static RetentionPolicy`	`valueOf(String name)`
`static RetentionPolicy[]`	`values()`

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

CLASS

public static final RetentionPolicy 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

public static final RetentionPolicy 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.

SOURCE

public static final RetentionPolicy SOURCE

Annotations are to be discarded by the compiler.

Method Detail

valueOf

public static RetentionPolicy valueOf(String name)

Parameters:: name

values

public static RetentionPolicy[] values()