org.onosproject.store.service

Interface SetBuilder<E>

Type Parameters:

E - type set elements.

public interface SetBuilder<E>

Builder for distributed set.

Method Summary

Modifier and Type	Method and Description
Set<E>	build() Builds an set based on the configuration options supplied to this builder.
SetBuilder<E>	withName(String name) Sets the name of the set.
SetBuilder<E>	withSerializer(Serializer serializer) Sets a serializer that can be used to serialize the elements add to the set.
SetBuilder<E>	withUpdatesDisabled() Disables set updates.

Method Detail

withName

SetBuilder<E> withName(String name)

Sets the name of the set.

Each set is identified by a unique name.

Note: This is a mandatory parameter.

Parameters:

name - name of the set

Returns:

this SetBuilder

withSerializer

SetBuilder<E> withSerializer(Serializer serializer)

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

Note: This is a mandatory parameter.

Parameters:

serializer - serializer

Returns:

this SetBuilder

withUpdatesDisabled

SetBuilder<E> withUpdatesDisabled()

Disables set updates.

Attempt to update the built set will throw UnsupportedOperationException.

Returns:

this SetBuilder

build

Set<E> build()

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

Returns:

new set

Throws:

RuntimeException - if a mandatory parameter is missing