public abstract class DocumentTreeBuilder<V> extends DistributedPrimitiveBuilder<DocumentTreeBuilder<V>,AsyncDocumentTree<V>>
DocumentTree
.Constructor and Description |
---|
DocumentTreeBuilder() |
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.
|
applicationId, build, meteringEnabled, name, partitionsDisabled, readOnly, relaxedReadConsistency, serializer, type, withApplicationId, withMeteringDisabled, withName, withRelaxedReadConsistency, withSerializer, withUpdatesDisabled
public DocumentTreeBuilder<V> withPurgeOnUninstall()
public boolean purgeOnUninstall()
public DocumentTreeBuilder<V> withOrdering(Ordering ordering)
When AsyncDocumentTree.getChildren(DocumentPath)
is called, children will be returned according to
the specified sort order.
ordering
- ordering of the tree nodespublic Ordering ordering()
When AsyncDocumentTree.getChildren(DocumentPath)
is called, children will be returned according to
the specified sort order.
public abstract AsyncDocumentTree<V> buildDocumentTree()
java.lang.RuntimeException
- if a mandatory parameter is missing