XNode (XMLmind XML Editor Java[tm] API)

All Superinterfaces:

Comparable<XNode>

All Known Implementing Classes:

Attribute, Comment, Document, DocumentTypeDeclaration, Element, Node, ProcessingInstruction, Text, TextNode, Token, Tree
```
public interface XNode
extends Comparable<XNode>
```
Models XML nodes. Needed to implement XPath.
Important: Unless you are using XXE XPath facilities, do not program against the XNode interface. Instead program against XXE native DOM, that is, Node, Tree, Document, Element, etc.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class XNode.Type
The type of an XNode as returned by type().

Nested Classes
Modifier and Type	Interface and Description
`static class`	`XNode.Type` The type of an XNode as returned by `type()`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Iterator<XNode>`	`attributes()` Returns iterator over the attributes contained in this element node.
`String`	`attributeValue(Name name)` Returns the value of attribute having specified name contained in this element node.
`int`	`compareTo(XNode other)` Compares this node with specified object which must be an XNode too.
`String`	`data()` Returns the value of this attribute node or the text contained in this text, comment or processing-instruction node.
`XNode`	`deepCopy()` Returns a deep copy of this node.
`XNode`	`document()` Returns the document containing this node.
`boolean`	`equals(Object other)` Tests if this node is equivalent to specified object.
`XNode`	`firstChild()` Returns the first child node of this element or document node.
`XNode`	`following()` Returns the node following this node.
`URL`	`getBaseURL()` Returns the URL which can be used to resolve URLs which are relative to this node.
`String`	`getLabel()` Returns a string which represents this XNode.
`URL`	`getSourceURL()` Returns the URL of the file from which this XNode has been loaded.
`XNode`	`lastChild()` Returns the last child node of this element or document node.
`Name`	`name()` Returns the name of this element node, the name of this attribute node or the target of this processing-instruction node.
`NamespacePrefixMap`	`namespacePrefixMap()` Returns the NamespacePrefixMap which can be used to map prefixes to namespaces and namespaces to prefixes in the context of this node.
`XNode`	`parent()` Returns the parent of the node.
`XNode`	`preceding()` Returns the node preceding this node.
`XNode.Type`	`type()` Returns the type of this node.

- Method Detail
  - type
```
XNode.Type type()
```
    Returns the type of this node.
  - document
```
XNode document()
```
    Returns the document containing this node.
  - parent
```
XNode parent()
```
    Returns the parent of the node. The parent of an attribute node is an element node. The parent of a document node is null.
  - following
```
XNode following()
```
    Returns the node following this node. Returns null for an attribute or a document node.
  - preceding
```
XNode preceding()
```
    Returns the node preceding this node. Returns null for an attribute or a document node.
  - name
```
Name name()
```
    Returns the name of this element node, the name of this attribute node or the target of this processing-instruction node. Returns null for all other types of nodes.
    The target of a processing-instruction has no namespace.
  - data
```
String data()
```
    Returns the value of this attribute node or the text contained in this text, comment or processing-instruction node. Returns null for all other types of nodes.
  - namespacePrefixMap
```
NamespacePrefixMap namespacePrefixMap()
```
    Returns the NamespacePrefixMap which can be used to map prefixes to namespaces and namespaces to prefixes in the context of this node.
  - firstChild
```
XNode firstChild()
```
    Returns the first child node of this element or document node. Returns null for all other types of nodes.
  - lastChild
```
XNode lastChild()
```
    Returns the last child node of this element or document node. Returns null for all other types of nodes.
  - attributeValue
```
String attributeValue(Name name)
```
    Returns the value of attribute having specified name contained in this element node. Returns null if this node is not an element node.
  - attributes
```
Iterator<XNode> attributes()
```
    Returns iterator over the attributes contained in this element node. Returns null if this node is not an element node.
    This iterator does not support the remove method.
  - equals
```
boolean equals(Object other)
```
    Tests if this node is equivalent to specified object. XNodes cannot be tested for equality using == because attribute nodes are synthesized when needed to (that is, they are not real nodes).
    
    Overrides:
    
    equals in class Object
  - compareTo
```
int compareTo(XNode other)
```
    Compares this node with specified object which must be an XNode too. Implements document order comparison, that is, returns -1 if this node precedes the other node in the document; returns 1 this node follows the other node in the document; etc.
    Document order has no meaning for attribute nodes contained in the same element. Attribute nodes contained in the same element are compared by their names.
    The two nodes may belong to two different documents. In such case, the two documents are compared by their URLs.
    
    Specified by:
    
    compareTo in interface Comparable<XNode>
  - deepCopy
```
XNode deepCopy()
```
    Returns a deep copy of this node.
  - getSourceURL
```
URL getSourceURL()
```
    Returns the URL of the file from which this XNode has been loaded. Returns null if such URL is unknown.
    This URL is mainly useful in error messages or in a GUI. If you need to resolve URLs which are relative to this node, use getBaseURL() instead.
  - getBaseURL
```
URL getBaseURL()
```
    Returns the URL which can be used to resolve URLs which are relative to this node. Returns null if such URL is unknown.
    This URL is often the same as the one returned by getSourceURL(), but not always. Example:
```
<root>
   <list xml:base="file:///home/john/">
     <item/><item/><item/>
   </list> 
 </root>
 
```
    If the SourceURL of element root is "file:///tmp/doc.xml", then the SourceURL of element list is also "file:///tmp/doc.xml", but the BaseURL of this element is "file:///home/john/".
  - getLabel
```
String getLabel()
```
    Returns a string which represents this XNode. This string is used in error messages or in a GUI.

Interface XNode

Nested Class Summary

Method Summary

Method Detail

type

document

parent

following

preceding

name

data

namespacePrefixMap

firstChild

lastChild

attributeValue

attributes

equals

compareTo

deepCopy

getSourceURL

getBaseURL

getLabel