Token (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.xml.xpath.Token

All Implemented Interfaces:

XNode, Comparable<XNode>
```
public final class Token
extends Object
implements XNode
```
Synthetic text-like XNode returned by tokenize().

Nested Class Summary
- Nested classes/interfaces inherited from interface com.xmlmind.xml.doc.XNode
  XNode.Type

Field Summary

Fields
Modifier and Type Field and Description

XNode document

String text

Fields
Modifier and Type	Field and Description
`XNode`	`document`
`String`	`text`

Constructor Summary

Constructors
Constructor and Description

Token(String text, XNode document)

Constructors
Constructor and Description
`Token(String text, XNode document)`

Method Summary

All Methods Instance Methods Concrete 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.
`String`	`toString()`
`XNode.Type`	`type()` Returns the type of this node.

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

- Field Detail
  - text
```
public final String text
```
  - document
```
public final XNode document
```
- Constructor Detail
  - Token
```
public Token(String text,
             XNode document)
      throws EvalException
```
    Throws:
    
    EvalException
- Method Detail
  - type
```
public XNode.Type type()
```
    Description copied from interface: XNode
    
    Returns the type of this node.
    
    Specified by:
    
    type in interface XNode
  - document
```
public XNode document()
```
    Description copied from interface: XNode
    
    Returns the document containing this node.
    
    Specified by:
    
    document in interface XNode
  - parent
```
public XNode parent()
```
    Description copied from interface: XNode
    
    Returns the parent of the node. The parent of an attribute node is an element node. The parent of a document node is null.
    
    Specified by:
    
    parent in interface XNode
  - following
```
public XNode following()
```
    Description copied from interface: XNode
    
    Returns the node following this node. Returns null for an attribute or a document node.
    
    Specified by:
    
    following in interface XNode
  - preceding
```
public XNode preceding()
```
    Description copied from interface: XNode
    
    Returns the node preceding this node. Returns null for an attribute or a document node.
    
    Specified by:
    
    preceding in interface XNode
  - name
```
public Name name()
```
    Description copied from interface: XNode
    
    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.
    
    Specified by:
    
    name in interface XNode
  - data
```
public String data()
```
    Description copied from interface: XNode
    
    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.
    
    Specified by:
    
    data in interface XNode
  - namespacePrefixMap
```
public NamespacePrefixMap namespacePrefixMap()
```
    Description copied from interface: XNode
    
    Returns the NamespacePrefixMap which can be used to map prefixes to namespaces and namespaces to prefixes in the context of this node.
    
    Specified by:
    
    namespacePrefixMap in interface XNode
  - firstChild
```
public XNode firstChild()
```
    Description copied from interface: XNode
    
    Returns the first child node of this element or document node. Returns null for all other types of nodes.
    
    Specified by:
    
    firstChild in interface XNode
  - lastChild
```
public XNode lastChild()
```
    Description copied from interface: XNode
    
    Returns the last child node of this element or document node. Returns null for all other types of nodes.
    
    Specified by:
    
    lastChild in interface XNode
  - attributeValue
```
public String attributeValue(Name name)
```
    Description copied from interface: XNode
    
    Returns the value of attribute having specified name contained in this element node. Returns null if this node is not an element node.
    
    Specified by:
    
    attributeValue in interface XNode
  - attributes
```
public Iterator<XNode> attributes()
```
    Description copied from interface: XNode
    
    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.
    
    Specified by:
    
    attributes in interface XNode
  - equals
```
public boolean equals(Object other)
```
    Description copied from interface: XNode
    
    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).
    
    Specified by:
    
    equals in interface XNode
    
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(XNode other)
```
    Description copied from interface: XNode
    
    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 XNode
    
    Specified by:
    
    compareTo in interface Comparable<XNode>
  - deepCopy
```
public XNode deepCopy()
```
    Description copied from interface: XNode
    
    Returns a deep copy of this node.
    
    Specified by:
    
    deepCopy in interface XNode
  - getSourceURL
```
public URL getSourceURL()
```
    Description copied from interface: XNode
    
    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 XNode.getBaseURL() instead.
    
    Specified by:
    
    getSourceURL in interface XNode
  - getBaseURL
```
public URL getBaseURL()
```
    Description copied from interface: XNode
    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 XNode.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/".
    Specified by:
    
    getBaseURL in interface XNode
  - getLabel
```
public String getLabel()
```
    Description copied from interface: XNode
    
    Returns a string which represents this XNode. This string is used in error messages or in a GUI.
    
    Specified by:
    
    getLabel in interface XNode
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Token

Nested Class Summary

Nested classes/interfaces inherited from interface com.xmlmind.xml.doc.XNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

text

document

Constructor Detail

Token

Method Detail

type

document

parent

following

preceding

name

data

namespacePrefixMap

firstChild

lastChild

attributeValue

attributes

equals

compareTo

deepCopy

getSourceURL

getBaseURL

getLabel

toString