Home » JPA » Miscellaneous » CacheStoreMode
280 words

javax.persistence.CacheStoreMode - JPA enum

javax.persistence
Enum CacheStoreMode

java.lang.Object
    java.lang.Enum<javax.persistence.CacheStoreMode>
        javax.persistence.CacheStoreMode
Implemented Interfaces:
Serializable, Comparable<CacheStoreMode>
Used as the value of the javax.persistence.cache.storeMode property to specify the behavior when data is read from the database and when data is committed into the database.
Since:
JPA 2.0
Learn how to use CacheStoreMode in Chapter 3 of the ObjectDB/JPA manual.
CacheStoreMode BYPASS
Don't insert into cache.
Don't insert into cache.
Since:
JPA 2.0
CacheStoreMode REFRESH
Insert/update entity data into cache when read from database and when committed into database.
Insert/update entity data into cache when read from database and when committed into database. Forces refresh of cache for items read from database.
Since:
JPA 2.0
CacheStoreMode USE
Insert/update entity data into cache when read from database and when committed into database: this is the default behavior.
Insert/update entity data into cache when read from database and when committed into database: this is the default behavior. Does not force refresh of already cached items when reading from database.
Since:
JPA 2.0
CacheStoreMode 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

CacheStoreMode[] 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 (CacheStoreMode c : CacheStoreMode.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.