io.micronaut.microstream.cache

Class MicroStreamCacheConfigurationProperties<K,V>

java.lang.Object

io.micronaut.microstream.cache.MicroStreamCacheConfigurationProperties<K,V>

Type Parameters:

K - Key Type

V - Value Type

All Implemented Interfaces:

io.micronaut.core.naming.Named, io.micronaut.core.util.Toggleable, MicroStreamCacheConfiguration<K,V>

@EachProperty(value="microstream.cache")
public class MicroStreamCacheConfigurationProperties<K,V>
extends java.lang.Object
implements MicroStreamCacheConfiguration<K,V>

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED Whether this cache is enabled by default.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
MicroStreamCacheConfigurationProperties(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Class<K>	getKeyType()
java.lang.String	getName()
java.lang.String	getStorage()
java.lang.Class<V>	getValueType()
boolean	isEnabled()
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.
void	setEnabled(boolean enabled) Whether this cache is enabled.
void	setKeyType(java.lang.Class<K> keyType)
void	setManagementEnabled(java.lang.Boolean managementEnabled) Whether management is enabled on this cache.
void	setReadThrough(java.lang.Boolean 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.
void	setStatisticsEnabled(java.lang.Boolean statisticsEnabled) Whether statistics collection is enabled in this cache.
void	setStorage(java.lang.String storage)
void	setStoreByValue(java.lang.Boolean storeByValue) When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
void	setValueType(java.lang.Class<V> valueType)
void	setWriteThrough(java.lang.Boolean 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.When you set a Storage Manager, "write-through" mode is activated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Whether this cache is enabled by default.

See Also:

Constant Field Values

Constructor Detail

MicroStreamCacheConfigurationProperties

public MicroStreamCacheConfigurationProperties(@Parameter
                                               java.lang.String name)

Method Detail

getKeyType

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

Specified by:

getKeyType in interface MicroStreamCacheConfiguration<K,V>

Returns:

The required type of keys for the Cache.

getValueType

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

Specified by:

getValueType in interface MicroStreamCacheConfiguration<K,V>

Returns:

Determines type of values for the Cache.

getStorage

@Nullable
public java.lang.String getStorage()

Specified by:

getStorage in interface MicroStreamCacheConfiguration<K,V>

Returns:

Name qualifier for Storage Manager.

isReadThrough

@Nullable
public java.lang.Boolean isReadThrough()

Description copied from interface: MicroStreamCacheConfiguration

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.

Specified by:

isReadThrough in interface MicroStreamCacheConfiguration<K,V>

Returns:

Whether to use "read-through" mode

isWriteThrough

@Nullable
public java.lang.Boolean isWriteThrough()

Description copied from interface: MicroStreamCacheConfiguration

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.

Specified by:

isWriteThrough in interface MicroStreamCacheConfiguration<K,V>

Returns:

Whether to use "write-through" mode.

isStoreByValue

@Nullable
public java.lang.Boolean isStoreByValue()

Description copied from interface: MicroStreamCacheConfiguration

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

Specified by:

isStoreByValue in interface MicroStreamCacheConfiguration<K,V>

Returns:

Whether the cache is Story by value.

isStatisticsEnabled

@Nullable
public java.lang.Boolean isStatisticsEnabled()

Description copied from interface: MicroStreamCacheConfiguration

Whether statistics collection is enabled in this cache.

Specified by:

isStatisticsEnabled in interface MicroStreamCacheConfiguration<K,V>

Returns:

Whether statistics collection is enabled in this cache.

isManagementEnabled

@Nullable
public java.lang.Boolean isManagementEnabled()

Description copied from interface: MicroStreamCacheConfiguration

Whether management is enabled on this cache.

Specified by:

isManagementEnabled in interface MicroStreamCacheConfiguration<K,V>

Returns:

Whether management is enabled on this cache.

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named

setKeyType

public void setKeyType(@Nullable
                       java.lang.Class<K> keyType)

Parameters:

keyType - The required type of keys for the Cache.

setValueType

public void setValueType(@Nullable
                         java.lang.Class<V> valueType)

Parameters:

valueType - Determines type of values for the Cache.

setStorage

public void setStorage(@Nullable
                       java.lang.String storage)

Parameters:

storage - Name qualifier for MicroStream Storage Manager

setReadThrough

public void setReadThrough(java.lang.Boolean 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. When you set a Storage Manager, "read-through" mode is activated.

Parameters:

readThrough - Whether to use "read-through" mode

setWriteThrough

public void setWriteThrough(java.lang.Boolean 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.When you set a Storage Manager, "write-through" mode is activated.

Parameters:

writeThrough - Whether to use "write-through" mode.

setStoreByValue

public void setStoreByValue(java.lang.Boolean storeByValue)

When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.

Parameters:

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

setStatisticsEnabled

public void setStatisticsEnabled(java.lang.Boolean statisticsEnabled)

Whether statistics collection is enabled in this cache.

Parameters:

statisticsEnabled - Whether statistics collection is enabled in this cache.

setManagementEnabled

public void setManagementEnabled(java.lang.Boolean managementEnabled)

Whether management is enabled on this cache.

Parameters:

managementEnabled - Whether management is enabled on this cache.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Whether this cache is enabled. Default Value: true

Parameters:

enabled - Whether this cache is enabled.