Package one.microstream.integrations.cdi.types.cache

Enum CacheProperties

java.lang.Object
java.lang.Enum<CacheProperties>
one.microstream.integrations.cdi.types.cache.CacheProperties
All Implemented Interfaces:
Serializable, Comparable<CacheProperties>, java.lang.constant.Constable, Supplier<String>
public enum CacheProperties
extends Enum<CacheProperties>
implements Supplier<String>
The relation with the properties from Microstream docs: https://docs.microstream.one/manual/cache/configuration/properties.html

  • 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
    CACHE_EXPIRES_FACTORY
    expiryPolicyFactory - Determines when cache entries will expire based on creation, access and modification operations.
    CACHE_LOADER_FACTORY
    cacheLoaderFactory - A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs.
    CACHE_MANAGEMENT
    managementEnabled - Checks whether management is enabled on this cache.
    CACHE_READ_THROUGH
    readThrough - When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked.
    CACHE_STATISTICS
    statisticsEnabled - Checks whether statistics collection is enabled in this cache.
    CACHE_STORE_VALUE
    storeByValue - When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
    CACHE_WRITE_THROUGH
    writeThrough - When in "write-through" mode, cache updates that occur as a result of performing "put" operations will appropriately cause the configured CacheWriter to be invoked.
    CACHE_WRITER_FACTORY
    cacheWriterFactory - A CacheWriter is used for write-through to an external resource.
    PREFIX  
    STORAGE
    MicroStream’s storage can be used as a backing store for the cache.

  • Method Summary

    Modifier and Type Method Description
    String get()  
    static CacheProperties valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static CacheProperties[] values()
    Returns an array containing the constants of this enum type, 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

    • PREFIX

      public static final CacheProperties PREFIX

    • CACHE_LOADER_FACTORY

      public static final CacheProperties CACHE_LOADER_FACTORY
      cacheLoaderFactory - A CacheLoader should be configured for "Read Through" caches to load values when a cache miss occurs.

    • CACHE_WRITER_FACTORY

      public static final CacheProperties CACHE_WRITER_FACTORY
      cacheWriterFactory - A CacheWriter is used for write-through to an external resource.

    • CACHE_EXPIRES_FACTORY

      public static final CacheProperties CACHE_EXPIRES_FACTORY
      expiryPolicyFactory - Determines when cache entries will expire based on creation, access and modification operations.

    • CACHE_READ_THROUGH

      public static final CacheProperties CACHE_READ_THROUGH
      readThrough - When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked.

    • CACHE_WRITE_THROUGH

      public static final CacheProperties CACHE_WRITE_THROUGH
      writeThrough - When in "write-through" mode, cache updates that occur as a result of performing "put" operations will appropriately cause the configured CacheWriter to be invoked.

    • CACHE_STORE_VALUE

      public static final CacheProperties CACHE_STORE_VALUE
      storeByValue - When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

    • CACHE_STATISTICS

      public static final CacheProperties CACHE_STATISTICS
      statisticsEnabled - Checks whether statistics collection is enabled in this cache.

    • CACHE_MANAGEMENT

      public static final CacheProperties CACHE_MANAGEMENT
      managementEnabled - Checks whether management is enabled on this cache.

    • STORAGE

      public static final CacheProperties STORAGE
      MicroStream’s storage can be used as a backing store for the cache. It functions as a CacheWriter as well as a CacheReader, depending on the writeThrough and readThrough configuration. Per default it is used for both.

  • Method Details

    • values

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

    • valueOf

      public static CacheProperties valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null

    • get

      public String get()
      Specified by:
      get in interface Supplier<String>