Jakarta EE 11.0.0 · jakarta.persistence.Cache · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: boolean indicating whether the entity is in the cache contains(Class<?> entity class cls, Object primary key primaryKey) Whether the cache contains data for the given entity.
public void	evict(Class<?> entity class cls, Object primary key primaryKey) Remove the data for the given entity from the cache.
public void	evict(Class<?> entity class cls) Remove the data for entities of the specified class (and its subclasses) from the cache.
public void	evictAll() Clear the cache.
public <T> T	Returns: an instance of the specified type unwrap(Class<T> the class of the object to be returned. This is usually either the underlying class implementing `Cache`, or an interface it implements. cls) Return an object of the specified type to allow access to the provider-specific API.

Method Detail

contains	back to summary
public boolean contains(Class<?> cls, Object primaryKey) Whether the cache contains data for the given entity. Parameters cls:Class<?> entity class primaryKey:Object primary key Returns:boolean boolean indicating whether the entity is in the cache

contains

back to summary

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

Whether the cache contains data for the given entity.

Parameters

cls:Class<?>: entity class
primaryKey:Object: primary key

Returns:boolean

boolean indicating whether the entity is in the cache

evict	back to summary
public void evict(Class<?> cls, Object primaryKey) Remove the data for the given entity from the cache. Parameters cls:Class<?> entity class primaryKey:Object primary key

evict

back to summary

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

Remove the data for the given entity from the cache.

Parameters

cls:Class<?>: entity class
primaryKey:Object: primary key

evict	back to summary
public void evict(Class<?> cls) Remove the data for entities of the specified class (and its subclasses) from the cache. Parameters cls:Class<?> entity class

evict

back to summary

public void evict(Class<?> cls)

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

Parameters

cls:Class<?>: entity class

evictAll	back to summary
public void evictAll() Clear the cache.

unwrap back to summary

unwrap	back to summary
public <T> 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:Class<T> the class of the object to be returned. This is usually either the underlying class implementing `Cache`, or an interface it implements. Returns:T an instance of the specified type Exceptions PersistenceException: if the provider does not support the given type Since 2.1

public <T> 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:Class<T>: the class of the object to be returned. This is usually either the underlying class implementing Cache, or an interface it implements.

Returns:T

an instance of the specified type

Exceptions

PersistenceException:: if the provider does not support the given type

Since

2.1

public Interface Cache

Method Summary

Method Detail