Package org.eclipse.persistence.annotations

Enum CacheKeyType

java.lang.Object
java.lang.Enum<CacheKeyType>
org.eclipse.persistence.annotations.CacheKeyType
All Implemented Interfaces:
Serializable, Comparable<CacheKeyType>
public enum CacheKeyType extends Enum<CacheKeyType>
Configures what type of Id value is used to store the object in the cache. This can either be the basic Id value for simple singleton Ids, or an optimized CacheId type.
See Also:
Author:
James Sutherland

  • Enum Constant Details

    • ID_VALUE

      public static final CacheKeyType ID_VALUE
      This can only be used for simple singleton Ids, such as long/int/String. This is the default for simple singleton Ids.

    • CACHE_ID

      public static final CacheKeyType CACHE_ID
      Optimized cache key type that allows composite and complex values. This is the default for composite or complex Ids.

    • AUTO

      public static final CacheKeyType AUTO
      The cache key type is automatically configured depending on what is optimal for the class.

  • Method Details

    • values

      public static CacheKeyType[] 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

      public static CacheKeyType valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null