org.onosproject.yms.app.ytb

Class DefaultYangTreeBuilder

java.lang.Object

org.onosproject.yms.app.ytb.DefaultYangTreeBuilder

All Implemented Interfaces:

YangTreeBuilder

public class DefaultYangTreeBuilder
extends Object
implements YangTreeBuilder

Representation of YANG tree builder which generates YANG data tree from the class objects which are provided from the applications and return it to the protocol(s).

Constructor Summary

Constructors

Constructor and Description
DefaultYangTreeBuilder() Creates the YANG tree builder.

Method Summary

Modifier and Type	Method and Description
YdtExtendedBuilder	getYdtBuilderForYo(List<Object> moduleObj, String rootName, String rootNameSpace, YmsOperationType opType, YangSchemaRegistry registry) Returns the YDT builder after building the tree corresponding to the response YANG object received from any of the protocol such as YAB or YCH.
YdtExtendedContext	getYdtForNotification(Object object, String rootName, YangSchemaRegistry registry) Returns the YDT context after building the tree received from the protocol YNH.
YdtExtendedBuilder	getYdtForRpcResponse(Object outputObj, YdtExtendedBuilder reqBuilder) Returns the YDT context after building the RPC response tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultYangTreeBuilder

public DefaultYangTreeBuilder()

Creates the YANG tree builder.

Method Detail

getYdtBuilderForYo

public YdtExtendedBuilder getYdtBuilderForYo(List<Object> moduleObj,
                                             String rootName,
                                             String rootNameSpace,
                                             YmsOperationType opType,
                                             YangSchemaRegistry registry)

Description copied from interface: YangTreeBuilder

Returns the YDT builder after building the tree corresponding to the response YANG object received from any of the protocol such as YAB or YCH.

Specified by:

getYdtBuilderForYo in interface YangTreeBuilder

Parameters:

moduleObj - application module object

rootName - logical root node name

rootNameSpace - logical root node namespace

opType - root node operation type

registry - application schema registry

Returns:

YDT builder from the tree

getYdtForNotification

public YdtExtendedContext getYdtForNotification(Object object,
                                                String rootName,
                                                YangSchemaRegistry registry)

Description copied from interface: YangTreeBuilder

Returns the YDT context after building the tree received from the protocol YNH.

Specified by:

getYdtForNotification in interface YangTreeBuilder

Parameters:

object - application notification object

rootName - logical root node name

registry - application schema registry

Returns:

YDT context from the tree

getYdtForRpcResponse

public YdtExtendedBuilder getYdtForRpcResponse(Object outputObj,
                                               YdtExtendedBuilder reqBuilder)

Description copied from interface: YangTreeBuilder

Returns the YDT context after building the RPC response tree. The input for building the tree is RPC request builder, RPC output java object. These are received from the YSB protocol.

Specified by:

getYdtForRpcResponse in interface YangTreeBuilder

Parameters:

outputObj - application output object

reqBuilder - RPC request builder from YDT

Returns:

YDT builder where RPC response tree is created