Package com.atlassian.confluence.core.persistence.hibernate

Enum Class CacheMode

java.lang.Object
java.lang.Enum<CacheMode>
com.atlassian.confluence.core.persistence.hibernate.CacheMode
All Implemented Interfaces:
Serializable, Comparable<CacheMode>, Constable
public enum CacheMode extends Enum<CacheMode>
Controls how a session on the current thread interacts with the second-level cache and query cache.
Since:
5.10
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    GET
    The session may read items from the cache, but will not add items, except to invalidate items when updates occur.
    IGNORE
    The session will never interact with the cache, except to invalidate cache items when updates occur.
    NORMAL
    The session may read items from the cache and/or add items to the cache, as configured in Hibernate
    PUT
    The session will never read items from the cache, but will add items to the cache as it reads them from the database.
    REFRESH
    The session will never read items from the cache, but will add items to the cache as it reads them from the database.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.hibernate.CacheMode
    hibernateCacheMode()
     
    static CacheMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CacheMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NORMAL

      public static final CacheMode NORMAL
      The session may read items from the cache and/or add items to the cache, as configured in Hibernate

    • IGNORE

      public static final CacheMode IGNORE
      The session will never interact with the cache, except to invalidate cache items when updates occur.

    • GET

      public static final CacheMode GET
      The session may read items from the cache, but will not add items, except to invalidate items when updates occur.

    • PUT

      public static final CacheMode PUT
      The session will never read items from the cache, but will add items to the cache as it reads them from the database.

    • REFRESH

      public static final CacheMode REFRESH
      The session will never read items from the cache, but will add items to the cache as it reads them from the database. In this mode, the effect of hibernate.cache.use_minimal_puts is bypassed, in order to force a cache refresh.

  • Method Details

    • values

      public static CacheMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CacheMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • hibernateCacheMode

      public org.hibernate.CacheMode hibernateCacheMode()