- java.lang.Object
-
- java.lang.Enum<CacheRetrieveMode>
-
- jakarta.persistence.CacheRetrieveMode
-
- All Implemented Interfaces:
FindOption
,java.io.Serializable
,java.lang.Comparable<CacheRetrieveMode>
public enum CacheRetrieveMode extends java.lang.Enum<CacheRetrieveMode> implements FindOption
Specifies how theEntityManager
interacts with the second-level cache when data is read from the database via theEntityManager.find(java.lang.Class<T>, java.lang.Object)
methods and execution of queries.USE
indicates that data may be read from the second-level cache.BYPASS
indicates that data may not be read from the second-level cache.
Enumerates legal values of the property
jakarta.persistence.cache.retrieveMode
.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
CacheRetrieveMode()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CacheRetrieveMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CacheRetrieveMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
USE
public static final CacheRetrieveMode USE
Read entity data from the cache: this is the default behavior.
-
BYPASS
public static final CacheRetrieveMode BYPASS
Bypass the cache: get data directly from the database.
-
-
Method Detail
-
values
public static CacheRetrieveMode[] 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 (CacheRetrieveMode c : CacheRetrieveMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CacheRetrieveMode 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
-
-