Module jakarta.persistence
Package jakarta.persistence

Interface Cache

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 Type
    Method
    Description
    boolean
    contains(Class<?> cls, Object primaryKey)
    Whether the cache contains data for the given entity.
    void
    evict(Class<?> cls)
    Remove the data for entities of the specified class (and its subclasses) from the cache.
    void
    evict(Class<?> cls, Object primaryKey)
    Remove the data for the given entity from the cache.
    void
    evictAll()
    Clear the cache.
    <T> T
    unwrap(Class<T> cls)
    Return an object of the specified type to allow access to the provider-specific API.

  • Method Details

    • contains

      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

    • evict

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

    • evict

      void evict(Class<?> cls)
      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

      <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 - 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:
      2.1