Enum Class RetentionPolicy

java.lang.Object
java.lang.Enum<RetentionPolicy>
java.lang.annotation.RetentionPolicy
All Implemented Interfaces:
Serializable, Comparable<RetentionPolicy>, Constable
public enum RetentionPolicy extends Enum<RetentionPolicy>
Annotation retention policy. The constants of this enumerated class describe the various policies for retaining annotations. They are used in conjunction with the Retention meta-annotation interface to specify how long annotations are to be retained.
Since:
1.5

  • Nested Class Summary

    Nested classes/interfaces declared in class Enum

    Enum.EnumDesc<E>
    Modifier and Type
    Class
    Description
    static final class 
    Enum.EnumDesc<E extends Enum<E>>
    A nominal descriptor for an enum constant.

  • 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

    Modifier and Type
    Method
    Description
    static RetentionPolicy
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static RetentionPolicy[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods declared in class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    Modifier and Type
    Method
    Description
    protected final Object
    clone()
    Throws CloneNotSupportedException.
    final int
    compareTo(RetentionPolicy o)
    Compares this enum with the specified object for order.
    final Optional<Enum.EnumDesc<RetentionPolicy>>
    describeConstable()
    Returns an enum descriptor EnumDesc for this instance, if one can be constructed, or an empty Optional if one cannot be.
    final boolean
    equals(Object other)
    Returns true if the specified object is equal to this enum constant.
    protected final void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization has been deprecated for removal.
    final Class<RetentionPolicy>
    getDeclaringClass()
    Returns the Class object corresponding to this enum constant's enum type.
    final int
    hashCode()
    Returns a hash code for this enum constant.
    final String
    name()
    Returns the name of this enum constant, exactly as declared in its enum declaration.
    final int
    ordinal()
    Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
    String
    toString()
    Returns the name of this enum constant, as contained in the declaration.
    static <T extends Enum<T>>
    T
    valueOf(Class<T> enumClass, String name)
    Returns the enum constant of the specified enum class with the specified name.

    Methods declared in class Object

    getClass, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Enum Constant Details

    • SOURCE

      public static final RetentionPolicy SOURCE
      Annotations are to be discarded by the compiler.

    • 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.
      See Also:

  • Method Details

    • values

      public static RetentionPolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RetentionPolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null