org.onosproject.yms.app.ytb

Class YtbUtil

java.lang.Object

org.onosproject.yms.app.ytb.YtbUtil

public final class YtbUtil
extends Object

Representation of utility for YANG tree builder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERIOD Static attribute for a dot string.
static String	STR_NULL Static attribute for string value having null.

Method Summary

Modifier and Type	Method and Description
static String	emptyObjErrMsg(String objName) Returns string for throwing error when empty object is given as input to YTB.
static Object	getAttributeFromInheritance(Object childClass, String methodName) Returns the object of the declared method in parent class by invoking through the child class object.
static Object	getAttributeOfObject(Object nodeObj, String fieldName) Returns the value of an attribute, in a class object.
static Class<?>	getClassLoaderForAugment(org.onosproject.yangutils.datamodel.YangNode curNode, YangSchemaRegistry registry) Returns the registered class from the YSR of the module node where augment is present.
static Class<?>	getInterfaceClassFromImplClass(Object obj) Returns interface class from an implementation class object.
static String	getJavaName(Object node) Returns the java name for the nodes, leaf/leaf-list.
static YdtContextOperationType	getNodeOpType(Object nodeObj, String typeName) Returns the operation type value for a class object.
static String	getOpTypeName(org.onosproject.yangutils.datamodel.YangNode curNode) Returns the name of the operation type variable from the yang name.
static Object	getParentObjectOfNode(YtbNodeInfo nodeInfo, org.onosproject.yangutils.datamodel.YangNode yangNode) Returns the object of the node from the node info.
static String	getStringFromType(org.onosproject.yangutils.datamodel.YangSchemaNode holder, Object holderObj, String name, Object fieldObj, org.onosproject.yangutils.datamodel.YangType dataType) Returns the string value from the respective data types of the leaf/leaf-list.
static boolean	isAugmentNode(org.onosproject.yangutils.datamodel.YangNode yangNode) Returns true, if augment node; false otherwise.
static boolean	isMultiInstanceNode(org.onosproject.yangutils.datamodel.YangNode yangNode) Returns true, if multi instance node; false otherwise.
static boolean	isNodeProcessCompleted(org.onosproject.yangutils.datamodel.YangNode curNode, TraversalType curTraversal) Returns true when the node processing of RPC and notification is completed; false otherwise.
static boolean	isNonProcessableNode(org.onosproject.yangutils.datamodel.YangNode yangNode) Returns true, if processing of the node is not required; false otherwise.
static boolean	isTypePrimitive(org.onosproject.yangutils.datamodel.YangType yangType) Returns true, if data type of leaf is primitive data type; false otherwise.
static String	isValueOrSelectLeafSet(org.onosproject.yangutils.datamodel.YangSchemaNode holder, Object nodeObj, String javaName, String methodName) Returns the string true, if the leaf data is actually set; false otherwise.
static boolean	nonEmpty(Collection<?> c) Returns true, if the list is not null and non-empty; false otherwise.
static boolean	nonEmpty(String str) Returns true, if the string is not null and non-empty; false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

STR_NULL

public static final String STR_NULL

Static attribute for string value having null.

See Also:

Constant Field Values

PERIOD

public static final String PERIOD

Static attribute for a dot string.

See Also:

Constant Field Values

Method Detail

getParentObjectOfNode

public static Object getParentObjectOfNode(YtbNodeInfo nodeInfo,
                                           org.onosproject.yangutils.datamodel.YangNode yangNode)

Returns the object of the node from the node info. Getting object for augment and case differs from other node.

Parameters:

nodeInfo - node info of the holder

yangNode - YANG node of the holder

Returns:

object of the parent

getAttributeOfObject

public static Object getAttributeOfObject(Object nodeObj,
                                          String fieldName)
                                   throws NoSuchMethodException

Returns the value of an attribute, in a class object. The attribute name is taken from the YANG node java name.

Parameters:

nodeObj - object of the node

fieldName - name of the attribute

Returns:

object of the attribute

Throws:

NoSuchMethodException - method not found exception

getAttributeFromInheritance

public static Object getAttributeFromInheritance(Object childClass,
                                                 String methodName)

Returns the object of the declared method in parent class by invoking through the child class object.

Parameters:

childClass - child class which inherits the parent class

methodName - name of the declared method

Returns:

value of the method

getInterfaceClassFromImplClass

public static Class<?> getInterfaceClassFromImplClass(Object obj)

Returns interface class from an implementation class object.

Parameters:

obj - implementation class object

Returns:

interface class

getNodeOpType

public static YdtContextOperationType getNodeOpType(Object nodeObj,
                                                    String typeName)

Returns the operation type value for a class object. If the operation type is not set, then none type is returned.

Parameters:

nodeObj - node object

typeName - data type name

Returns:

operation type of the class

isTypePrimitive

public static boolean isTypePrimitive(org.onosproject.yangutils.datamodel.YangType yangType)

Returns true, if data type of leaf is primitive data type; false otherwise.

Parameters:

yangType - leaf type

Returns:

true if data type is primitive; false otherwise

getClassLoaderForAugment

public static Class<?> getClassLoaderForAugment(org.onosproject.yangutils.datamodel.YangNode curNode,
                                                YangSchemaRegistry registry)

Returns the registered class from the YSR of the module node where augment is present.

Parameters:

curNode - current augment node

registry - schema registry

Returns:

class loader of module

isValueOrSelectLeafSet

public static String isValueOrSelectLeafSet(org.onosproject.yangutils.datamodel.YangSchemaNode holder,
                                            Object nodeObj,
                                            String javaName,
                                            String methodName)
                                     throws NoSuchMethodException

Returns the string true, if the leaf data is actually set; false otherwise.

Parameters:

holder - leaf holder

nodeObj - object if the node

javaName - java name of the leaf

methodName - getter method name

Returns:

string value of the boolean method

Throws:

NoSuchMethodException - if the method is not present

getStringFromType

public static String getStringFromType(org.onosproject.yangutils.datamodel.YangSchemaNode holder,
                                       Object holderObj,
                                       String name,
                                       Object fieldObj,
                                       org.onosproject.yangutils.datamodel.YangType dataType)

Returns the string value from the respective data types of the leaf/leaf-list.

Parameters:

holder - leaf/leaf-list holder

holderObj - leaf/leaf-list holder object

name - leaf/leaf-list name

fieldObj - object of the leaf/leaf-list field

dataType - type of the leaf/leaf-list

Returns:

string value from the type

isNonProcessableNode

public static boolean isNonProcessableNode(org.onosproject.yangutils.datamodel.YangNode yangNode)

Returns true, if processing of the node is not required; false otherwise. For the nodes such as notification, RPC, augment there is a different flow, so these nodes are skipped in normal conditions.

Parameters:

yangNode - node to be checked

Returns:

true if node processing is not required; false otherwise.

isMultiInstanceNode

public static boolean isMultiInstanceNode(org.onosproject.yangutils.datamodel.YangNode yangNode)

Returns true, if multi instance node; false otherwise.

Parameters:

yangNode - YANG node

Returns:

true, if multi instance node; false otherwise.

isAugmentNode

public static boolean isAugmentNode(org.onosproject.yangutils.datamodel.YangNode yangNode)

Returns true, if augment node; false otherwise.

Parameters:

yangNode - YANG node

Returns:

true, if augment node; false otherwise.

emptyObjErrMsg

public static String emptyObjErrMsg(String objName)

Returns string for throwing error when empty object is given as input to YTB.

Parameters:

objName - name of the object

Returns:

error message

getJavaName

public static String getJavaName(Object node)

Returns the java name for the nodes, leaf/leaf-list.

Parameters:

node - YANG node

Returns:

node java name

nonEmpty

public static boolean nonEmpty(Collection<?> c)

Returns true, if the list is not null and non-empty; false otherwise.

Parameters:

c - collection object

Returns:

true, if the list is not null and non-empty; false otherwise

nonEmpty

public static boolean nonEmpty(String str)

Returns true, if the string is not null and non-empty; false otherwise.

Parameters:

str - string value

Returns:

true, if the string is not null and non-empty; false otherwise.

isNodeProcessCompleted

public static boolean isNodeProcessCompleted(org.onosproject.yangutils.datamodel.YangNode curNode,
                                             TraversalType curTraversal)

Returns true when the node processing of RPC and notification is completed; false otherwise. For RPC and notification, processing of other nodes are invalid, so once node gets completed, it must be stopped.

Parameters:

curNode - current node

curTraversal - current traversal of the node

Returns:

true, if the node processing is completed; false otherwise.

getOpTypeName

public static String getOpTypeName(org.onosproject.yangutils.datamodel.YangNode curNode)

Returns the name of the operation type variable from the yang name.

Parameters:

curNode - YANG node

Returns:

name of operation type