org.onosproject.store.service

Interface AtomicCounterBuilder

public interface AtomicCounterBuilder

Builder for AtomicCounter.

Method Summary

Modifier and Type	Method and Description
AtomicCounter	build() Builds a AtomicCounter based on the configuration options supplied to this builder.
AsyncAtomicCounter	buildAsyncCounter() Builds a AsyncAtomicCounter based on the configuration options supplied to this builder.
AtomicCounterBuilder	withMeteringDisabled() Instantiates Metering service to gather usage and performance metrics.
AtomicCounterBuilder	withName(String name) Sets the name for the atomic counter.
AtomicCounterBuilder	withPartitionsDisabled() Creates this counter on the partition that spans the entire cluster.

Method Detail

withName

AtomicCounterBuilder withName(String name)

Sets the name for the atomic counter.

Each atomic counter is identified by a unique name.

Note: This is a mandatory parameter.

Parameters:

name - name of the atomic counter

Returns:

this AtomicCounterBuilder

withPartitionsDisabled

AtomicCounterBuilder withPartitionsDisabled()

Creates this counter on the partition that spans the entire cluster.

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

Note: By default partitions are enabled.

Returns:

this AtomicCounterBuilder

withMeteringDisabled

AtomicCounterBuilder withMeteringDisabled()

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

Returns:

this AtomicCounterBuilder

build

AtomicCounter build()

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

Returns:

new AtomicCounter

Throws:

RuntimeException - if a mandatory parameter is missing

buildAsyncCounter

AsyncAtomicCounter buildAsyncCounter()

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

Returns:

new AsyncAtomicCounter

Throws:

RuntimeException - if a mandatory parameter is missing