Home » JPA » Miscellaneous » CacheRetrieveMode
216 words

javax.persistence.CacheRetrieveMode - JPA enum

javax.persistence
Enum CacheRetrieveMode

java.lang.Object
    java.lang.Enum<javax.persistence.CacheRetrieveMode>
        javax.persistence.CacheRetrieveMode
Implemented Interfaces:
Serializable, Comparable<CacheRetrieveMode>
Used as the value of the javax.persistence.cache.retrieveMode property to specify the behavior when data is retrieved by the find methods and by queries.
Since:
JPA 2.0
Learn how to use CacheRetrieveMode in Chapter 3 of the ObjectDB/JPA manual.
CacheRetrieveMode BYPASS
Bypass the cache: get data directly from the database.
Bypass the cache: get data directly from the database.
Since:
JPA 2.0
CacheRetrieveMode USE
Read entity data from the cache: this is the default behavior.
Read entity data from the cache: this is the default behavior.
Since:
JPA 2.0
CacheRetrieveMode valueOf(String name)

Returns the enum constant of this type with the specified 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.

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

CacheRetrieveMode[] values()

Returns an array containing the constants of this enum type.

Returns an array containing the constants of this enum type.

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

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.