org.onosproject.yang.runtime

Class SerializerHelper

java.lang.Object

org.onosproject.yang.runtime.SerializerHelper

public final class SerializerHelper
extends Object

Representation of serializer helper utilities, serializer can use them to build the data node and resource identifier without obtaining the schema context.

Method Summary

Modifier and Type	Method and Description
static org.onosproject.yang.model.DataNode.Builder	addDataNode(org.onosproject.yang.model.DataNode.Builder builder, String name, String namespace, String value, org.onosproject.yang.model.DataNode.Type type) Adds a data node to a given data node builder.
static org.onosproject.yang.model.DataNode.Builder	addDataNode(org.onosproject.yang.model.DataNode.Builder builder, String name, String namespace, String value, String valNamespace, org.onosproject.yang.model.DataNode.Type type) Adds a data node to a given data node builder.
static org.onosproject.yang.model.ResourceId.Builder	addToResourceId(org.onosproject.yang.model.ResourceId.Builder builder, String name, String namespace, List<String> value) Adds to resource identifier builder, this API will be used by applications which are not aware about the schema name association with key's value.
static org.onosproject.yang.model.ResourceId.Builder	addToResourceId(org.onosproject.yang.model.ResourceId.Builder builder, String name, String namespace, String value) Adds to resource identifier builder.
static String	errorMsg(String fmt, Object... params) Returns the error string by filling the parameters in the given formatted error string.
static org.onosproject.yang.model.DataNode.Builder	exitDataNode(org.onosproject.yang.model.DataNode.Builder builder) Exits a given data node builder.
static org.onosproject.yang.model.SchemaContext	getChildSchemaContext(org.onosproject.yang.model.SchemaContext context, String name, String namespace) Returns child schema context for request name and namespace from given resourceId builder.
static String	getModuleNameFromNameSpace(YangSerializerContext c, String ns) Returns the yang module name for given namespace.
static org.onosproject.yang.model.ResourceId	getResourceId(org.onosproject.yang.model.DataNode.Builder builder) Returns resource identifier for a given data node.
static org.onosproject.yang.model.DataNode.Builder	initializeDataNode(org.onosproject.yang.model.ResourceId.Builder builder) Initializes a new data node builder using resource identifier builder.
static org.onosproject.yang.model.DataNode.Builder	initializeDataNode(YangSerializerContext context) Initializes a new data node builder.
static org.onosproject.yang.model.ResourceId.Builder	initializeResourceId(YangSerializerContext context) Initializes resource identifier builder with YANG serializer context information.

Methods inherited from class java.lang.Object

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

Method Detail

initializeResourceId

public static org.onosproject.yang.model.ResourceId.Builder initializeResourceId(YangSerializerContext context)

Initializes resource identifier builder with YANG serializer context information.

Parameters:

context - YANG serializer context

Returns:

resource identifier builder

addToResourceId

public static org.onosproject.yang.model.ResourceId.Builder addToResourceId(org.onosproject.yang.model.ResourceId.Builder builder,
                                                                            String name,
                                                                            String namespace,
                                                                            String value)

Adds to resource identifier builder.

Builder and name are mandatory inputs, In case namespace is null, namespace of last key in the keylist of resource identifier builder will be used. Value should only be provided for leaf-list/list.

This API will also carry out necessary schema related validations.

Parameters:

builder - resource identifier builder

name - name of node

namespace - namespace of node

value - value of node

Returns:

resource identifier builder

Throws:

IllegalArgumentException - when given input is not as per the schema context

IllegalStateException - when a key is added under a atomic child

addToResourceId

public static org.onosproject.yang.model.ResourceId.Builder addToResourceId(org.onosproject.yang.model.ResourceId.Builder builder,
                                                                            String name,
                                                                            String namespace,
                                                                            List<String> value)
                                                                     throws IllegalArgumentException

Adds to resource identifier builder, this API will be used by applications which are not aware about the schema name association with key's value.

Builder and name are mandatory inputs, In case namespace is null, namespace of last key in the key list of resource identifier builder will be used. Value should only be provided for leaf-list/list.

In case of list its mandatory to pass either all key values of list or non of them (wild card to support get operation).

This API will also carry out necessary schema related validations.

Parameters:

builder - resource identifier builder

name - name of node

namespace - namespace of node

value - ordered list of values

Returns:

resource identifier builder

Throws:

IllegalArgumentException - when given input is not as per the schema context

IllegalStateException - when a key is added under a atomic child

initializeDataNode

public static org.onosproject.yang.model.DataNode.Builder initializeDataNode(org.onosproject.yang.model.ResourceId.Builder builder)

Initializes a new data node builder using resource identifier builder.

This API can only be used when passed parameter resourceId builder is prepared with the help of serializer helper utility.

Parameters:

builder - resource identifier builder

Returns:

data node builder

initializeDataNode

public static org.onosproject.yang.model.DataNode.Builder initializeDataNode(YangSerializerContext context)

Initializes a new data node builder.

Parameters:

context - YANG serializer context

Returns:

data node builder

addDataNode

public static org.onosproject.yang.model.DataNode.Builder addDataNode(org.onosproject.yang.model.DataNode.Builder builder,
                                                                      String name,
                                                                      String namespace,
                                                                      String value,
                                                                      org.onosproject.yang.model.DataNode.Type type)

Adds a data node to a given data node builder.

Name and builder is mandatory inputs. If namespace is not provided parents namespace will be added for data node. Value should be provided for leaf/leaf-list. In case of leaf-list it's expected that this API is called for each leaf-list instance. Callers aware about the node type can opt to provide data node type, implementation will carry out validations based on input type and obtained type.

This API will also carry out necessary schema related validations.

Parameters:

builder - data node builder

name - name of data node

namespace - namespace of data node

value - value of data node

type - type of data node

Returns:

data node builder with added information

Throws:

IllegalArgumentException - when given input is not as per the schema context

IllegalStateException - when a key is added under a atomic child

addDataNode

public static org.onosproject.yang.model.DataNode.Builder addDataNode(org.onosproject.yang.model.DataNode.Builder builder,
                                                                      String name,
                                                                      String namespace,
                                                                      String value,
                                                                      String valNamespace,
                                                                      org.onosproject.yang.model.DataNode.Type type)

Adds a data node to a given data node builder.

Name and builder is mandatory inputs. If namespace is not provided parents namespace will be added for data node. Value should be provided for leaf/leaf-list. In case of leaf-list it's expected that this API is called for each leaf-list instance. Callers aware about the node type can opt to provide data node type, implementation will carry out validations based on input type and obtained type.

This API will also carry out necessary schema related validations.

Parameters:

builder - data node builder

name - name of data node

namespace - namespace of data node

value - value of data node

valNamespace - value's namespace, either module name of namespace, null indicates its same as leaf

type - type of data node

Returns:

data node builder with added information

Throws:

IllegalArgumentException - when given input is not as per the schema context

IllegalStateException - when a key is added under a atomic child

getResourceId

public static org.onosproject.yang.model.ResourceId getResourceId(org.onosproject.yang.model.DataNode.Builder builder)

Returns resource identifier for a given data node. This API will be used by serializer to obtain the resource identifier in the scenario when an annotation is associated with a given data node.

Parameters:

builder - data node builder

Returns:

resource identifier of the data node

exitDataNode

public static org.onosproject.yang.model.DataNode.Builder exitDataNode(org.onosproject.yang.model.DataNode.Builder builder)

Exits a given data node builder. It builds current data node, adds it to parent's data node builder and returns parent builder.

In case current data node is topmost node (which was created using last key of resource identifier), current data node will not be built and null will be returned, in such case caller is expected to build data node from builder.

This API will also carry out necessary exit time validations, for an example validation about all key leafs presence for a list.

Parameters:

builder - data node builder

Returns:

parent builder

getChildSchemaContext

public static org.onosproject.yang.model.SchemaContext getChildSchemaContext(org.onosproject.yang.model.SchemaContext context,
                                                                             String name,
                                                                             String namespace)
                                                                      throws IllegalArgumentException

Returns child schema context for request name and namespace from given resourceId builder.

Parameters:

context - parent schema context

name - name of the child node

namespace - namespace of the child node

Returns:

schema context

Throws:

IllegalArgumentException - on argument error

errorMsg

public static String errorMsg(String fmt,
                              Object... params)

Returns the error string by filling the parameters in the given formatted error string.

Parameters:

fmt - error format string

params - parameters to be filled in formatted string

Returns:

error string

getModuleNameFromNameSpace

public static String getModuleNameFromNameSpace(YangSerializerContext c,
                                                String ns)

Returns the yang module name for given namespace.

Parameters:

c - YANG serializer context

ns - namespace of the module

Returns:

namespace of the module