org.onosproject.yang.serializers.json

Class DefaultJsonBuilder

java.lang.Object

org.onosproject.yang.serializers.json.DefaultJsonBuilder

All Implemented Interfaces:

JsonBuilder

public class DefaultJsonBuilder
extends Object
implements JsonBuilder

Represents implementation of interfaces to build and obtain JSON data tree.

Constructor Summary

Constructors

Constructor and Description
DefaultJsonBuilder()
DefaultJsonBuilder(String rootName)

Method Summary

Modifier and Type	Method and Description
void	addNodeBottomHalf(com.fasterxml.jackson.databind.node.JsonNodeType nodeType) Adds the bottom half(a right brace/bracket) of a JSON object/array to the JSON tree.
void	addNodeTopHalf(String nodeName, com.fasterxml.jackson.databind.node.JsonNodeType nodeType) Adds a to half(a left brace/bracket and the field name) of a JSON object/array to the JSON tree.
void	addNodeWithSetTopHalf(String nodeName, Set<String> sets) Adds a child with list of values to JSON data tree.
void	addNodeWithValueTopHalf(String nodeName, String value) Adds a child with value and a comma to the JSON tree.
void	addValueToLeafListNode(String value) Adds value to a leaf list node.
void	finalizeJson(boolean isRootTypeMultiInstance) Finalizes the output JSON and emits the JSON terminating symbol (e.g., the right curly bracket).
com.fasterxml.jackson.databind.node.ObjectNode	getTreeNode() Returns the JSON tree after build operations in the format of string.
String	getTreeString() Returns the JSON tree after build operations in the format of string.
void	initializeJson() Initializes the output JSON and emits the JSON starting symbol (e.g., the left curly bracket).
void	popModuleName() Removes the YANG module name of the JSON subtree that the builder is currently building.
void	pushModuleName(String moduleName) Updates the YANG module name of the JSON subtree that the builder is currently building.
String	subTreeModuleName() Returns the YANG module name of the JSON subtree that the builder is currently building.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJsonBuilder

public DefaultJsonBuilder(String rootName)

DefaultJsonBuilder

public DefaultJsonBuilder()

Method Detail

addNodeTopHalf

public void addNodeTopHalf(String nodeName,
                           com.fasterxml.jackson.databind.node.JsonNodeType nodeType)

Description copied from interface: JsonBuilder

Adds a to half(a left brace/bracket and the field name) of a JSON object/array to the JSON tree. This method is used by protocols which knows the nature (object/array) of node.

Specified by:

addNodeTopHalf in interface JsonBuilder

Parameters:

nodeName - name of child to be added

nodeType - the type of the child

addNodeWithValueTopHalf

public void addNodeWithValueTopHalf(String nodeName,
                                    String value)

Description copied from interface: JsonBuilder

Adds a child with value and a comma to the JSON tree. Protocols unaware of nature of node (single/multiple) will use it to add both single instance and multi instance node. Protocols aware of nature of node will use it for single instance value node addition.

Specified by:

addNodeWithValueTopHalf in interface JsonBuilder

Parameters:

nodeName - name of child to be added

value - value of the child node

addNodeWithSetTopHalf

public void addNodeWithSetTopHalf(String nodeName,
                                  Set<String> sets)

Description copied from interface: JsonBuilder

Adds a child with list of values to JSON data tree. This method is used by protocols which knows the nature (object/array) of node for ArrayNode addition.

Specified by:

addNodeWithSetTopHalf in interface JsonBuilder

Parameters:

nodeName - name of child to be added

sets - the value list of the child

addValueToLeafListNode

public void addValueToLeafListNode(String value)

Description copied from interface: JsonBuilder

Adds value to a leaf list node.

Specified by:

addValueToLeafListNode in interface JsonBuilder

Parameters:

value - value to be added

addNodeBottomHalf

public void addNodeBottomHalf(com.fasterxml.jackson.databind.node.JsonNodeType nodeType)

Description copied from interface: JsonBuilder

Adds the bottom half(a right brace/bracket) of a JSON object/array to the JSON tree. for the text, a comma should be taken out.

Specified by:

addNodeBottomHalf in interface JsonBuilder

Parameters:

nodeType - the type of the child

getTreeString

public String getTreeString()

Description copied from interface: JsonBuilder

Returns the JSON tree after build operations in the format of string.

Specified by:

getTreeString in interface JsonBuilder

Returns:

the final string JSON tree after build operations

getTreeNode

public com.fasterxml.jackson.databind.node.ObjectNode getTreeNode()

Description copied from interface: JsonBuilder

Returns the JSON tree after build operations in the format of string.

Specified by:

getTreeNode in interface JsonBuilder

Returns:

the final ObjectNode JSON tree after build operations

subTreeModuleName

public String subTreeModuleName()

Description copied from interface: JsonBuilder

Returns the YANG module name of the JSON subtree that the builder is currently building. The YANG module name represents the name space of the subtree.

Specified by:

subTreeModuleName in interface JsonBuilder

Returns:

YANG module name

pushModuleName

public void pushModuleName(String moduleName)

Description copied from interface: JsonBuilder

Updates the YANG module name of the JSON subtree that the builder is currently building. The YANG module name represents the name space of the subtree. This function may be called when the builder starts to build a data node.

Specified by:

pushModuleName in interface JsonBuilder

Parameters:

moduleName - YANG module name of the current subtree

popModuleName

public void popModuleName()

Description copied from interface: JsonBuilder

Removes the YANG module name of the JSON subtree that the builder is currently building. This function may be called when the builder finishes building a data node.

Specified by:

popModuleName in interface JsonBuilder

initializeJson

public void initializeJson()

Description copied from interface: JsonBuilder

Initializes the output JSON and emits the JSON starting symbol (e.g., the left curly bracket). This method should be the first method to be called when a JSON building process starts.

Specified by:

initializeJson in interface JsonBuilder

finalizeJson

public void finalizeJson(boolean isRootTypeMultiInstance)

Description copied from interface: JsonBuilder

Finalizes the output JSON and emits the JSON terminating symbol (e.g., the right curly bracket). This method should be the last method to be called when a JSON building process finishes.

Specified by:

finalizeJson in interface JsonBuilder

Parameters:

isRootTypeMultiInstance - true if the root node of the JSON tree has the multi-instance node type