public interface 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(java.lang.Class<?>, java.lang.Object)
,
which returns false.- Since:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Whether the cache contains data for the given entity.void
Remove the data for entities of the specified class (and its subclasses) from the cache.void
Remove the data for the given entity from the cache.void
evictAll()
Clear the cache.<T> T
Return an object of the specified type to allow access to the provider-specific API.
-
Method Details
-
contains
-
evict
-
evict
Remove the data for entities of the specified class (and its subclasses) from the cache.- Parameters:
cls
- entity class
-
evictAll
void evictAll()Clear the cache. -
unwrap
Return an object of the specified type to allow access to the provider-specific API. If the provider's implementation of theCache
interface does not support the specified class, thePersistenceException
is thrown.- Parameters:
cls
- the class of the object to be returned. This is usually either the underlying class implementingCache
, or an interface it implements.- Returns:
- an instance of the specified type
- Throws:
PersistenceException
- if the provider does not support the given type- Since:
- 2.1
-