org.onosproject.yang.serializers.json

Interface JsonBuilder

All Known Implementing Classes:

DefaultJsonBuilder

public interface JsonBuilder

Abstraction of an entity which provides interfaces to build and obtain JSON data tree.

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, String valNamespace, org.onosproject.yang.model.LeafType type) Adds a child with value and a comma to the JSON tree.
void	addValueToLeafListNode(String value, String valNamespace, org.onosproject.yang.model.LeafType type) 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.

Method Detail

addNodeTopHalf

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. This method is used by protocols which knows the nature (object/array) of node.

Parameters:

nodeName - name of child to be added

nodeType - the type of the child

addNodeWithValueTopHalf

void addNodeWithValueTopHalf(String nodeName,
                             String value,
                             String valNamespace,
                             org.onosproject.yang.model.LeafType type)

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.

Parameters:

nodeName - name of child to be added

value - value of the child node

valNamespace - value namespace

type - leaf value type

addNodeWithSetTopHalf

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

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.

Parameters:

nodeName - name of child to be added

sets - the value list of the child

addValueToLeafListNode

void addValueToLeafListNode(String value,
                            String valNamespace,
                            org.onosproject.yang.model.LeafType type)

Adds value to a leaf list node.

Parameters:

value - value to be added

valNamespace - value namespace

type - leaf-list value type

addNodeBottomHalf

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. for the text, a comma should be taken out.

Parameters:

nodeType - the type of the child

getTreeString

String getTreeString()

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

Returns:

the final string JSON tree after build operations

getTreeNode

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

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

Returns:

the final ObjectNode JSON tree after build operations

subTreeModuleName

String subTreeModuleName()

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.

Returns:

YANG module name

pushModuleName

void pushModuleName(String moduleName)

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.

Parameters:

moduleName - YANG module name of the current subtree

popModuleName

void popModuleName()

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.

initializeJson

void initializeJson()

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.

finalizeJson

void finalizeJson(boolean isRootTypeMultiInstance)

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.

Parameters:

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