org.onosproject.store.service

Class DocumentTreeBuilder<V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveBuilder<DocumentTreeBuilder<V>,AsyncDocumentTree<V>>

org.onosproject.store.service.DocumentTreeBuilder<V>

public abstract class DocumentTreeBuilder<V>
extends DistributedPrimitiveBuilder<DocumentTreeBuilder<V>,AsyncDocumentTree<V>>

Builder for DocumentTree.

Constructor Summary

Constructors

Constructor and Description
DocumentTreeBuilder()

Method Summary

Modifier and Type	Method and Description
abstract AsyncDocumentTree<V>	buildDocumentTree() Builds the distributed Document tree based on the configuration options supplied to this builder.
Ordering	ordering() Returns the ordering of tree nodes.
boolean	purgeOnUninstall() Return if document tree entries need to be cleared when owning application is uninstalled.
DocumentTreeBuilder<V>	withOrdering(Ordering ordering) Sets the ordering of the tree nodes.
DocumentTreeBuilder<V>	withPurgeOnUninstall() Clears document tree contents when the owning application is uninstalled.

Methods inherited from class org.onosproject.store.primitives.DistributedPrimitiveBuilder

applicationId, build, meteringEnabled, name, partitionsDisabled, readOnly, relaxedReadConsistency, serializer, type, withApplicationId, withMeteringDisabled, withName, withRelaxedReadConsistency, withSerializer, withUpdatesDisabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentTreeBuilder

public DocumentTreeBuilder()

Method Detail

withPurgeOnUninstall

public DocumentTreeBuilder<V> withPurgeOnUninstall()

Clears document tree contents when the owning application is uninstalled.

Returns:

this builder

purgeOnUninstall

public boolean purgeOnUninstall()

Return if document tree entries need to be cleared when owning application is uninstalled.

Returns:

true if items are to be cleared on uninstall

withOrdering

public DocumentTreeBuilder<V> withOrdering(Ordering ordering)

Sets the ordering of the tree nodes.

When AsyncDocumentTree.getChildren(DocumentPath) is called, children will be returned according to the specified sort order.

Parameters:

ordering - ordering of the tree nodes

Returns:

this builder

ordering

public Ordering ordering()

Returns the ordering of tree nodes.

When AsyncDocumentTree.getChildren(DocumentPath) is called, children will be returned according to the specified sort order.

Returns:

the ordering of tree nodes

buildDocumentTree

public abstract AsyncDocumentTree<V> buildDocumentTree()

Builds the distributed Document tree based on the configuration options supplied to this builder.

Returns:

new distributed document tree

Throws:

java.lang.RuntimeException - if a mandatory parameter is missing