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 and Description
java.lang.Class<K>	getKeyType()
java.lang.String	getStorage()
java.lang.Class<V>	getValueType()
java.lang.Boolean	isManagementEnabled() Whether management is enabled on this cache.
java.lang.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.
java.lang.Boolean	isStatisticsEnabled() Whether statistics collection is enabled in this cache.
java.lang.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.
java.lang.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 Detail

getKeyType

@NonNull
java.lang.Class<K> getKeyType()

Returns:

The required type of keys for the Cache.

getValueType

@NonNull
java.lang.Class<V> getValueType()

Returns:

Determines type of values for the Cache.

getStorage

@Nullable
java.lang.String getStorage()

Returns:

Name qualifier for Storage Manager.

isReadThrough

@Nullable
java.lang.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
java.lang.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
java.lang.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
java.lang.Boolean isStatisticsEnabled()

Whether statistics collection is enabled in this cache.

Returns:

Whether statistics collection is enabled in this cache.

isManagementEnabled

@Nullable
java.lang.Boolean isManagementEnabled()

Whether management is enabled on this cache.

Returns:

Whether management is enabled on this cache.