org.onosproject.store.service

Interface DistributedQueueBuilder<E>

Type Parameters:

E - type queue elements.

public interface DistributedQueueBuilder<E>

Builder for distributed queue.

Method Summary

Modifier and Type	Method and Description
DistributedQueue<E>	build() Builds a queue based on the configuration options supplied to this builder.
DistributedQueueBuilder<E>	withMeteringDisabled()
DistributedQueueBuilder<E>	withName(String name) Sets the name of the queue.
DistributedQueueBuilder<E>	withPersistenceDisabled() Disables persistence of queues entries.
DistributedQueueBuilder<E>	withSerializer(Serializer serializer) Sets a serializer that can be used to serialize the elements pushed into the queue.

Method Detail

withName

DistributedQueueBuilder<E> withName(String name)

Sets the name of the queue.

Each queue is identified by a unique name.

Note: This is a mandatory parameter.

Parameters:

name - name of the queue

Returns:

this DistributedQueueBuilder for method chaining

withSerializer

DistributedQueueBuilder<E> withSerializer(Serializer serializer)

Sets a serializer that can be used to serialize the elements pushed into the queue. The serializer builder should be pre-populated with any classes that will be put into the queue.

Note: This is a mandatory parameter.

Parameters:

serializer - serializer

Returns:

this DistributedQueueBuilder for method chaining

withMeteringDisabled

DistributedQueueBuilder<E> withMeteringDisabled()

Returns:

this DistributedQueueBuilder for method chaining

withPersistenceDisabled

DistributedQueueBuilder<E> withPersistenceDisabled()

Disables persistence of queues entries.

When persistence is disabled, a full cluster restart will wipe out all queue entries.

Returns:

this DistributedQueueBuilder for method chaining

build

DistributedQueue<E> build()

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

Returns:

new distributed queue

Throws:

RuntimeException - if a mandatory parameter is missing