Module jakarta.persistence

Package jakarta.persistence

Enum Class CacheStoreMode

java.lang.Object

java.lang.Enum<CacheStoreMode>

jakarta.persistence.CacheStoreMode

All Implemented Interfaces:

FindOption, RefreshOption, Serializable, Comparable<CacheStoreMode>, Constable

public enum CacheStoreMode
extends Enum<CacheStoreMode>
implements FindOption, RefreshOption

Specifies how the EntityManager interacts with the second-level cache when data is read from the database and when data is written to the database.

• USE indicates that data may be written to the second-level cache.
• BYPASS indicates that data may not be written to the second-level cache.
• REFRESH indicates that data must be written to the second-level cache, even when the data is already cached.

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

Since:

2.0

See Also:

• EntityManager.setCacheStoreMode(CacheStoreMode)
• Query.setCacheStoreMode(CacheStoreMode)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYPASS	Don't insert into cache.
REFRESH	Insert/update entity data held in the cache when read from the database and when written to the database.
USE	Insert entity data into cache when read from database and insert/update entity data when written to the database: this is the default behavior.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USE

public static final CacheStoreMode USE

Insert entity data into cache when read from database and insert/update entity data when written to the database: this is the default behavior. Does not force refresh of already cached items when reading from database.

BYPASS

public static final CacheStoreMode BYPASS

Don't insert into cache.

REFRESH

public static final CacheStoreMode REFRESH

Insert/update entity data held in the cache when read from the database and when written to the database. Force refresh of cache for items read from database.

Method Details

values

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