Package org.eclipse.persistence.annotations

Enum CacheKeyType

java.lang.Object

java.lang.Enum<CacheKeyType>

org.eclipse.persistence.annotations.CacheKeyType

All Implemented Interfaces:

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

public enum CacheKeyType
extends java.lang.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:

PrimaryKey.cacheKeyType(), ClassDescriptor.setCacheKeyType(CacheKeyType)

Author:

James Sutherland

Since:

EclipseLink 2.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	The cache key type is automatically configured depending on what is optimal for the class.
CACHE_ID	Optimized cache key type that allows composite and complex values.
ID_VALUE	This can only be used for simple singleton Ids, such as long/int/String.

Method Summary

Modifier and Type	Method	Description
static CacheKeyType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CacheKeyType[]	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

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 Detail

values

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

Returns:

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

valueOf

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