org.onosproject.store.service

Interface DistributedSetBuilder<E>

Type Parameters:

E - type set elements.

public interface DistributedSetBuilder<E>

Builder for distributed set.

Method Summary

Modifier and Type	Method and Description
DistributedSet<E>	build() Builds an set based on the configuration options supplied to this builder.
DistributedSetBuilder<E>	withApplicationId(ApplicationId id) Sets the owner applicationId for the set.
DistributedSetBuilder<E>	withMeteringDisabled() Instantiate Metrics service to gather usage and performance metrics.
DistributedSetBuilder<E>	withName(String name) Sets the name of the set.
DistributedSetBuilder<E>	withPartitionsDisabled() Disables distribution of set entries across multiple database partitions.
DistributedSetBuilder<E>	withPurgeOnUninstall() Purges set contents when the application owning the set is uninstalled.
DistributedSetBuilder<E>	withRelaxedReadConsistency() Provides weak consistency for set reads.
DistributedSetBuilder<E>	withSerializer(Serializer serializer) Sets a serializer that can be used to serialize the elements add to the set.
DistributedSetBuilder<E>	withUpdatesDisabled() Disables set updates.

Method Detail

withName

DistributedSetBuilder<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 DistributedSetBuilder

withApplicationId

DistributedSetBuilder<E> withApplicationId(ApplicationId id)

Sets the owner applicationId for the set.

Note: If purgeOnUninstall option is enabled, applicationId must be specified.

Parameters:

id - applicationId owning the set

Returns:

this DistributedSetBuilder

withSerializer

DistributedSetBuilder<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 DistributedSetBuilder

withUpdatesDisabled

DistributedSetBuilder<E> withUpdatesDisabled()

Disables set updates.

Attempt to update the built set will throw UnsupportedOperationException.

Returns:

this DistributedSetBuilder

withRelaxedReadConsistency

DistributedSetBuilder<E> withRelaxedReadConsistency()

Provides weak consistency for set reads.

While this can lead to improved read performance, it can also make the behavior heard to reason. Only turn this on if you know what you are doing. By default reads are strongly consistent.

Returns:

this DistributedSetBuilder

withPartitionsDisabled

DistributedSetBuilder<E> withPartitionsDisabled()

Disables distribution of set entries across multiple database partitions.

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

Disabling partitions is more appropriate when the returned set is used for simple coordination activities and not for long term data persistence.

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

Returns:

this DistributedSetBuilder

withMeteringDisabled

DistributedSetBuilder<E> withMeteringDisabled()

Instantiate Metrics service to gather usage and performance metrics. By default usage information is enabled

Returns:

this DistributedSetBuilder

withPurgeOnUninstall

DistributedSetBuilder<E> withPurgeOnUninstall()

Purges set contents when the application owning the set is uninstalled.

When this option is enabled, the caller must provide a applicationId via the withAppliationId builder method.

By default set contents will NOT be purged when owning application is uninstalled.

Returns:

this DistributedSetBuilder

build

DistributedSet<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