org.onosproject.store.primitives.resources.impl

Class DefaultDocumentTreeNode<V>

java.lang.Object

org.onosproject.store.primitives.resources.impl.DefaultDocumentTreeNode<V>

All Implemented Interfaces:

DocumentTreeNode<V>

public class DefaultDocumentTreeNode<V>
extends Object
implements DocumentTreeNode<V>

A DocumentTree node.

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentTreeNode(DocumentPath key, V value, long version, DocumentTreeNode<V> parent)

Method Summary

Modifier and Type	Method and Description
Versioned<V>	addChild(String name, V newValue, long newVersion) Adds a new child only if one does not exist with the name.
DocumentTreeNode<V>	child(String name) Returns the child node of this node with the specified relative path name.
Iterator<DocumentTreeNode<V>>	children() Returns the children of this node.
boolean	equals(Object obj)
int	hashCode()
DocumentTreeNode<V>	parent()
DocumentPath	path() Returns the path to this node in a DocumentTree.
boolean	removeChild(String name) Removes a child node.
String	toString()
Versioned<V>	update(V newValue, long newVersion) Updates the node value.
Versioned<V>	value() Returns the value of this node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

hasChildren

Constructor Detail

DefaultDocumentTreeNode

public DefaultDocumentTreeNode(DocumentPath key,
                               V value,
                               long version,
                               DocumentTreeNode<V> parent)

Method Detail

path

public DocumentPath path()

Description copied from interface: DocumentTreeNode

Returns the path to this node in a DocumentTree.

Specified by:

path in interface DocumentTreeNode<V>

Returns:

absolute path

value

public Versioned<V> value()

Description copied from interface: DocumentTreeNode

Returns the value of this node.

Specified by:

value in interface DocumentTreeNode<V>

Returns:

node value (and version)

children

public Iterator<DocumentTreeNode<V>> children()

Description copied from interface: DocumentTreeNode

Returns the children of this node.

Specified by:

children in interface DocumentTreeNode<V>

Returns:

iterator for this node's children

child

public DocumentTreeNode<V> child(String name)

Description copied from interface: DocumentTreeNode

Returns the child node of this node with the specified relative path name.

Specified by:

child in interface DocumentTreeNode<V>

Parameters:

name - relative path name for the child node.

Returns:

child node; this method returns null if no such child exists

parent

public DocumentTreeNode<V> parent()

addChild

public Versioned<V> addChild(String name,
                             V newValue,
                             long newVersion)

Adds a new child only if one does not exist with the name.

Parameters:

name - relative path name of the child node

newValue - new value to set

newVersion - new version to set

Returns:

previous value; can be null if no child currently exists with that relative path name. a non null return value indicates child already exists and no modification occured.

update

public Versioned<V> update(V newValue,
                           long newVersion)

Updates the node value.

Parameters:

newValue - new value to set

newVersion - new version to set

Returns:

previous value

removeChild

public boolean removeChild(String name)

Removes a child node.

Parameters:

name - the name of child node to be removed

Returns:

true if the child set was modified as a result of this call, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object