Enum Class CacheRetrieveMode

java.lang.Object

java.lang.Enum<CacheRetrieveMode>

jakarta.persistence.CacheRetrieveMode

All Implemented Interfaces:

EntityAgent.CreationOption, EntityAgent.Option, EntityManager.CreationOption, EntityManager.Option, FetchOption, FindOption, TypedQuery.Option, Serializable, Comparable<CacheRetrieveMode>, Constable

public enum CacheRetrieveMode
extends Enum<CacheRetrieveMode>
implements FindOption, FetchOption, TypedQuery.Option, EntityManager.Option, EntityAgent.Option

Specifies how the EntityManager interacts with the second-level cache when data is read from the database via the EntityManager.find(Class, Object, Map) methods and execution of queries.

• USE indicates that data may be read from the second-level cache.
• BYPASS indicates that data must not be read from the second-level cache.

Enumerates legal values of the property jakarta.persistence.cache.retrieveMode.

Since:

2.0

See Also:

• EntityHandler.setCacheRetrieveMode(CacheRetrieveMode)
• TypedQuery.setCacheRetrieveMode(CacheRetrieveMode)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYPASS	Specifies that data must not be read from the second-level cache and must be read from the database.
USE	Specifies that data may be read from the second-level cache instead of from the database.

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USE

public static final CacheRetrieveMode USE

Specifies that data may be read from the second-level cache instead of from the database.

This is the default mode.

BYPASS

public static final CacheRetrieveMode BYPASS

Specifies that data must not be read from the second-level cache and must be read from the database.

API note:

When used as a FetchOption, this value is a hint to the persistence provider, and might be ignored.

Method Details

values

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