org.onosproject.yang.model

Class InnerNode.Builder

java.lang.Object

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

org.onosproject.yang.model.InnerNode.Builder

Enclosing class:

InnerNode

public static class InnerNode.Builder
extends DataNode.Builder<InnerNode.Builder>

Builder with get and set functions to build inner node, builder will be used both to create inner node from scratch or from a given inner node.

Field Summary

Fields inherited from class org.onosproject.yang.model.DataNode.Builder

appInfo, key, keyBuilder, parent, type

Constructor Summary

Constructors

Modifier	Constructor and Description
	Builder(InnerNode node) Creates an instance of inner node builder.
protected	Builder(String name, String namespace) Creates an instance of data node builder.

Method Summary

Modifier and Type	Method and Description
InnerNode.Builder	addKeyLeaf(String name, String nameSpace, Object val) Add key leaf for list node key.
LeafNode.Builder	addLeafListValue(Object val) Add key value to leaf list key.
InnerNode.Builder	addNode(DataNode node) Adds node to the builder.
InnerNode	build() Builds a inner node object.
Map<NodeKey,DataNode>	childNodes() Returns the children nodes to the current node.
InnerNode.Builder	createChildBuilder(String name, String nameSpace) Creates a child builder of type inner node and set a back reference of parent node.
LeafNode.Builder	createChildBuilder(String name, String nameSpace, Object value) Creates a child build of type leaf node and set a back reference of parent node.
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.
InnerNode.Builder	deleteChild(NodeKey key) Deletes child node for a given node key from parent node.
InnerNode.Builder	getChildBuilder(NodeKey nodeKey) Returns a child node builder for a given node key.

Methods inherited from class org.onosproject.yang.model.DataNode.Builder

appInfo, appInfo, exitNode, key, parent, parent, type

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(String name,
                  String namespace)

Creates an instance of data node builder.

Parameters:

name - name of node

namespace - namespace of node

Builder

public Builder(InnerNode node)

Creates an instance of inner node builder.

Parameters:

node - old inner node

Method Detail

addNode

public InnerNode.Builder addNode(DataNode node)

Adds node to the builder.

Parameters:

node - node to be added

Returns:

inner node builder

childNodes

public Map<NodeKey,DataNode> childNodes()

Returns the children nodes to the current node. Children nodes are identified based on the node key.

Returns:

read only linked map of children nodes

build

public InnerNode build()

Builds a inner node object.

Specified by:

build in class DataNode.Builder<InnerNode.Builder>

Returns:

inner node

createChildBuilder

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

Description copied from class: DataNode.Builder

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

Specified by:

createChildBuilder in class DataNode.Builder<InnerNode.Builder>

Parameters:

name - name of inner node

nameSpace - namespace of inner node

Returns:

child node builder

createChildBuilder

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

Description copied from class: DataNode.Builder

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.

Specified by:

createChildBuilder in class DataNode.Builder<InnerNode.Builder>

Parameters:

name - name of leaf node

nameSpace - namespace of leaf node

value - value for leaf node

Returns:

child node builder

createChildBuilder

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

Description copied from class: DataNode.Builder

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.

Specified by:

createChildBuilder in class DataNode.Builder<InnerNode.Builder>

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 InnerNode.Builder deleteChild(NodeKey key)

Description copied from class: DataNode.Builder

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.

Specified by:

deleteChild in class DataNode.Builder<InnerNode.Builder>

Parameters:

key - node key for child node

Returns:

data node builder

getChildBuilder

public InnerNode.Builder getChildBuilder(NodeKey nodeKey)

Description copied from class: DataNode.Builder

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.

Specified by:

getChildBuilder in class DataNode.Builder<InnerNode.Builder>

Parameters:

nodeKey - data node key

Returns:

child node

addKeyLeaf

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

Description copied from class: DataNode.Builder

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.

Specified by:

addKeyLeaf in class DataNode.Builder<InnerNode.Builder>

Parameters:

name - name of leaf node

nameSpace - namespace of leaf node

val - value of leaf

Returns:

data node builder

addLeafListValue

public LeafNode.Builder addLeafListValue(Object val)

Description copied from class: DataNode.Builder

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

Specified by:

addLeafListValue in class DataNode.Builder<InnerNode.Builder>

Parameters:

val - value

Returns:

data node builder