org.onosproject.yang.model

Class DataNode.Builder<B extends DataNode.Builder<B>>

java.lang.Object

org.onosproject.yang.model.DataNode.Builder<B>

Type Parameters:

B - type of data node builder

Direct Known Subclasses:

InnerNode.Builder, LeafNode.Builder

Enclosing class:

DataNode

public abstract static class DataNode.Builder<B extends DataNode.Builder<B>>
extends Object

Represents the implementation of data node builder class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	appInfo Application related information, this enables application to use this builder as there work bench.
protected NodeKey	key Identifies a node uniquely among its siblings.
protected NodeKey.NodeKeyBuilder	keyBuilder Node key builder.
protected InnerNode.Builder	parent Parent data node.
protected DataNode.Type	type Type of node in data store.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder() Creates an instance of data node builder.
protected	Builder(DataNode node) Creates an instance of data node builder using old data node.

Method Summary

Modifier and Type	Method and Description
abstract InnerNode.Builder	addKeyLeaf(String name, String nameSpace, Object val) Add key leaf for list node key.
abstract LeafNode.Builder	addLeafListValue(Object val) Add key value to leaf list key.
Object	appInfo() Returns application information.
B	appInfo(Object appInfo) Sets application information.
abstract DataNode	build() Builds data node.
abstract InnerNode.Builder	createChildBuilder(String name, String nameSpace) Creates a child builder of type inner node and set a back reference of parent node.
abstract LeafNode.Builder	createChildBuilder(String name, String nameSpace, Object value) Deprecated.
abstract LeafNode.Builder	createChildBuilder(String name, String nameSpace, Object value, String valNamespace) Creates a child build of type leaf node and set a back reference of parent node.
abstract InnerNode.Builder	deleteChild(NodeKey key) Deletes child node for a given node key from parent node.
InnerNode.Builder	exitNode() Returns parent node builder after building and adding the child node to parent's child node map.
abstract InnerNode.Builder	getChildBuilder(NodeKey key) Returns a child node builder for a given node key.
B	key(NodeKey key) Sets node key in builder object.
B	parent() Returns parent node.
B	parent(InnerNode.Builder node) Sets parent node's builder.
B	type(DataNode.Type type) Sets node type in builder object.

Methods inherited from class java.lang.Object

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

Field Detail

type

protected DataNode.Type type

Type of node in data store.

key

protected NodeKey key

Identifies a node uniquely among its siblings.

keyBuilder

protected NodeKey.NodeKeyBuilder keyBuilder

Node key builder.

appInfo

protected Object appInfo

Application related information, this enables application to use this builder as there work bench.

parent

protected InnerNode.Builder parent

Parent data node.

Constructor Detail

Builder

protected Builder()

Creates an instance of data node builder.

Builder

protected Builder(DataNode node)

Creates an instance of data node builder using old data node.

Parameters:

node - data node which

Method Detail

key

public B key(NodeKey key)

Sets node key in builder object. when serializers have an instance of key present with them they can directly set the key value using this method.

Parameters:

key - node key identifier

Returns:

data node builder object

parent

public B parent(InnerNode.Builder node)

Sets parent node's builder.

Parameters:

node - parent node builder

Returns:

builder object

parent

public B parent()

Returns parent node.

Returns:

parent node

type

public B type(DataNode.Type type)

Sets node type in builder object.

Parameters:

type - node type

Returns:

data node builder

createChildBuilder

public abstract InnerNode.Builder createChildBuilder(String name,
                                                     String nameSpace)

Creates a child builder of type inner node and set a back reference of parent node. it is used while creating a data tree.

Parameters:

name - name of inner node

nameSpace - namespace of inner node

Returns:

child node builder

createChildBuilder

@Deprecated
public abstract LeafNode.Builder createChildBuilder(String name,
                                                                String nameSpace,
                                                                Object value)

Deprecated.

Creates a child build of type leaf node and set a back reference of parent node. it is used while creating a data tree. the value of leaf is set while creation.

Parameters:

name - name of leaf node

nameSpace - namespace of leaf node

value - value for leaf node

Returns:

child node builder

createChildBuilder

public abstract LeafNode.Builder createChildBuilder(String name,
                                                    String nameSpace,
                                                    Object value,
                                                    String valNamespace)

Creates a child build of type leaf node and set a back reference of parent node. it is used while creating a data tree. the value of leaf is set while creation.

Parameters:

name - name of leaf node

nameSpace - namespace of leaf node

value - value for leaf node

valNamespace - leaf value namespace

Returns:

child node builder

deleteChild

public abstract InnerNode.Builder deleteChild(NodeKey key)

Deletes child node for a given node key from parent node.

for deleting a node from data tree , caller should parse resource identifier to reach to the child node. while parsing the resource identifier caller need to create a new data node using copy builder. this copy builder can be used further to create child nodes copy builders.

Parameters:

key - node key for child node

Returns:

data node builder

getChildBuilder

public abstract InnerNode.Builder getChildBuilder(NodeKey key)

Returns a child node builder for a given node key. it contains all the attribute of child node. it is used to modify the data tree while delete or update operations.

this method provides copy builder of child node when a update/delete request comes. it sets a back reference of parent node as well in child node's copy builder.

Parameters:

key - data node key

Returns:

child node

addKeyLeaf

public abstract InnerNode.Builder addKeyLeaf(String name,
                                             String nameSpace,
                                             Object val)

Add key leaf for list node key. It can be used while handling a list node when in your yang file you have multiple key leaves.

this method is used for adding multiple key leaves in you list node. these keys will be added to key builder which is built while while node building. To use this method caller should know about schema of list and key leaves.

Parameters:

name - name of leaf node

nameSpace - namespace of leaf node

val - value of leaf

Returns:

data node builder

addLeafListValue

public abstract LeafNode.Builder addLeafListValue(Object val)

Add key value to leaf list key. this can be used while handling a leaf list where you need to add multiple values.

Parameters:

val - value

Returns:

data node builder

build

public abstract DataNode build()

Builds data node.

Returns:

data node

exitNode

public InnerNode.Builder exitNode()

Returns parent node builder after building and adding the child node to parent's child node map.

This method is used when caller has reached to the depth of the subtree and then he wants to go back to its parent node so he should build the node and then it should add it to parent node's map. this method provides both the functionalities of build and add to parent . Also it returns back the parent pointer so caller can do further operations on data tree.

Returns:

parent's builder object

appInfo

public Object appInfo()

Returns application information. This enables application to use this builder as there work bench.

Returns:

application information

appInfo

public B appInfo(Object appInfo)

Sets application information. This enables application to use this builder as there work bench.

Parameters:

appInfo - application related information

Returns:

builder object