Jakarta Persistence (JPA) Interface

jakarta.persistence.Cache

Interface used to interact with the second-level cache. If no second-level cache is in use, the methods of this interface have no effect, except for contains, which returns false.

Since:: Jakarta Persistence (JPA) 2.0

The Shared (L2) Entity Cache article explains how to use Cache.

Public Instance Methods

boolean contains(Class<?> cls, Object primaryKey)

Whether the cache contains data for the given entity.

Parameters:: cls - entity class; primaryKey - primary key

Returns:: boolean indicating whether the entity is in the cache.

Since:: Jakarta Persistence (JPA) 1.0

void evict(Class<?> cls, Object primaryKey)

Remove the data for the given entity from the cache.

Parameters:: cls - entity class; primaryKey - primary key

Since:: Jakarta Persistence (JPA) 1.0

void evict(Class<?> cls)

Remove the data for entities of the specified class (and its subclasses) from the cache.

Parameters:: cls - entity class

Since:: Jakarta Persistence (JPA) 1.0

void evictAll()

Clear the cache.

Since:: Jakarta Persistence (JPA) 1.0

T unwrap(Class<T> cls)

Return an object of the specified type to allow access to the provider-specific API.

If the provider's implementation of the Cache interface does not support the specified class, the PersistenceException is thrown.

Parameters:: cls - the class of the object to be returned. This is usually either the underlying class implementing Cache, or an interface it implements.

Returns:: an instance of the specified type.

Throws:: PersistenceException - if the provider does not support the given type.

Since:: Jakarta Persistence (JPA) 2.1