org.onosproject.store.primitives.impl

Class DefaultDistributedDocumentTree<V>

java.lang.Object

org.onosproject.store.primitives.impl.DefaultDistributedDocumentTree<V>

Type Parameters:

V - tree node value type.

All Implemented Interfaces:

AsyncDocumentTree<V>, DistributedPrimitive

public class DefaultDistributedDocumentTree<V>
extends Object
implements AsyncDocumentTree<V>

Default implementation of AsyncDocumentTree.

This implementation delegates execution to a backing tree implemented on top of Atomix framework.

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 the subtree rooted at the specified path is modified.
CompletableFuture<Boolean>	create(DocumentPath path, V value) Creates a document tree node if one does not exist already.
CompletableFuture<Boolean>	createRecursive(DocumentPath path, V value) Creates a document tree node recursively by creating all missing intermediate nodes in the path.
CompletableFuture<Versioned<V>>	get(DocumentPath path) Returns the value of the tree node at specified path.
CompletableFuture<Map<String,Versioned<V>>>	getChildren(DocumentPath path) Returns the children of node at specified path in the form of a mapping from child name to child value.
String	name() Returns the name of this primitive.
DistributedPrimitive.Type	primitiveType() Returns the type of primitive.
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 node value matches a specified version.
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 class java.lang.Object

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

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

addListener

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

addStatusChangeListener, applicationId, destroy, removeStatusChangeListener, statusChangeListeners

Method Detail

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

primitiveType

public DistributedPrimitive.Type primitiveType()

Description copied from interface: DistributedPrimitive

Returns the type of primitive.

Specified by:

primitiveType in interface DistributedPrimitive

Returns:

primitive type

root

public DocumentPath root()

Description copied from interface: AsyncDocumentTree

Returns the path to root of the tree.

Specified by:

root in interface AsyncDocumentTree<V>

Returns:

path to root of the tree

getChildren

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

Description copied from interface: AsyncDocumentTree

Returns the children of node at specified path in the form of a mapping from child name to child value.

Specified by:

getChildren in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

Returns:

future for mapping from child name to child value

get

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

Description copied from interface: AsyncDocumentTree

Returns the value of the tree node at specified path.

Specified by:

get in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

Returns:

future that will be either be completed with node's versioned value or null if path does not point to a valid node

set

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

Description copied from interface: AsyncDocumentTree

Creates or updates a document tree node.

Specified by:

set in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

value - value to be associated with the node (null is a valid value)

Returns:

future that will either be completed with the previous versioned value or null if there was no node previously at that path. Future will be completed with a IllegalDocumentModificationException if the parent node (for the node to create/update) does not exist

create

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

Description copied from interface: AsyncDocumentTree

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

Specified by:

create in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

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

Returns:

future that is completed with true if the new node was successfully created. Future will be completed with false if a node already exists at the specified path. Future will be completed exceptionally with a IllegalDocumentModificationException if the parent node (for the node to create) does not exist

createRecursive

public CompletableFuture<Boolean> createRecursive(DocumentPath path,
                                                  V value)

Description copied from interface: AsyncDocumentTree

Creates a document tree node recursively by creating all missing intermediate nodes in the path.

Specified by:

createRecursive in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

value - value to be associated with the node (null is a valid value)

Returns:

future that is completed with true if the new node was successfully created. Future will be completed with false if a node already exists at the specified path

replace

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

Description copied from interface: AsyncDocumentTree

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

Specified by:

replace in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

newValue - value to associate with the node (null is a valid value)

version - current version of the node for update to occur

Returns:

future that is either completed with true if the update was made or false if update did not happen

replace

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

Description copied from interface: AsyncDocumentTree

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

Specified by:

replace in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

newValue - value to associate with the node (null is a valid value)

currentValue - current value of the node for update to occur

Returns:

future that is either completed with true if the update was made or false if update did not happen

removeNode

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

Description copied from interface: AsyncDocumentTree

Removes the node with the specified path.

Specified by:

removeNode in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

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

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

Description copied from interface: AsyncDocumentTree

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

Specified by:

addListener in interface AsyncDocumentTree<V>

Parameters:

path - path to the node

listener - listener to be notified

Returns:

a future that is completed when the operation completes

removeListener

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

Description copied from interface: AsyncDocumentTree

Unregisters a previously added listener.

Specified by:

removeListener in interface AsyncDocumentTree<V>

Parameters:

listener - listener to unregister

Returns:

a future that is completed when the operation completes