io.atomix.collections

Class DistributedMap.Options

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

io.atomix.resource.Resource.Options

io.atomix.collections.DistributedMap.Options

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Enclosing class:

DistributedMap<K,V>

public static class DistributedMap.Options
extends io.atomix.resource.Resource.Options

Distributed map options.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Options()
Options(Properties defaults)

Method Summary

Modifier and Type	Method and Description
boolean	isLocalCache() Returns whether local caching is enabled.
DistributedMap.Options	withLocalCache() Enables the local map cache.
DistributedMap.Options	withLocalCache(boolean enableCache) Sets whether to enable local caching.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Options

public Options()

Options

public Options(Properties defaults)

Method Detail

withLocalCache

public DistributedMap.Options withLocalCache()

Enables the local map cache.

When local caching is enabled, the DistributedMap will update a local in-memory map each time a change event is received. The instance will hold the full map in memory and will service all ReadConsistency.LOCAL reads from the local map. Thus, this feature should be used with caution. Do not enable caching on large maps.

Returns:

The map options.

withLocalCache

public DistributedMap.Options withLocalCache(boolean enableCache)

Sets whether to enable local caching.

When local caching is enabled, the DistributedMap will update a local in-memory map each time a change event is received. The instance will hold the full map in memory and will service all ReadConsistency.LOCAL reads from the local map. Thus, this feature should be used with caution. Do not enable caching on large maps.

Parameters:

enableCache - Whether to enable local caching.

Returns:

The map options.

isLocalCache

public boolean isLocalCache()

Returns whether local caching is enabled.

When local caching is enabled, the DistributedMap will update a local in-memory map each time a change event is received.

Returns:

Whether local caching is enabled.