org.onosproject.store.service

Class ConsistentTreeMapBuilder<V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveBuilder<ConsistentTreeMapBuilder<V>,ConsistentTreeMap<V>>

org.onosproject.store.service.ConsistentTreeMapBuilder<V>

public abstract class ConsistentTreeMapBuilder<V>
extends DistributedPrimitiveBuilder<ConsistentTreeMapBuilder<V>,ConsistentTreeMap<V>>

Builder for ConsistentTreeMap.

Constructor Summary

Constructors

Constructor and Description
ConsistentTreeMapBuilder()

Method Summary

Modifier and Type	Method and Description
abstract AsyncConsistentTreeMap<V>	buildTreeMap() Builds the distributed tree map based on the configuration options supplied to this builder.
boolean	purgeOnUninstall() Return if map entries need to be cleared when owning application is uninstalled.
ConsistentTreeMapBuilder<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

ConsistentTreeMapBuilder

public ConsistentTreeMapBuilder()

Method Detail

withPurgeOnUninstall

public ConsistentTreeMapBuilder<V> withPurgeOnUninstall()

Clears map contents when the owning application is uninstalled.

Returns:

this builder

purgeOnUninstall

public boolean purgeOnUninstall()

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

Returns:

true if items are to be cleared on uninstall

buildTreeMap

public abstract AsyncConsistentTreeMap<V> buildTreeMap()

Builds the distributed tree map based on the configuration options supplied to this builder.

Returns:

new distributed tree map

Throws:

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