MaapiSchemas.CSNode (NCS Java API Version 5.6)

Object
- com.tailf.maapi.MaapiSchemas.CSNode

Enclosing class:

MaapiSchemas
```
public class MaapiSchemas.CSNode
extends Object
```
Class representing a Schema node, having references to parent and children as well as siblings

Constructor Summary

Constructors
Constructor and Description
`CSNode()` Constructor for CSNode class
`CSNode(int taghash, int nshash, MaapiSchemas.CSNodeInfo info, MaapiSchemas.CSNode parentNode, MaapiSchemas.CSNode firstChild, MaapiSchemas.CSNode nextSibling, MaapiSchemas.CSNode previousSibling)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Return true if and onlfy if this nodes is equal the specified node
`MaapiSchemas.CSNode`	`getChild(int tagHash)` Retrieve a child with the specified tag Returns null if no child exists.
`MaapiSchemas.CSNode`	`getChild(long tagHash)` Deprecated.
`List<MaapiSchemas.CSNode>`	`getChildren()` Retrieves children for this node as List or null if no children exists.
`List<MaapiSchemas.CSChoice>`	`getChoices()` get List object of choices for this node.
`ConfObject`	`getDefval()` get default value represented as a subclass to ConfObject
`MaapiSchemas.CSNode`	`getKey(int index)` Return a key at the given index.
`List<MaapiSchemas.CSNode>`	`getKeys()` Return a list of keys.
`int`	`getMaxOccurs()` get MaxOccurs for the node
`int`	`getMinOccurs()` get MinOccurs for the node
`MaapiSchemas.CSNodeInfo`	`getNodeInfo()` Retrieves the node information
`String`	`getNS()` get namespace represented as string
`int`	`getNSHash()` Retrieves the namespace represented as hash value
`MaapiSchemas.CSNode`	`getParentNode()` Retrieves the parent node for this node
`MaapiSchemas.CSNode`	`getSibling(int tagHash)` Retrieves sibling with specified tag or null if no sibling exists.
`MaapiSchemas.CSNode`	`getSibling(long tagHash)` Deprecated.
`List<MaapiSchemas.CSNode>`	`getSiblings()` Retrieves siblings for this node as List or null if no siblings exists.
`String`	`getTag()` Retrieves the node tag represented as string
`int`	`getTagHash()` Retrieves the node tag represented as hash value
`MaapiSchemas.CSType`	`getType()` get type for the node
`String`	`getXmlNS()` get the xml namespace represented as string
`boolean`	`hasDisplayWhen()` Checks if the node has YANG 'tailf:display-when' statement(s).
`int`	`hashCode()`
`boolean`	`hasMetaData()` Checks if the node has YANG 'tailf:meta-data' statement(s).
`boolean`	`hasMountPoint()`
`boolean`	`hasWhen()` Checks if the node has YANG 'when' statement(s).
`boolean`	`isAction()` Checks if a node is an action.
`boolean`	`isActionParam()` Checks if a node is an action parameter node.
`boolean`	`isActionResult()` Checks if a node is an action result node.
`boolean`	`isCase()` Checks if a node is top level of a case.
`boolean`	`isContainer()` Checks if a node is a container node.
`boolean`	`isEmptyLeaf()`
`boolean`	`isLeaf()` Checks if a node is a leaf node.
`boolean`	`isLeafList()` Checks if the node is a leaf-list node.
`boolean`	`isLeafref()` Checks if the node is a YANG 'leafref'.
`boolean`	`isList()` Checks if a node is a list node.
`boolean`	`isNotif()` Checks if the node is a notification
`boolean`	`isOper()`
`boolean`	`isWritable()` Checks if the node is writable.
`String`	`printNodeType()`
`String`	`toString()` Informative string representation of a CSNode instance

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CSNode
```
public CSNode(int taghash,
              int nshash,
              MaapiSchemas.CSNodeInfo info,
              MaapiSchemas.CSNode parentNode,
              MaapiSchemas.CSNode firstChild,
              MaapiSchemas.CSNode nextSibling,
              MaapiSchemas.CSNode previousSibling)
```
  - CSNode
```
public CSNode()
```
    Constructor for CSNode class
- Method Detail
  - getTagHash
```
public int getTagHash()
```
    Retrieves the node tag represented as hash value
    
    Returns:
    
    int hashvalue for the tag
  - getTag
```
public String getTag()
```
    Retrieves the node tag represented as string
    
    Returns:
    
    string tag
  - getNSHash
```
public int getNSHash()
```
    Retrieves the namespace represented as hash value
    
    Returns:
    
    hashvalue for the namespace
  - getNS
```
public String getNS()
```
    get namespace represented as string
    
    Returns:
    
    String namespace
  - getXmlNS
```
public String getXmlNS()
```
    get the xml namespace represented as string
    
    Returns:
    
    String xml namespace
  - getNodeInfo
```
public MaapiSchemas.CSNodeInfo getNodeInfo()
```
    Retrieves the node information
    
    Returns:
    
    CSNodeInfo node information about current (this) node
  - getParentNode
```
public MaapiSchemas.CSNode getParentNode()
```
    Retrieves the parent node for this node
    
    Returns:
    
    CSNode parent or null if this a root node
  - getSiblings
```
public List<MaapiSchemas.CSNode> getSiblings()
```
    Retrieves siblings for this node as List or null if no siblings exists.
    
    Includes the current node in the List.
    
    Returns:
    
    List of sibling nodes including the current (this) node
  - getSibling
```
public MaapiSchemas.CSNode getSibling(int tagHash)
```
    Retrieves sibling with specified tag or null if no sibling exists.
    
    Returns:
    
    a node
  - getSibling
```
@Deprecated
public MaapiSchemas.CSNode getSibling(long tagHash)
```
    Deprecated.
    
    Use MaapiSchemas.CSNode.getSibling(int) instead.
  - getChildren
```
public List<MaapiSchemas.CSNode> getChildren()
```
    Retrieves children for this node as List or null if no children exists.
    
    Returns:
    
    List of children nodes
  - getChild
```
public MaapiSchemas.CSNode getChild(int tagHash)
```
    Retrieve a child with the specified tag Returns null if no child exists.
    
    Returns:
    
    Child node
  - getChild
```
@Deprecated
public MaapiSchemas.CSNode getChild(long tagHash)
```
    Deprecated.
    
    Use MaapiSchemas.CSNode.getChild(int) instead
  - getKey
```
public MaapiSchemas.CSNode getKey(int index)
```
    Return a key at the given index. If no key is found null is returned
    
    Returns:
    
    return the CSNode of the key
  - getKeys
```
public List<MaapiSchemas.CSNode> getKeys()
```
    Return a list of keys. If the node is not a YANG list then null is returned.
    
    Returns:
    
    List of CSNodes used as keys
  - getMinOccurs
```
public int getMinOccurs()
```
    get MinOccurs for the node
    
    Returns:
    
    int minOccurs
  - getMaxOccurs
```
public int getMaxOccurs()
```
    get MaxOccurs for the node
    
    Returns:
    
    int maxOccurs
  - getType
```
public MaapiSchemas.CSType getType()
```
    get type for the node
    
    Returns:
    
    CSType type for the node
  - getDefval
```
public ConfObject getDefval()
```
    get default value represented as a subclass to ConfObject
    
    Returns:
    
    ConfObject
  - getChoices
```
public List<MaapiSchemas.CSChoice> getChoices()
```
    get List object of choices for this node. A Choice is represented by the CSChoice class, this is a List of CSChoice accordingly
    
    Returns:
    
    List of Choices
  - equals
```
public boolean equals(Object o)
```
    Return true if and onlfy if this nodes is equal the specified node
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAction
```
public boolean isAction()
```
    Checks if a node is an action.
    
    Returns:
    
    true if it is an action.
  - isCase
```
public boolean isCase()
```
    Checks if a node is top level of a case.
    
    Returns:
    
    true if the node is part of a case.
  - isContainer
```
public boolean isContainer()
```
    Checks if a node is a container node.
    
    Returns:
    
    true if the node is a container node.
  - isEmptyLeaf
```
public boolean isEmptyLeaf()
```
  - isLeaf
```
public boolean isLeaf()
```
    Checks if a node is a leaf node.
    
    Returns:
    
    true if the node is leaf node.
  - isLeafList
```
public boolean isLeafList()
```
    Checks if the node is a leaf-list node.
    
    Returns:
    
    true if the node is leaf-list node.
  - isList
```
public boolean isList()
```
    Checks if a node is a list node.
    
    Returns:
    
    true if the node is list node.
  - isActionParam
```
public boolean isActionParam()
```
    Checks if a node is an action parameter node.
    
    Returns:
    
    true if the node is an action parameter node.
  - isActionResult
```
public boolean isActionResult()
```
    Checks if a node is an action result node.
    
    Returns:
    
    true if the node is action result node.
  - isWritable
```
public boolean isWritable()
```
    Checks if the node is writable.
    
    Returns:
    
    true if the node is writable.
  - isNotif
```
public boolean isNotif()
```
    Checks if the node is a notification
    
    Returns:
    
    true if the node a notification
  - isOper
```
public boolean isOper()
```
    Returns:
    
    true if node is OPER data.
  - hasWhen
```
public boolean hasWhen()
```
    Checks if the node has YANG 'when' statement(s).
    
    Returns:
    
    true if node has YANG 'when' statement(s).
  - hasDisplayWhen
```
public boolean hasDisplayWhen()
```
    Checks if the node has YANG 'tailf:display-when' statement(s).
    
    Returns:
    
    true if node has YANG 'tailf:display-when' statement(s).
  - hasMetaData
```
public boolean hasMetaData()
```
    Checks if the node has YANG 'tailf:meta-data' statement(s).
    
    Returns:
    
    true if node has YANG 'tailf:meta-data' statement(s).
  - isLeafref
```
public boolean isLeafref()
```
    Checks if the node is a YANG 'leafref'.
    
    Returns:
    
    true if node is a YANG 'leafref'.
  - hasMountPoint
```
public boolean hasMountPoint()
```
  - printNodeType
```
public String printNodeType()
```
  - toString
```
public String toString()
```
    Informative string representation of a CSNode instance
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String

Class MaapiSchemas.CSNode

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

CSNode

CSNode

Method Detail

getTagHash

getTag

getNSHash

getNS

getXmlNS

getNodeInfo

getParentNode

getSiblings

getSibling

getSibling

getChildren

getChild

getChild

getKey

getKeys

getMinOccurs

getMaxOccurs

getType

getDefval

getChoices

equals

hashCode

isAction

isCase

isContainer

isEmptyLeaf

isLeaf

isLeafList

isList

isActionParam

isActionResult

isWritable

isNotif

isOper

hasWhen

hasDisplayWhen

hasMetaData

isLeafref

hasMountPoint

printNodeType

toString