YdtContext (onos-apps-yms-app)

All Known Subinterfaces:

YdtExtendedContext

All Known Implementing Classes:

YdtMultiInstanceNode, YdtNode, YdtSingleInstanceLeafNode
```
public interface YdtContext
```
Abstraction of an entity which represents YANG data tree context information. This context information will be used protocol to obtain the information associated with YDT node. This is used when protocol is walking the data tree in both visitor and listener mechanism.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`YdtContext`	`getFirstChild()` Returns the context of first child.
`YdtContext`	`getLastChild()` Returns the context of last child.
`String`	`getModuleNameAsNameSpace()` Returns module name as namespace.
`String`	`getName()` Returns the node name.
`String`	`getNamespace()` Returns the node namespace.
`YdtContext`	`getNextSibling()` Returns the context of next sibling.
`YdtContext`	`getParent()` Returns the context of parent node.
`YdtContext`	`getPreviousSibling()` Returns the context of previous sibling.
`String`	`getValue()` Returns value of node, this is only valid for single instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
`Set<String>`	`getValueSet()` Returns set of values of a node, this is only valid for multi instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
`<T> T`	`getYdtContextExtendedInfo()` Returns the YDT node extended context information corresponding to YDT node.
`YdtExtendedInfoType`	`getYdtExtendedInfoType()` Returns YANG data tree extended information type.
`YdtType`	`getYdtType()` Returns the type of YDT entity.

- Method Detail
  - getName
```
String getName()
```
    Returns the node name.
    
    Returns:
    
    node name
  - getNamespace
```
String getNamespace()
```
    Returns the node namespace.
    
    Returns:
    
    node namespace
  - getModuleNameAsNameSpace
```
String getModuleNameAsNameSpace()
```
    Returns module name as namespace.
    
    Returns:
    
    module name
  - getYdtContextExtendedInfo
```
<T> T getYdtContextExtendedInfo()
```
    Returns the YDT node extended context information corresponding to YDT node.
    
    Type Parameters:
    
    T - specifies YMS operation specific extended information associated with YDT context. It will be YdtContextOperationType in case extended information type is EDIT_REQUEST and will be YdtContextResponseInfo in case extended information type is RESPONSE.
    
    Returns:
    
    YdtContextOperationType YDT node operation type
  - getYdtExtendedInfoType
```
YdtExtendedInfoType getYdtExtendedInfoType()
```
    Returns YANG data tree extended information type. This is used to identify the type of extended information applicable for YDT node.
    
    Returns:
    
    type of extended information
  - getYdtType
```
YdtType getYdtType()
```
    Returns the type of YDT entity. This type will be used by protocols to identify the nature of node and can implement it accordingly.
    
    Returns:
    
    YDT entity type
  - getParent
```
YdtContext getParent()
```
    Returns the context of parent node.
    
    Returns:
    
    context of parent node
  - getFirstChild
```
YdtContext getFirstChild()
```
    Returns the context of first child.
    
    Returns:
    
    context of first child
  - getLastChild
```
YdtContext getLastChild()
```
    Returns the context of last child.
    
    Returns:
    
    context of last child
  - getNextSibling
```
YdtContext getNextSibling()
```
    Returns the context of next sibling.
    
    Returns:
    
    context of next sibling
  - getPreviousSibling
```
YdtContext getPreviousSibling()
```
    Returns the context of previous sibling.
    
    Returns:
    
    context of previous sibling
  - getValue
```
String getValue()
```
    Returns value of node, this is only valid for single instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
    
    Returns:
    
    value of node
  - getValueSet
```
Set<String> getValueSet()
```
    Returns set of values of a node, this is only valid for multi instance leaf node, to obtain the nature of the node protocols need to use getYdtType().
    
    Returns:
    
    value of YDT leaf

Interface YdtContext

Method Summary

Method Detail

getName

getNamespace

getModuleNameAsNameSpace

getYdtContextExtendedInfo

getYdtExtendedInfoType

getYdtType

getParent

getFirstChild

getLastChild

getNextSibling

getPreviousSibling

getValue

getValueSet