- java.lang.Object
-
- java.lang.Enum<CacheStoreMode>
-
- jakarta.persistence.CacheStoreMode
-
- All Implemented Interfaces:
FindOption
,RefreshOption
,java.io.Serializable
,java.lang.Comparable<CacheStoreMode>
public enum CacheStoreMode extends java.lang.Enum<CacheStoreMode> implements FindOption, RefreshOption
Specifies how theEntityManager
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)
-
-
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.
-
Constructor Summary
Constructors Modifier Constructor Description private
CacheStoreMode()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CacheStoreMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CacheStoreMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static CacheStoreMode[] 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 (CacheStoreMode c : CacheStoreMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CacheStoreMode 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 namejava.lang.NullPointerException
- if the argument is null
-
-