YpmContext (onos-apps-yms-app)

All Known Implementing Classes:

DefaultYpmNode
```
public interface YpmContext
```
Abstraction of an entity which represents YANG protocol metadata context information.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChild(String name)` Adds child to a node by ydt name.
`void`	`addSibling(String name)` Adds new sibling to a child.
`YpmContext`	`getChild(String name)` Retrieves the child of a node for corresponding ydt node.
`YpmContext`	`getFirstChild()` Retrieves the first child of a node.
`Object`	`getMetaData()` Retrieves protocol metadata.
`String`	`getName()` Returns the node name.
`YpmContext`	`getNextSibling()` Returns the context of next sibling.
`YpmContext`	`getParent()` Returns the context of parent node.
`DefaultYpmNode`	`getPreviousSibling()` Returns the previous sibling of a node.
`YpmContext`	`getSibling(String name)` Retrieves sibling of a child by (ydt) name.
`void`	`setMetaData(Object data)` Sets the protocol metadata.
`void`	`setName(String name)` Sets the nodes name.
`void`	`setNextSibling(DefaultYpmNode sibling)` Sets the next sibling of node.
`void`	`setParent(YpmContext parent)` Sets the context of parent node.
`void`	`setPreviousSibling(DefaultYpmNode previousSibling)` Sets the previous sibling.

- Method Detail
  - getName
```
String getName()
```
    Returns the node name.
    
    Returns:
    
    node name
  - setName
```
void setName(String name)
```
    Sets the nodes name.
    
    Parameters:
    
    name - nodes name
  - getParent
```
YpmContext getParent()
```
    Returns the context of parent node.
    
    Returns:
    
    context of parent node
  - setParent
```
void setParent(YpmContext parent)
```
    Sets the context of parent node.
    
    Parameters:
    
    parent - node parent
  - getFirstChild
```
YpmContext getFirstChild()
```
    Retrieves the first child of a node.
    
    Returns:
    
    first child of a node
  - getChild
```
YpmContext getChild(String name)
```
    Retrieves the child of a node for corresponding ydt node.
    
    Parameters:
    
    name - ypm node
    
    Returns:
    
    child of a node
  - addChild
```
void addChild(String name)
```
    Adds child to a node by ydt name.
    
    Parameters:
    
    name - ypm name
  - getSibling
```
YpmContext getSibling(String name)
```
    Retrieves sibling of a child by (ydt) name.
    
    Parameters:
    
    name - ypm name
    
    Returns:
    
    sibling of a child
  - addSibling
```
void addSibling(String name)
```
    Adds new sibling to a child.
    
    Parameters:
    
    name - ypm name
  - getNextSibling
```
YpmContext getNextSibling()
```
    Returns the context of next sibling.
    
    Returns:
    
    context of next sibling
  - setNextSibling
```
void setNextSibling(DefaultYpmNode sibling)
```
    Sets the next sibling of node.
    
    Parameters:
    
    sibling - ypm node
  - getPreviousSibling
```
DefaultYpmNode getPreviousSibling()
```
    Returns the previous sibling of a node.
    
    Returns:
    
    previous sibling of a node
  - setPreviousSibling
```
void setPreviousSibling(DefaultYpmNode previousSibling)
```
    Sets the previous sibling.
    
    Parameters:
    
    previousSibling - points to predecessor sibling
  - getMetaData
```
Object getMetaData()
```
    Retrieves protocol metadata.
    
    Returns:
    
    metadata
  - setMetaData
```
void setMetaData(Object data)
```
    Sets the protocol metadata.
    
    Parameters:
    
    data - metadata

Interface YpmContext

Method Summary

Method Detail

getName

setName

getParent

setParent

getFirstChild

getChild

addChild

getSibling

addSibling

getNextSibling

setNextSibling

getPreviousSibling

setPreviousSibling

getMetaData

setMetaData