Element

java.lang.Object
- com.tailf.jnc.Element

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: Leaf, YangElement

public class Element
extends java.lang.Object
implements java.io.Serializable

A configuration element sub-tree. Makes it possible to create and/or manipulate an element tree. The element tree is then to be used to issue NETCONF operations using the NetconfSession class.

Example:

 
 // start (Netconf) sessions towards our device
 SSHConnection connection = new SSHConnection("127.0.0.1");
 connection.authenticateWithPassword("admin", "pass");
 SSHSession ssh = new SSHSession(connection);
 NetconfSession session = new NetconfSession(ssh);
 
 // get system configuration from session
 Element sysConfig = session.getConfig("/system").first();
 
 // manipulate the element tree
 sysConfig.setValue("dns", "83.100.1.1");
 sysConfig.setValue("gateway", "10.0.0.1");
 
 // Write back the updated element tree
 session.editConfig(sysConfig);

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected NodeSet`	`children` Children to the node, if container element.
`static int`	`CREATE_MERGE` Creates a new path and merges with the existing nodes when possible.
`static int`	`CREATE_MERGE_MULTI` Creates a new path and merges with the existing nodes when possible.
`static int`	`CREATE_NEW` Creates a new path.
`static PrefixMap`	`defaultPrefixes` Static prefix map that is always a default and will be resolved at root level.
`java.lang.String`	`name` The name of the node.
`java.lang.String`	`namespace` The namespace this element name belongs to.
`static java.lang.String`	`NETCONF_NAMESPACE` The NETCONF namespace.
`static int`	`OP_CREATE` Operation flag to be used with `merge(Element,int)`.
`static int`	`OP_DELETE` Operation flag to be used with `merge(Element,int)`.
`static int`	`OP_MERGE` Operation flag to be used with `merge(Element,int)`.
`static int`	`OP_REPLACE` Operation flag to be used with `merge(Element,int)`.
`static java.lang.String`	`OPERATION`
`protected Element`	`parent` The parent to this node.
`PrefixMap`	`prefixes` Prefix map are really xmlns attributes.
`java.lang.Object`	`value` The value of the element.

Constructor Summary

Constructors
Constructor and Description

Element(java.lang.String ns, java.lang.String name)
Constructor that creates a new element tree.

Constructors
Constructor and Description
`Element(java.lang.String ns, java.lang.String name)` Constructor that creates a new element tree.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttr(Attribute attr)` Adds an attribute for this element.
`void`	`addChild(Element child)` Adds child to children and makes this element the parent of child.
`java.lang.Object`	`clone()` Clones the tree, making an exact copy.
`protected Element`	`cloneAttrs(Element copy)` Clones the attributes to the target copy.
`protected Element`	`cloneShallow()` Clones the tree, making an exact copy.
`protected Element`	`cloneValue(Element copy)` clones the value to the target copy.
`int`	`compare(Element b)` Compare two elements.
`static Element`	`create(PrefixMap prefixMap, java.lang.String pathStr)` Static method that creates a new configuration element tree, given a path.
`static Element`	`create(Prefix prefix, java.lang.String pathStr)` Static method that creates a new configuration element tree, given a path.
`static Element`	`create(java.lang.String namespace, java.lang.String pathStr)` Static method that creates a new configuration element tree given a path.
`Element`	`createChild(java.lang.String name)` Creates a child element to the context node.
`Element`	`createChild(java.lang.String name, java.lang.Object value)` Creates a child element with specified value.
`Element`	`createChild(java.lang.String namespace, java.lang.String name, java.lang.Object value)` Creates a child element with specified value.
`Element`	`createPath(int mode, PrefixMap addPrefixes, java.lang.String pathStr)` Creates an element tree as a child to the context node.
`Element`	`createPath(int mode, java.lang.String pathStr)` Creates an element tree as a child to the context node from a create path expression.
`Element`	`createPath(PrefixMap addPrefixes, java.lang.String pathStr)` Creates an element tree as a child to the context node from a create path expression.
`Element`	`createPath(Prefix prefix, java.lang.String pathStr)` Creates an element tree as a child to the context node from a create path expression.
`Element`	`createPath(java.lang.String pathStr)` Creates an element tree as a child to the context node from a create path expression.
`Element`	`createPath(java.lang.String namespace, java.lang.String pathStr)` Creates an element tree as a child to the context node from a create path expression.
`void`	`delete()` Deletes this node.
`NodeSet`	`delete(java.lang.String pathStr)` Deletes child node(s).
`void`	`deleteChild(Element child)` Deletes a child node, provided it is present in the children list.
`void`	`deleteValue()` Deletes the value for this node.
`void`	`deleteValue(java.lang.String pathStr)` Deletes value of node(s)
`protected void`	`encode(Transport out)` Encode to XML and send it to the provided stream.
`protected void`	`encode(Transport out, boolean newline_at_end)` Encode to XML and send it to the provided stream.
`protected void`	`encode(Transport out, boolean newline_at_end, Capabilities capas)` Encode to XML and send it to the provided stream.
`protected void`	`encode(Transport out, Capabilities c)` Encode to XML and send it to the provided stream.
`boolean`	`equals(java.lang.Object other)` Compare if equal to another Object.
`boolean`	`exists(java.lang.String pathStr)` Check if any nodes in this element matches a given path string.
`NodeSet`	`get(java.lang.String pathStr)` Gets all nodes matching a given path expression.
`Attribute`	`getAttr(java.lang.String name)` Gets an Attribute
`Attribute[]`	`getAttrs()` Gets all attributes for this element.
`java.lang.String`	`getAttrValue(java.lang.String name)` Returns the string value of the named attribute.
`protected Element`	`getChild(Element child)` Tries to find an element with the same namespace and name as x.
`Element`	`getChild(java.lang.String name)` Get the (first) child with specified name, from children list
`NodeSet`	`getChildren()` Returns the children of this node.
`NodeSet`	`getChildren(java.lang.String name)` Get the children with specified name, from children list
`PrefixMap`	`getContextPrefixMap()` Returns a prefix map, as it is in the current context.
`java.lang.String`	`getElementPath()` Returns the path as a string
`java.lang.String`	`getElementPath(java.lang.String subPath)` Returns the path for this element including an appended sub-path.
`Element`	`getFirst(java.lang.String pathStr)` Returns first node that matches the path expression, or `null` if no such node was found.
`Element`	`getLast(java.lang.String pathStr)` Returns the last node that matches the path expression, or `null` if no such node was found.
`Element`	`getParent()` Returns the parent node of this node.
`Element`	`getRootElement()`
`java.lang.Object`	`getValue()` Returns the value of this element.
`java.lang.Object`	`getValue(java.lang.String pathStr)` Returns the value of a the first subnode matching a given path string, or null if there are no matches.
`java.lang.Object`	`getValueOfChild(java.lang.String childName)` Finds the value of child with specified name, if it exists.
`java.lang.Object[]`	`getValues(java.lang.String pathStr)` Returns the value(s) of nodes in a given path expression.
`java.util.Set<java.lang.String>`	`getValuesAsSet(java.lang.String pathStr)` Returns the values of nodes in a given path expression.
`boolean`	`hasChildren()` Returns `true` if this node has any children, `false` otherwise.
`int`	`hashCode()` Returns a hash code value for this object.
`int`	`insertChild(Element child)` Inserts a child element and returns the position of (the first occurrence of) the inserted child in the list of children.
`int`	`insertChild(Element child, int index)` Inserts a child element at a specific index in the list of children and returns that index upon success.
`int`	`insertChild(Element child, java.lang.String[] childrenNames)` Inserts a child element at the correct position by providing structure information (the names of all the children, in order).
`int`	`insertFirst(Element child)` Inserts a child element first in the list of children.
`int`	`insertLast(Element child)` Inserts a child element last in the list of children.
`ElementChildrenIterator`	`iterator()` Return an iterator for the children of this node.
`ElementChildrenIterator`	`iterator(java.lang.String name)` Return an iterator for the children of a specified name of this node.
`java.lang.String`	`lookupContextPrefix(java.lang.String prefix)` Lookups a prefix and returns the associated namespace, traverses up the parent links until the prefix is found.
`void`	`markCreate()` Marks a node with operation create
`void`	`markCreate(java.lang.String pathStr)` Marks node(s) with operation create.
`void`	`markDelete()` Marks a node with operation delete.
`void`	`markDelete(java.lang.String pathStr)` Marks node(s) with operation delete.
`void`	`markMerge()` Marks a node with operation merge.
`void`	`markMerge(java.lang.String pathStr)` Marks node(s) with operation merge.
`void`	`markReplace()` Marks a node with operation replace.
`void`	`markReplace(java.lang.String pathStr)` Marks node(s) with operation replace.
`Element`	`merge(Element root, int op)` Merges a subtree into a resulting target subtree.
`java.lang.String`	`nsToPrefix(java.lang.String ns)` This method will find the prefix of a specified namespace, from the given context node.
`int`	`position()` Returns the position of this element in the the parent child list.
`java.lang.String`	`prefix()` Returns the prefix name of this element.
`java.lang.String`	`qualifiedName()` A qualified name is a prefixed name.
`static Element`	`readFile(java.lang.String filename)` Read file with XML text and parse it into a configuration tree.
`void`	`removeAttr(java.lang.String name)` Removes an attribute with specified name.
`void`	`removeAttr(java.lang.String namespace, java.lang.String name)` Removes an attribute with specified namespace and name from this element's attribute list.
`void`	`removeDefaultPrefix()` Removes the default prefix mapping on this node (if any).
`void`	`removeMark()` Removes the operation attribute from a node.
`void`	`removeMarks()` Removes all operation attributes from a sub-tree.
`void`	`removePrefix(java.lang.String prefix)` Removes a prefix map from the context node.
`Attribute`	`setAttr(java.lang.String name, java.lang.String value)` Sets an attribute on this element, treating xmlns attributes as prefix maps.
`Attribute`	`setAttr(java.lang.String ns, java.lang.String name, java.lang.String value)` Sets an attribute on this element, aware of its namespace.
`static void`	`setDebugLevel(int level)`
`void`	`setDefaultPrefix()` Sets the default prefix mapping on this node.
`void`	`setPrefix(Prefix prefix)` Sets a prefix map to the context node.
`void`	`setPrefix(PrefixMap prefixMap)` Sets prefix mappings to the context node.
`void`	`setPrefix(java.lang.String prefix)` Sets a prefix mapping to the context node.
`void`	`setValue(java.lang.Object value)` Sets a new value for this node element.
`void`	`setValue(java.lang.String pathStr, java.lang.Object value)` Sets value for all node elements matching specified path string.
`Tagpath`	`tagpath()` Return the full tagpath for this Element
`java.lang.String`	`toString()` Builds a string with the name, value, namespace, prefixes, other attributes, children and the path of this element subtree.
`java.lang.String`	`toXMLString()` This will format the tree as an XML string, which can be printed.
`void`	`writeFile(java.lang.String filename)` Write this configuration tree to a file.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NETCONF_NAMESPACE
```
public static final java.lang.String NETCONF_NAMESPACE
```
    The NETCONF namespace. "urn:ietf:params:xml:ns:netconf:base:1.0".
    
    See Also:
    
    Constant Field Values
  - OPERATION
```
public static final java.lang.String OPERATION
```
    See Also:
    
    Constant Field Values
  - namespace
```
public java.lang.String namespace
```
    The namespace this element name belongs to.
  - name
```
public java.lang.String name
```
    The name of the node.
  - value
```
public java.lang.Object value
```
    The value of the element.
  - prefixes
```
public PrefixMap prefixes
```
    Prefix map are really xmlns attributes. For example:
    xmlns="http:tail-f.com/aaa" or xmlns:aaa="http:tail-f.com/aaa"
  - defaultPrefixes
```
public static final PrefixMap defaultPrefixes
```
    Static prefix map that is always a default and will be resolved at root level. For example the NETCONF prefix mapping "nc" is added here as a default.
  - children
```
protected NodeSet children
```
    Children to the node, if container element.
  - parent
```
protected Element parent
```
    The parent to this node.
  - CREATE_NEW
```
public static final int CREATE_NEW
```
    Creates a new path. This is a value for mode in createPath(int, String).
    
    See Also:
    
    Constant Field Values
  - CREATE_MERGE
```
public static final int CREATE_MERGE
```
    Creates a new path and merges with the existing nodes when possible. This is a value for mode in createPath(int, String).
    
    See Also:
    
    Constant Field Values
  - CREATE_MERGE_MULTI
```
public static final int CREATE_MERGE_MULTI
```
    Creates a new path and merges with the existing nodes when possible. Several nodes may me matching the path, and a sub-tree will be created for all of them. This is a value for mode in createPath(int, String).
    
    See Also:
    
    Constant Field Values
  - OP_CREATE
```
public static final int OP_CREATE
```
    Operation flag to be used with merge(Element,int).
    
    See Also:
    
    Constant Field Values
  - OP_DELETE
```
public static final int OP_DELETE
```
    Operation flag to be used with merge(Element,int).
    
    See Also:
    
    Constant Field Values
  - OP_REPLACE
```
public static final int OP_REPLACE
```
    Operation flag to be used with merge(Element,int).
    
    See Also:
    
    Constant Field Values
  - OP_MERGE
```
public static final int OP_MERGE
```
    Operation flag to be used with merge(Element,int).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Element
```
public Element(java.lang.String ns,
               java.lang.String name)
```
    Constructor that creates a new element tree. An element consists of a name that belongs to a namespace.
    
    Parameters:
    
    ns - Namespace
    
    name - Name of the element
- Method Detail
  - getRootElement
```
public Element getRootElement()
```
  - create
```
public static Element create(java.lang.String namespace,
                             java.lang.String pathStr)
                      throws JNCException
```
    Static method that creates a new configuration element tree given a path. A prefix mapping for the namespace will be added to the top element of the created sub-tree. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    namespace - Namespace
    
    pathStr - A "path create" string
    
    Returns:
    
    A new configuration element tree
    
    Throws:
    
    JNCException
  - create
```
public static Element create(Prefix prefix,
                             java.lang.String pathStr)
                      throws JNCException
```
    Static method that creates a new configuration element tree, given a path. A prefix mapping will be added to the top element of the created sub-tree. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    prefix - A prefix mapping.
    
    pathStr - A "path create" string
    
    Returns:
    
    A new configuration element tree
    
    Throws:
    
    JNCException
  - create
```
public static Element create(PrefixMap prefixMap,
                             java.lang.String pathStr)
                      throws JNCException
```
    Static method that creates a new configuration element tree, given a path. A prefix map will be added to the top element in the created sub-tree. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    prefixMap - Prefix mappings to be added
    
    pathStr - A "path create" string
    
    Returns:
    
    A new configuration element tree
    
    Throws:
    
    JNCException
  - createChild
```
public Element createChild(java.lang.String name)
```
    Creates a child element to the context node.
    
    Parameters:
    
    name - The name of the child element
  - createChild
```
public Element createChild(java.lang.String name,
                           java.lang.Object value)
```
    Creates a child element with specified value.
    
    Parameters:
    
    name - The name of the child element
    
    value - The value of the element
  - createChild
```
public Element createChild(java.lang.String namespace,
                           java.lang.String name,
                           java.lang.Object value)
```
    Creates a child element with specified value.
    
    Parameters:
    
    namespace - The namespace that the name belongs to
    
    name - The name of the child element
    
    value - The value of the element
  - getElementPath
```
public java.lang.String getElementPath(java.lang.String subPath)
```
    Returns the path for this element including an appended sub-path.
    
    Parameters:
    
    subPath - A sub-path to be appended to the current path
  - createPath
```
public Element createPath(java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node from a create path expression.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - createPath
```
public Element createPath(int mode,
                          java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node from a create path expression. The mode parameter is one of: CREATE_NEW, CREATE_MERGE, CREATE_MERGE_MULTI
    
    Parameters:
    
    mode - The creation mode.
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - createPath
```
public Element createPath(java.lang.String namespace,
                          java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node from a create path expression. A prefix map containing the provided namespace will be added to the context nodes prefix mapping. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    namespace - Namespace.
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - createPath
```
public Element createPath(Prefix prefix,
                          java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node from a create path expression. A prefix containing the provided prefix mapping will be added to the context nodes prefix mappings. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    prefix - A prefix mapping
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - createPath
```
public Element createPath(PrefixMap addPrefixes,
                          java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node from a create path expression. A prefix map containing prefix mappings will be added to the context nodes prefix mappings. A prefix map is used for resolving prefix to namespace mappings for a given path.
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    addPrefixes - Prefix mappings
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - createPath
```
public Element createPath(int mode,
                          PrefixMap addPrefixes,
                          java.lang.String pathStr)
                   throws JNCException
```
    Creates an element tree as a child to the context node. A prefix map containing prefix mappings will be added to the context nodes prefix mappings. A prefix map is used for resolving prefix to namespace mappings for a given path.
    The mode parameter is one of: CREATE_NEW, CREATE_MERGE, CREATE_MERGE_MULTI
    See PathCreate for more information about path create expressions.
    
    Parameters:
    
    mode - The creation mode.
    
    addPrefixes - Prefix mappings
    
    pathStr - A "path create" string.
    
    Returns:
    
    A new configuration element sub-tree that is a child of the context node
    
    Throws:
    
    JNCException
  - setDefaultPrefix
```
public void setDefaultPrefix()
```
    Sets the default prefix mapping on this node. xmlns= 'NAMESPACE' A prefix mapping is used for resolving prefix to namespace mappings for a given path.
  - removeDefaultPrefix
```
public void removeDefaultPrefix()
```
    Removes the default prefix mapping on this node (if any). xmlns= 'NAMESPACE' A prefix mapping is used for resolving prefix to namespace mappings for a given path.
  - setPrefix
```
public void setPrefix(java.lang.String prefix)
```
    Sets a prefix mapping to the context node. A prefix map is used for resolving prefix to namespace mappings for a given path.
    
    Parameters:
    
    prefix - String prefix to be used for the namespace.
  - setPrefix
```
public void setPrefix(Prefix prefix)
```
    Sets a prefix map to the context node. A prefix map is used for resolving prefix to namespace mappings for a given path.
    
    Parameters:
    
    prefix - A prefix mapping
  - setPrefix
```
public void setPrefix(PrefixMap prefixMap)
```
    Sets prefix mappings to the context node. A prefix map is used for resolving prefix to namespace mappings for a given path.
    
    Parameters:
    
    prefixMap - Prefix mappings
  - removePrefix
```
public void removePrefix(java.lang.String prefix)
```
    Removes a prefix map from the context node.
  - getParent
```
public Element getParent()
```
    Returns the parent node of this node. Or null if none.
    
    Returns:
    
    Parent configuration element node or null
  - addChild
```
public void addChild(Element child)
```
    Adds child to children and makes this element the parent of child.
    
    Parameters:
    
    child - Child element to be added
  - insertChild
```
public int insertChild(Element child)
                throws JNCException
```
    Inserts a child element and returns the position of (the first occurrence of) the inserted child in the list of children.
    Checks that child is not already in use.
    
    Parameters:
    
    child - Child element to be inserted
    
    Throws:
    
    JNCException - If child is already a child of another element or if child equals this element
  - insertChild
```
public int insertChild(Element child,
                       int index)
                throws JNCException
```
    Inserts a child element at a specific index in the list of children and returns that index upon success.
    
    Parameters:
    
    child - Child element to be inserted
    
    index - Position in child list to insert child to. 0 is the first.
    
    Throws:
    
    JNCException - If child is already a child of another element.
  - insertChild
```
public int insertChild(Element child,
                       java.lang.String[] childrenNames)
                throws JNCException
```
    Inserts a child element at the correct position by providing structure information (the names of all the children, in order).
    
    Parameters:
    
    child - Child element to be inserted
    
    childrenNames - The names of all children in order.
    
    Throws:
    
    JNCException - If child is already a child of another element.
  - insertFirst
```
public int insertFirst(Element child)
                throws JNCException
```
    Inserts a child element first in the list of children. Always returns 0.
    
    Parameters:
    
    child - Child element to be inserted
    
    Throws:
    
    JNCException - If child is already a child of another element.
  - insertLast
```
public int insertLast(Element child)
               throws JNCException
```
    Inserts a child element last in the list of children. Returns the position of the inserted child.
    
    Parameters:
    
    child - Child element to be inserted
    
    Throws:
    
    JNCException - If child is already a child of another element or if child equals this element
  - position
```
public int position()
```
    Returns the position of this element in the the parent child list. '0' is the first position.
  - delete
```
public NodeSet delete(java.lang.String pathStr)
               throws JNCException
```
    Deletes child node(s). All children matching the path string will be deleted. An array of the deleted children is returned.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string for children that will be deleted
    
    Returns:
    
    An array of the deleted element nodes.
    
    Throws:
    
    JNCException
  - delete
```
public void delete()
```
    Deletes this node. Means that the parent will no longer have reference to us. This node will be removed from our parents child list. This method will not do anything if this node is the root node of a tree.
  - deleteChild
```
public void deleteChild(Element child)
```
    Deletes a child node, provided it is present in the children list.
    
    Parameters:
    
    child - Child to delete
  - hasChildren
```
public boolean hasChildren()
```
    Returns true if this node has any children, false otherwise.
    
    Returns:
    
    true or false
  - addAttr
```
public void addAttr(Attribute attr)
```
    Adds an attribute for this element.
  - getAttrs
```
public Attribute[] getAttrs()
```
    Gets all attributes for this element.
    
    Returns:
    
    An array of configuration attributes or null
  - getAttrValue
```
public java.lang.String getAttrValue(java.lang.String name)
```
    Returns the string value of the named attribute. Returns null if no such attribute is found or "" if no value is given to the attribute.
    
    Parameters:
    
    name - The name of the attribute
    
    Returns:
    
    String value of the attribute.
  - getAttr
```
public Attribute getAttr(java.lang.String name)
```
    Gets an Attribute
    
    Parameters:
    
    name - Lookup using the name of attribute
  - setAttr
```
public Attribute setAttr(java.lang.String name,
                         java.lang.String value)
```
    Sets an attribute on this element, treating xmlns attributes as prefix maps. If the attribute already exists, its value is changed, otherwise the attribute is added.
    
    Parameters:
    
    name - The name of the attribute
    
    value - The value of the attribute
    
    Returns:
    
    The configuration attribute.
  - setAttr
```
public Attribute setAttr(java.lang.String ns,
                         java.lang.String name,
                         java.lang.String value)
```
    Sets an attribute on this element, aware of its namespace. If an attribute with this name and ns already exists, its value is changed. Otherwise such an attribute is added.
    If name starts with xmlns and ns starts with the xmlns namespace (http://www.w3.org/2000/xmlns/), the value is set as a prefix map.
    
    Parameters:
    
    ns - The namespace that the attribute name belongs to
    
    name - The name of the attribute
    
    value - The value of the attribute
    
    Returns:
    
    The configuration attribute.
  - removeAttr
```
public void removeAttr(java.lang.String name)
```
    Removes an attribute with specified name. This method does not consider namespace so note that it will remove the first attribute which matches the name (and no other).
    
    Parameters:
    
    name - The name of the attribute to be removed.
  - removeAttr
```
public void removeAttr(java.lang.String namespace,
                       java.lang.String name)
```
    Removes an attribute with specified namespace and name from this element's attribute list.
    
    Parameters:
    
    namespace - the namespace the name belongs to.
    
    name - The name of the attribute to be removed.
  - getValueOfChild
```
public java.lang.Object getValueOfChild(java.lang.String childName)
```
    Finds the value of child with specified name, if it exists.
    
    Parameters:
    
    childName - Name of child
    
    Returns:
    
    Value of child, or null if none
  - getValue
```
public java.lang.Object getValue()
```
    Returns the value of this element.
    
    Returns:
    
    The value of the element.
  - exists
```
public boolean exists(java.lang.String pathStr)
               throws JNCException
```
    Check if any nodes in this element matches a given path string.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - The path to match
    
    Returns:
    
    true if any node matches pathStr; false otherwise.
    
    Throws:
    
    JNCException
  - getValue
```
public java.lang.Object getValue(java.lang.String pathStr)
                          throws JNCException
```
    Returns the value of a the first subnode matching a given path string, or null if there are no matches.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find node
    
    Returns:
    
    The value of the (first) found element or null
    
    Throws:
    
    JNCException
  - getValues
```
public java.lang.Object[] getValues(java.lang.String pathStr)
                             throws JNCException
```
    Returns the value(s) of nodes in a given path expression.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Returns:
    
    An array of the values of the element nodes found by the expression (or null)
    
    Throws:
    
    JNCException
  - getValuesAsSet
```
public java.util.Set<java.lang.String> getValuesAsSet(java.lang.String pathStr)
                                               throws JNCException
```
    Returns the values of nodes in a given path expression.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Returns:
    
    A set with the values of the element nodes found by the expression (or null)
    
    Throws:
    
    JNCException
  - setValue
```
public void setValue(java.lang.Object value)
```
    Sets a new value for this node element.
    
    Parameters:
    
    value - Value to be set
  - setValue
```
public void setValue(java.lang.String pathStr,
                     java.lang.Object value)
              throws JNCException
```
    Sets value for all node elements matching specified path string.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    value - Value to be set
    
    Throws:
    
    JNCException
  - deleteValue
```
public void deleteValue(java.lang.String pathStr)
                 throws JNCException
```
    Deletes value of node(s)
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Throws:
    
    JNCException
  - deleteValue
```
public void deleteValue()
```
    Deletes the value for this node.
  - getFirst
```
public Element getFirst(java.lang.String pathStr)
                 throws JNCException
```
    Returns first node that matches the path expression, or null if no such node was found.
    Example:
```
      Element full = NetconfSession:getConfig();
 
      Element first_host = full.getFirst("/hosts/host");
      Element last_host = full.getLast("/hosts/host");
 
```
    See Path for more information about path expressions.
    Parameters:
    
    pathStr - Path string to find nodes
    
    Returns:
    
    The first element node found by the expression.
    
    Throws:
    
    JNCException
  - getLast
```
public Element getLast(java.lang.String pathStr)
                throws JNCException
```
    Returns the last node that matches the path expression, or null if no such node was found.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Returns:
    
    The last element node found by the expression.
    
    Throws:
    
    JNCException
  - get
```
public NodeSet get(java.lang.String pathStr)
            throws JNCException
```
    Gets all nodes matching a given path expression.
    Example:
```
 Element full_config = session.get();
 NodeSet calle_nodes = full_config.get("host[www='Calle']");
 
```
    See Path for more information about path expressions.
    Parameters:
    
    pathStr - Path string to find nodes
    
    Returns:
    
    An array of the element nodes found by the expression.
    
    Throws:
    
    JNCException
  - getChildren
```
public NodeSet getChildren()
```
    Returns the children of this node.
    
    Returns:
    
    The children node set of this node or null
  - getChildren
```
public NodeSet getChildren(java.lang.String name)
```
    Get the children with specified name, from children list
    
    Parameters:
    
    name - Name of child
    
    Returns:
    
    a NodeSet with all chldren that has the name
  - getChild
```
public Element getChild(java.lang.String name)
```
    Get the (first) child with specified name, from children list
    
    Parameters:
    
    name - Name of child
    
    Returns:
    
    The found element or null
  - clone
```
public java.lang.Object clone()
```
    Clones the tree, making an exact copy. The entire tree is treated as if it was created.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A copy of the element sub-tree.
  - getChild
```
protected Element getChild(Element child)
```
    Tries to find an element with the same namespace and name as x.
    
    Parameters:
    
    child - Element to compare against
    
    Returns:
    
    the matching element if it exists; null otherwise.
  - cloneShallow
```
protected Element cloneShallow()
```
    Clones the tree, making an exact copy. Does only clone this level. not the children.
    
    Returns:
    
    A copy of the shallow element sub-tree.
  - merge
```
public Element merge(Element root,
                     int op)
              throws JNCException
```
    Merges a subtree into a resulting target subtree. The 'op' parameter controls how the nodes that are added in the target subtree should be marked. Either OP_CREATE, OP_DELETE, OP_MERGE or OP_REPLACE.
    
    Parameters:
    
    root - Target subtree. Must start from root node.
    
    op - One of OP_CREATE, OP_DELETE, OP_MERGE or OP_REPLACE
    
    Returns:
    
    Resulting target subtrees in NodeSet
    
    Throws:
    
    JNCException
  - cloneAttrs
```
protected Element cloneAttrs(Element copy)
```
    Clones the attributes to the target copy. Used in clone methods of this class and YangElement.
    
    Parameters:
    
    copy - The target copy to clone the attributes to
  - cloneValue
```
protected Element cloneValue(Element copy)
```
    clones the value to the target copy. Used in clone methods of this class and YangElement.
    
    Parameters:
    
    copy - The target copy to clone the value field to
  - removeMark
```
public void removeMark()
```
    Removes the operation attribute from a node. This is eqvivalent to: removeAttr(Element.NETCONF_NAMESPACE,"operation"); see @removeAttr
  - removeMarks
```
public void removeMarks()
```
    Removes all operation attributes from a sub-tree.
  - markDelete
```
public void markDelete()
```
    Marks a node with operation delete.
  - markDelete
```
public void markDelete(java.lang.String pathStr)
                throws JNCException
```
    Marks node(s) with operation delete.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Throws:
    
    JNCException
  - markReplace
```
public void markReplace()
```
    Marks a node with operation replace.
  - markReplace
```
public void markReplace(java.lang.String pathStr)
                 throws JNCException
```
    Marks node(s) with operation replace.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Throws:
    
    JNCException
  - markMerge
```
public void markMerge()
```
    Marks a node with operation merge.
  - markMerge
```
public void markMerge(java.lang.String pathStr)
               throws JNCException
```
    Marks node(s) with operation merge.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Throws:
    
    JNCException
  - markCreate
```
public void markCreate()
```
    Marks a node with operation create
  - markCreate
```
public void markCreate(java.lang.String pathStr)
                throws JNCException
```
    Marks node(s) with operation create.
    See Path for more information about path expressions.
    
    Parameters:
    
    pathStr - Path string to find nodes
    
    Throws:
    
    JNCException
  - qualifiedName
```
public java.lang.String qualifiedName()
```
    A qualified name is a prefixed name. This method will find the prefix of this elements namespace and build a name in the format: "prefix:name". If no prefix is found the prefix "unknown" will be used.
    
    Returns:
    
    The qualified name of the element.
  - prefix
```
public java.lang.String prefix()
```
    Returns the prefix name of this element.
    
    Returns:
    
    The prefix name that the namespace of this element is bound to
  - getContextPrefixMap
```
public PrefixMap getContextPrefixMap()
```
    Returns a prefix map, as it is in the current context. The prefix map is built up by traversing the parents.
    
    Returns:
    
    The prefix mappings available at this context node
  - lookupContextPrefix
```
public java.lang.String lookupContextPrefix(java.lang.String prefix)
```
    Lookups a prefix and returns the associated namespace, traverses up the parent links until the prefix is found. Returns null if the prefix is not found.
    
    Parameters:
    
    prefix - Prefix string to lookup.
    
    Returns:
    
    The namespace of the specified prefix in the context of this node.
  - nsToPrefix
```
public java.lang.String nsToPrefix(java.lang.String ns)
```
    This method will find the prefix of a specified namespace, from the given context node. If no prefix is found null will be returned.
    
    Parameters:
    
    ns - Namespace string to lookup
    
    Returns:
    
    The prefix string of the given namespace at the context node.
  - getElementPath
```
public java.lang.String getElementPath()
```
    Returns the path as a string
    
    Returns:
    
    The path of element
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compare if equal to another Object. This method does not compare attributes and children. It will only compare:
    - name
    - namespace
    - value
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - Object to compare this element against.
    
    Returns:
    
    true if other is an Element with same name, namespace and value; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The sum of the hash codes of the name, namespace and value of this element subtree node.
  - compare
```
public int compare(Element b)
```
    Compare two elements. Compares the name, namespace, and value. Returns:
    - -1 - if the two containers keys are not equal, which means that they are completely different.
    - 0 - if the two elements are equal in name, namespace, and value.
    - 1 - the two containers are the same except the value.
    Parameters:
    
    b - Element to compare this element against.
  - toString
```
public java.lang.String toString()
```
    Builds a string with the name, value, namespace, prefixes, other attributes, children and the path of this element subtree.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String representation of this element
  - toXMLString
```
public java.lang.String toXMLString()
```
    This will format the tree as an XML string, which can be printed. The XML code is nicely indented.
    
    Returns:
    
    This element sub-tree represented as an XML string
  - encode
```
protected void encode(Transport out)
               throws JNCException
```
    Encode to XML and send it to the provided stream. Similar to the toXMLString(), but without the pretty printing.
    Equivalent to calling encode(out, true, null);
    
    Parameters:
    
    out - Stream to send the encoded version of this element to.
    
    Throws:
    
    JNCException - If a YangElement encode implementation fails
  - encode
```
protected void encode(Transport out,
                      Capabilities c)
               throws JNCException
```
    Encode to XML and send it to the provided stream. Similar to the toXMLString(), but without the pretty printing.
    Equivalent to calling encode(out, true, c);
    
    Parameters:
    
    out - Stream to send the encoded version of this element to.
    
    c - Capabilities, used by YangElement instances.
    
    Throws:
    
    JNCException - If a YangElement encode implementation fails.
  - encode
```
protected void encode(Transport out,
                      boolean newline_at_end)
               throws JNCException
```
    Encode to XML and send it to the provided stream. Similar to the toXMLString(), but without the pretty printing.
    The newline_at_end argument controls whether a newline char is permitted at the end or not.
    Equivalent to calling encode(out, newline_at_end, null);
    
    Parameters:
    
    out - Stream to send the encoded version of this element to.
    
    newline_at_end - If 'true' a newline is printed at the end.
    
    Throws:
    
    JNCException - If a YangElement encode implementation fails.
  - encode
```
protected void encode(Transport out,
                      boolean newline_at_end,
                      Capabilities capas)
               throws JNCException
```
    Encode to XML and send it to the provided stream. Similar to the toXMLString(), but without the pretty printing.
    The newline_at_end argument controls whether a newline char is permitted at the end or not.
    
    Parameters:
    
    out - Stream to send the encoded version of this element to.
    
    newline_at_end - If 'true' a newline is printed at the end.
    
    c - Capabilities, used by YangElement instances.
    
    Throws:
    
    JNCException - If a YangElement encode implementation fails.
  - tagpath
```
public Tagpath tagpath()
```
    Return the full tagpath for this Element
    
    Returns:
    
    Absolute tagpath to this node
  - iterator
```
public ElementChildrenIterator iterator()
```
    Return an iterator for the children of this node.
    
    Returns:
    
    A new iterator over this element's children
  - iterator
```
public ElementChildrenIterator iterator(java.lang.String name)
```
    Return an iterator for the children of a specified name of this node.
    Example usage:
```
 ElementChildrenIterator hostIter = config.iterator("host");
 while (hostIter.hasNext()) {
     Element host = hostIter.next();
     System.out.println("Host: " + host);
 }
 
```
    Parameters:
    
    name - A filter name, return only children with this name.
    
    Returns:
    
    A new iterator over this element's children with specified name
  - writeFile
```
public void writeFile(java.lang.String filename)
               throws java.io.IOException
```
    Write this configuration tree to a file. The configuration tree is written as XML text.
    
    Parameters:
    
    filename - File name.
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    readFile(String)
  - readFile
```
public static Element readFile(java.lang.String filename)
                        throws JNCException
```
    Read file with XML text and parse it into a configuration tree.
    
    Parameters:
    
    filename - File name.
    
    Throws:
    
    JNCException
    
    See Also:
    
    writeFile(String)
  - setDebugLevel
```
public static void setDebugLevel(int level)
```

Class Element

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NETCONF_NAMESPACE

OPERATION

namespace

name

value

prefixes

defaultPrefixes

children

parent

CREATE_NEW

CREATE_MERGE

CREATE_MERGE_MULTI

OP_CREATE

OP_DELETE

OP_REPLACE

OP_MERGE

Constructor Detail

Element

Method Detail

getRootElement

create

create

create

createChild

createChild

createChild

getElementPath

createPath

createPath

createPath

createPath

createPath

createPath

setDefaultPrefix

removeDefaultPrefix

setPrefix

setPrefix

setPrefix

removePrefix

getParent

addChild

insertChild

insertChild

insertChild

insertFirst

insertLast

position

delete

delete

deleteChild

hasChildren

addAttr

getAttrs

getAttrValue

getAttr

setAttr

setAttr

removeAttr

removeAttr

getValueOfChild

getValue

exists

getValue

getValues

getValuesAsSet

setValue

setValue

deleteValue

deleteValue

getFirst

getLast

get

getChildren

getChildren