org.onosproject.store.service

Class DocumentTreeOptions<O extends DocumentTreeOptions<O,V>,V>

java.lang.Object

org.onosproject.store.primitives.DistributedPrimitiveOptions<O>

org.onosproject.store.service.DocumentTreeOptions<O,V>

Direct Known Subclasses:

DocumentTreeBuilder

public abstract class DocumentTreeOptions<O extends DocumentTreeOptions<O,V>,V>
extends DistributedPrimitiveOptions<O>

Builder for DocumentTree.

Constructor Summary

Constructors

Constructor and Description
DocumentTreeOptions()

Method Summary

Modifier and Type	Method and Description
Ordering	ordering() Returns the ordering of tree nodes.
boolean	purgeOnUninstall() Return if document tree entries need to be cleared when owning application is uninstalled.
O	withOrdering(Ordering ordering) Sets the ordering of the tree nodes.
O	withPurgeOnUninstall() Clears document tree contents when the owning application is uninstalled.

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

applicationId, meteringEnabled, name, partitionsDisabled, readOnly, relaxedReadConsistency, revisionType, serializer, type, version, withApplicationId, withName, withRelaxedReadConsistency, withRevisionType, withSerializer, withUpdatesDisabled, withVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTreeOptions

public DocumentTreeOptions()

Method Detail

withPurgeOnUninstall

public O 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 O 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