org.onosproject.store.service

Interface AsyncDocumentTree<V>

Type Parameters:

V - document tree value type

All Superinterfaces:

DistributedPrimitive

@NotThreadSafe
public interface AsyncDocumentTree<V>
extends DistributedPrimitive

A hierarchical document tree data structure.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addListener(DocumentPath path, DocumentTreeListener<V> listener) Registers a listener to be notified when a subtree rooted at the specified path is modified.
default CompletableFuture<Void>	addListener(DocumentTreeListener<V> listener) Registers a listener to be notified when the tree is modified.
CompletableFuture<Boolean>	create(DocumentPath path, V value) Creates a document tree node if one does not exist already.
CompletableFuture<Versioned<V>>	get(DocumentPath path) Returns a value (and version) of the tree node at specified path.
CompletableFuture<Map<String,Versioned<V>>>	getChildren(DocumentPath path) Returns the child values for this node.
CompletableFuture<Void>	removeListener(DocumentTreeListener<V> listener) Unregisters a previously added listener.
CompletableFuture<Versioned<V>>	removeNode(DocumentPath path) Removes the node with the specified path.
CompletableFuture<Boolean>	replace(DocumentPath path, V newValue, long version) Conditionally updates a tree node if the current version matches a specified version.
CompletableFuture<Boolean>	replace(DocumentPath path, V newValue, V currentValue) Conditionally updates a tree node if the current value matches a specified value.
DocumentPath	root() Returns the path to root of the tree.
CompletableFuture<Versioned<V>>	set(DocumentPath path, V value) Creates or updates a document tree node.

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

addStatusChangeListener, applicationId, destroy, name, primitiveType, removeStatusChangeListener, statusChangeListeners

Method Detail

root

DocumentPath root()

Returns the path to root of the tree.

Returns:

path to root of the tree

getChildren

CompletableFuture<Map<String,Versioned<V>>> getChildren(DocumentPath path)

Returns the child values for this node.

Parameters:

path - path to the node

Returns:

future for mapping from a child name to its value

Throws:

NoSuchDocumentPathException - if the path does not point to a valid node

get

CompletableFuture<Versioned<V>> get(DocumentPath path)

Returns a value (and version) of the tree node at specified path.

Parameters:

path - path to node

Returns:

future for node value or null if path does not point to a valid node

set

CompletableFuture<Versioned<V>> set(DocumentPath path,
                                    V value)

Creates or updates a document tree node.

Parameters:

path - path for the node to create or update

value - the non-null value to be associated with the key

Returns:

future for the previous mapping or null if there was no previous mapping. Future will be completed with a NoSuchDocumentPathException if the parent node (for the node to create/update) does not exist

create

CompletableFuture<Boolean> create(DocumentPath path,
                                  V value)

Creates a document tree node if one does not exist already.

Parameters:

path - path for the node to create

value - the non-null value to be associated with the key

Returns:

future that is completed with true if the mapping could be added successfully; false otherwise. Future will be completed with a IllegalDocumentModificationException if the parent node (for the node to create) does not exist

replace

CompletableFuture<Boolean> replace(DocumentPath path,
                                   V newValue,
                                   long version)

Conditionally updates a tree node if the current version matches a specified version.

Parameters:

path - path for the node to create

newValue - the non-null value to be associated with the key

version - current version of the value for update to occur

Returns:

future that is completed with true if the update was made and the tree was modified, false otherwise.

replace

CompletableFuture<Boolean> replace(DocumentPath path,
                                   V newValue,
                                   V currentValue)

Conditionally updates a tree node if the current value matches a specified value.

Parameters:

path - path for the node to create

newValue - the non-null value to be associated with the key

currentValue - current value for update to occur

Returns:

future that is completed with true if the update was made and the tree was modified, false otherwise.

removeNode

CompletableFuture<Versioned<V>> removeNode(DocumentPath path)

Removes the node with the specified path.

Parameters:

path - path for the node to remove

Returns:

future for the previous value. Future will be completed with a IllegalDocumentModificationException if the node to be removed is either the root node or has one or more children. Future will be completed with a NoSuchDocumentPathException if the node to be removed does not exist

addListener

CompletableFuture<Void> addListener(DocumentPath path,
                                    DocumentTreeListener<V> listener)

Registers a listener to be notified when a subtree rooted at the specified path is modified.

Parameters:

path - path to root of subtree to monitor for updates

listener - listener to be notified

Returns:

a future that is completed when the operation completes

removeListener

CompletableFuture<Void> removeListener(DocumentTreeListener<V> listener)

Unregisters a previously added listener.

Parameters:

listener - listener to unregister

Returns:

a future that is completed when the operation completes

addListener

default CompletableFuture<Void> addListener(DocumentTreeListener<V> listener)

Registers a listener to be notified when the tree is modified.

Parameters:

listener - listener to be notified

Returns:

a future that is completed when the operation completes