Package io.micronaut.microstream.cache

Interface MicroStreamCacheConfiguration<K,V>

Type Parameters:
K - Key Type
V - Value Type
All Superinterfaces:
io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable
All Known Implementing Classes:
MicroStreamCacheConfigurationProperties
public interface MicroStreamCacheConfiguration<K,V> extends io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable
MicroStream Cache Configuration.
Since:
1.0.0
Author:
Sergio del Amo

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull Class<K>
    getKeyType()
     
    @Nullable String
    getStorage()
     
    @NonNull Class<V>
    getValueType()
     
    @Nullable Boolean
    isManagementEnabled()
    Whether management is enabled on this cache.
    @Nullable Boolean
    isReadThrough()
    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.
    @Nullable Boolean
    isStatisticsEnabled()
    Whether statistics collection is enabled in this cache.
    @Nullable Boolean
    isStoreByValue()
    When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
    @Nullable Boolean
    isWriteThrough()
    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.

    Methods inherited from interface io.micronaut.core.naming.Named

    getName

    Methods inherited from interface io.micronaut.core.util.Toggleable

    isEnabled

  • Method Details

    • getKeyType

      @NonNull @NonNull Class<K> getKeyType()
      Returns:
      The required type of keys for the Cache.

    • getValueType

      @NonNull @NonNull Class<V> getValueType()
      Returns:
      Determines type of values for the Cache.

    • getStorage

      @Nullable @Nullable String getStorage()
      Returns:
      Name qualifier for Storage Manager.

    • isReadThrough

      @Nullable @Nullable Boolean isReadThrough()
      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.
      Returns:
      Whether to use "read-through" mode

    • isWriteThrough

      @Nullable @Nullable Boolean isWriteThrough()
      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.
      Returns:
      Whether to use "write-through" mode.

    • isStoreByValue

      @Nullable @Nullable Boolean isStoreByValue()
      When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
      Returns:
      Whether the cache is Story by value.

    • isStatisticsEnabled

      @Nullable @Nullable Boolean isStatisticsEnabled()
      Whether statistics collection is enabled in this cache.
      Returns:
      Whether statistics collection is enabled in this cache.

    • isManagementEnabled

      @Nullable @Nullable Boolean isManagementEnabled()
      Whether management is enabled on this cache.
      Returns:
      Whether management is enabled on this cache.