org.onosproject.store.service

Class ConsistentMultimapBuilder<K,V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveBuilder<ConsistentMultimapBuilder<K,V>,ConsistentMultimap<K,V>>

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

public abstract class ConsistentMultimapBuilder<K,V>
extends DistributedPrimitiveBuilder<ConsistentMultimapBuilder<K,V>,ConsistentMultimap<K,V>>

A builder class for AsyncConsistentMultimap.

Constructor Summary

Constructors

Constructor and Description
ConsistentMultimapBuilder()

Method Summary

Modifier and Type	Method and Description
abstract AsyncConsistentMultimap<K,V>	buildMultimap() Builds the distributed multimap based on the configuration options supplied to this builder.
boolean	purgeOnUninstall() Returns if multimap entries need to be cleared when owning application is uninstalled.
ConsistentMultimapBuilder<K,V>	withPurgeOnUninstall() Clears multimap 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

ConsistentMultimapBuilder

public ConsistentMultimapBuilder()

Method Detail

withPurgeOnUninstall

public ConsistentMultimapBuilder<K,V> withPurgeOnUninstall()

Clears multimap contents when the owning application is uninstalled.

Returns:

this builder

purgeOnUninstall

public boolean purgeOnUninstall()

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

Returns:

true if items are to be cleared on uninstall

buildMultimap

public abstract AsyncConsistentMultimap<K,V> buildMultimap()

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

Returns:

new distributed multimap

Throws:

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