org.onosproject.store.service

Class ConsistentMapBuilder<K,V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveBuilder<ConsistentMapBuilder<K,V>,ConsistentMap<K,V>>

org.onosproject.store.service.ConsistentMapBuilder<K,V>

Type Parameters:

K - type for map key

V - type for map value

public abstract class ConsistentMapBuilder<K,V>
extends DistributedPrimitiveBuilder<ConsistentMapBuilder<K,V>,ConsistentMap<K,V>>

Builder for ConsistentMap instances.

Constructor Summary

Constructors

Constructor and Description
ConsistentMapBuilder()

Method Summary

Modifier and Type	Method and Description
abstract AsyncConsistentMap<K,V>	buildAsyncMap() Builds an async consistent map based on the configuration options supplied to this builder.
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.
ConsistentMapBuilder<K,V>	withNullValues() Enables null values in the map.
ConsistentMapBuilder<K,V>	withPurgeOnUninstall() Clears map contents when the owning application is uninstalled.

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

applicationId, build, meteringEnabled, name, partitionsDisabled, readOnly, relaxedReadConsistency, serializer, type, withApplicationId, withMeteringDisabled, withName, withRelaxedReadConsistency, withSerializer, withUpdatesDisabled

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsistentMapBuilder

public ConsistentMapBuilder()

Method Detail

withNullValues

public ConsistentMapBuilder<K,V> withNullValues()

Enables null values in the map.

Returns:

this builder

withPurgeOnUninstall

public ConsistentMapBuilder<K,V> withPurgeOnUninstall()

Clears map contents when the owning application is uninstalled.

Returns:

this 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.

buildAsyncMap

public abstract AsyncConsistentMap<K,V> buildAsyncMap()

Builds an async consistent map based on the configuration options supplied to this builder.

Returns:

new async consistent map

Throws:

java.lang.RuntimeException - if a mandatory parameter is missing