org.onosproject.store.service

Class ConsistentMapOptions<O extends ConsistentMapOptions<O,K,V>,K,V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveOptions<O>

org.onosproject.store.service.ConsistentMapOptions<O,K,V>

Type Parameters:

K - type for map key

V - type for map value

Direct Known Subclasses:

ConsistentMapBuilder

public abstract class ConsistentMapOptions<O extends ConsistentMapOptions<O,K,V>,K,V>
extends DistributedPrimitiveOptions<O>

Builder for ConsistentMap instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected BiFunction<V,Version,V>	compatibilityFunction

Constructor Summary

Constructors

Constructor and Description
ConsistentMapOptions()

Method Summary

Modifier and Type	Method and Description
boolean	nullValues() Returns whether null values are supported by the map.
boolean	purgeOnUninstall() Returns if map entries need to be cleared when owning application is uninstalled.
O	withCompatibilityFunction(BiFunction<V,Version,V> compatibilityFunction) Sets a compatibility function on the map.
O	withNullValues() Enables null values in the map.
O	withPurgeOnUninstall() Clears map contents when the owning application is uninstalled.

Methods inherited from class org.onosproject.store.primitives.DistributedPrimitiveOptions

applicationId, meteringEnabled, name, partitionsDisabled, readOnly, relaxedReadConsistency, revisionType, serializer, type, version, withApplicationId, withMeteringDisabled, withName, withRelaxedReadConsistency, withRevisionType, withSerializer, withUpdatesDisabled, withVersion

Methods inherited from class java.lang.Object

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

Field Detail

compatibilityFunction

protected BiFunction<V,Version,V> compatibilityFunction

Constructor Detail

ConsistentMapOptions

public ConsistentMapOptions()

Method Detail

withNullValues

public O withNullValues()

Enables null values in the map.

Returns:

this builder

withPurgeOnUninstall

public O withPurgeOnUninstall()

Clears map contents when the owning application is uninstalled.

Returns:

this builder

withCompatibilityFunction

public O withCompatibilityFunction(BiFunction<V,Version,V> compatibilityFunction)

Sets a compatibility function on the map.

Parameters:

compatibilityFunction - the compatibility function

Returns:

the consistent map builder

nullValues

public boolean nullValues()

Returns whether null values are supported by the map.

Returns:

true if null values are supported; false otherwise

purgeOnUninstall

public boolean purgeOnUninstall()

Returns if map entries need to be cleared when owning application is uninstalled.

Returns:

true if yes; false otherwise.