org.onosproject.store.service

Interface ConsistentMapBuilder<K,V>

Type Parameters:

K - type for map key

V - type for map value

public interface ConsistentMapBuilder<K,V>

Builder for consistent maps.

Method Summary

Modifier and Type	Method and Description
ConsistentMap<K,V>	build() Builds an consistent map based on the configuration options supplied to this builder.
AsyncConsistentMap<K,V>	buildAsyncMap() Builds an async consistent map based on the configuration options supplied to this builder.
ConsistentMapBuilder<K,V>	withName(String name) Sets the name of the map.
ConsistentMapBuilder<K,V>	withPartitionsDisabled() Disables distribution of map entries across multiple database partitions.
ConsistentMapBuilder<K,V>	withSerializer(Serializer serializer) Sets a serializer that can be used to serialize both the keys and values inserted into the map.
ConsistentMapBuilder<K,V>	withUpdatesDisabled() Disables map updates.

Method Detail

withName

ConsistentMapBuilder<K,V> withName(String name)

Sets the name of the map.

Each consistent map is identified by a unique map name.

Note: This is a mandatory parameter.

Parameters:

name - name of the consistent map

Returns:

this ConsistentMapBuilder

withSerializer

ConsistentMapBuilder<K,V> withSerializer(Serializer serializer)

Sets a serializer that can be used to serialize both the keys and values inserted into the map. The serializer builder should be pre-populated with any classes that will be put into the map.

Note: This is a mandatory parameter.

Parameters:

serializer - serializer

Returns:

this ConsistentMapBuilder

withPartitionsDisabled

ConsistentMapBuilder<K,V> withPartitionsDisabled()

Disables distribution of map entries across multiple database partitions.

When partitioning is disabled, the returned map will have a single partition that spans the entire cluster. Furthermore, the changes made to the map are ephemeral and do not survive a full cluster restart.

Disabling partitions is more appropriate when the returned map is used for coordination activities such as leader election and not for long term data persistence.

Note: By default partitions are enabled and entries in the map are durable.

Returns:

this ConsistentMapBuilder

withUpdatesDisabled

ConsistentMapBuilder<K,V> withUpdatesDisabled()

Disables map updates.

Attempt to update the built map will throw UnsupportedOperationException.

Returns:

this ConsistentMapBuilder

build

ConsistentMap<K,V> build()

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

Returns:

new consistent map

Throws:

RuntimeException - if a mandatory parameter is missing

buildAsyncMap

AsyncConsistentMap<K,V> buildAsyncMap()

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

Returns:

new async consistent map

Throws:

RuntimeException - if a mandatory parameter is missing