org.onosproject.yms.app.ydt

Interface YdtExtendedBuilder

All Superinterfaces:

Ydt, YdtBuilder

All Known Implementing Classes:

YangRequestWorkBench

public interface YdtExtendedBuilder
extends YdtBuilder

Abstraction of an entity which represents extension of YDT builder required by internal sub modules.

Method Summary

Modifier and Type	Method and Description
YdtExtendedContext	addChild(YdtContextOperationType opType, org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode) Adds a last child to YANG data tree; this method is to be used by YANG object builder.
YdtExtendedContext	addLeaf(String value, org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode) Adds a last leaf to YANG data tree; this method is to be used by YANG object builder.
YdtExtendedContext	addLeafList(Set<String> valueSet, org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode) Adds a last leaf list to YANG data tree; this method is to be used by YANG object builder.
YdtExtendedContext	getCurNode() Returns the current context information available in YDT node.
YdtExtendedContext	getRootNode() Returns the root context information available in YDT node.
void	traverseToParentWithoutValidation() Traverses up in YANG data tree to the parent node, it is to be used when protocol is using extended context type and wanted to traverse up the tree without doing any validation.

Methods inherited from interface org.onosproject.yms.ydt.YdtBuilder

addChild, addChild, addChild, addChild, addLeaf, addLeaf, addMultiInstanceChild, getRootTagAttributeMap, setDefaultEditOperationType, setRootTagAttributeMap, traverseToParent

Methods inherited from interface org.onosproject.yms.ydt.Ydt

getYmsOperationType

Method Detail

addChild

YdtExtendedContext addChild(YdtContextOperationType opType,
                            org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode)

Adds a last child to YANG data tree; this method is to be used by YANG object builder.

Parameters:

yangSchemaNode - schema node from YANG metadata

opType - type of requested operation over a node

Returns:

YDT context

addLeafList

YdtExtendedContext addLeafList(Set<String> valueSet,
                               org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode)

Adds a last leaf list to YANG data tree; this method is to be used by YANG object builder.

Parameters:

valueSet - list of value of the child

yangSchemaNode - schema node from YANG metadata

Returns:

YDT context

addLeaf

YdtExtendedContext addLeaf(String value,
                           org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode)

Adds a last leaf to YANG data tree; this method is to be used by YANG object builder.

Parameters:

value - value of the child

yangSchemaNode - schema node from YANG metadata

Returns:

YDT context

traverseToParentWithoutValidation

void traverseToParentWithoutValidation()
                                throws IllegalStateException

Traverses up in YANG data tree to the parent node, it is to be used when protocol is using extended context type and wanted to traverse up the tree without doing any validation.

Throws:

IllegalStateException - when user request for traverse to logical root node parent

getRootNode

YdtExtendedContext getRootNode()

Description copied from interface: Ydt

Returns the root context information available in YDT node. This root node is a logical container of a protocol which holds the complete data tree. After building YANG data tree, root node can be obtained from this.

Specified by:

getRootNode in interface Ydt

Returns:

root YDT context which is logical container of a protocol which is holder of the complete tree

getCurNode

YdtExtendedContext getCurNode()

Description copied from interface: YdtBuilder

Returns the current context information available in YDT node.

Specified by:

getCurNode in interface YdtBuilder

Returns:

current YDT context