RetentionPolicy (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.lang.Enum<RetentionPolicy>
  • • java.lang.annotation.RetentionPolicy

• All Implemented Interfaces:
  Serializable, Comparable<RetentionPolicy>

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

• • Enum Constant Summary

  Enum Constants

  Enum Constant	Description
  CLASS	Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time.
  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	Annotations are to be discarded by the compiler.

  • Method Summary

  All Methods Static Methods Concrete Methods

  Modifier and Type	Method	Description
  static RetentionPolicy	valueOf(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](../../../java/lang/Enum.html "class in java.lang")  
     `[clone](../../../java/lang/Enum.html#clone--), [compareTo](../../../java/lang/Enum.html#compareTo-E-), [equals](../../../java/lang/Enum.html#equals-java.lang.Object-), [finalize](../../../java/lang/Enum.html#finalize--), [getDeclaringClass](../../../java/lang/Enum.html#getDeclaringClass--), [hashCode](../../../java/lang/Enum.html#hashCode--), [name](../../../java/lang/Enum.html#name--), [ordinal](../../../java/lang/Enum.html#ordinal--), [toString](../../../java/lang/Enum.html#toString--), [valueOf](../../../java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[getClass](../../../java/lang/Object.html#getClass--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Enum Constant Detail

     * #### SOURCE  
     public static final [RetentionPolicy](../../../java/lang/annotation/RetentionPolicy.html "enum in java.lang.annotation") SOURCE  
     Annotations are to be discarded by the compiler.  
     * #### CLASS  
     public static final [RetentionPolicy](../../../java/lang/annotation/RetentionPolicy.html "enum in java.lang.annotation") 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](../../../java/lang/annotation/RetentionPolicy.html "enum in java.lang.annotation") 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](../../../java/lang/reflect/AnnotatedElement.html "interface in java.lang.reflect")  

  • Method Detail

    * #### values  
    public static [RetentionPolicy](../../../java/lang/annotation/RetentionPolicy.html "enum in java.lang.annotation")[] 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](../../../java/lang/annotation/RetentionPolicy.html "enum in java.lang.annotation") valueOf([String](../../../java/lang/String.html "class in java.lang") 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](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if this enum type has no constant with the specified name  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the argument is null

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.