org.onosproject.store.service

Interface AtomicValueBuilder<V>

Type Parameters:

V - atomic value type

public interface AtomicValueBuilder<V>

Builder for constructing new AtomicValue instances.

Method Summary

Modifier and Type	Method and Description
AtomicValue<V>	build() Builds a AtomicValue based on the configuration options supplied to this builder.
AtomicValueBuilder<V>	withMeteringDisabled() Instantiates Metering service to gather usage and performance metrics.
AtomicValueBuilder<V>	withName(String name) Sets the name for the atomic value.
AtomicValueBuilder<V>	withPartitionsDisabled() Creates this atomic value on the partition that spans the entire cluster.
AtomicValueBuilder<V>	withSerializer(Serializer serializer) Sets a serializer that can be used to serialize the value.

Method Detail

withName

AtomicValueBuilder<V> withName(String name)

Sets the name for the atomic value.

Each atomic value is identified by a unique name.

Note: This is a mandatory parameter.

Parameters:

name - name of the atomic value

Returns:

this AtomicValueBuilder for method chaining

withSerializer

AtomicValueBuilder<V> withSerializer(Serializer serializer)

Sets a serializer that can be used to serialize the value.

Note: This is a mandatory parameter.

Parameters:

serializer - serializer

Returns:

this AtomicValueBuilder for method chaining

withPartitionsDisabled

AtomicValueBuilder<V> withPartitionsDisabled()

Creates this atomic value on the partition that spans the entire cluster.

When partitioning is disabled, the value state will be ephemeral and does not survive a full cluster restart.

Note: By default partitions are enabled.

Returns:

this AtomicValueBuilder for method chaining

withMeteringDisabled

AtomicValueBuilder<V> withMeteringDisabled()

Instantiates Metering service to gather usage and performance metrics. By default, usage data will be stored.

Returns:

this AtomicValueBuilder for method chaining

build

AtomicValue<V> build()

Builds a AtomicValue based on the configuration options supplied to this builder.

Returns:

new AtomicValue

Throws:

RuntimeException - if a mandatory parameter is missing