Class Node

java.lang.Object
org.kxml2.kdom.Node
Direct Known Subclasses:
Document, Element
public class Node extends Object
A common base class for Document and Element, also used for storing XML fragments.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CDSECT
     
    static final int
    COMMENT
     
    static final int
    DOCDECL
     
    static final int
    DOCUMENT
     
    static final int
    ELEMENT
     
    static final int
    ENTITY_REF
     
    static final int
    IGNORABLE_WHITESPACE
     
    static final int
    PROCESSING_INSTRUCTION
     
    static final int
    TEXT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Node()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChild(int index, int type, Object child)
    inserts the given child object of the given type at the given index.
    void
    addChild(int type, Object child)
    convenience method for addChild (getChildCount (), child)
    Element
    createElement(String namespace, String name)
    Builds a default element with the given properties.
    Object
    getChild(int index)
    Returns the child object at the given index.
    int
    getChildCount()
    Returns the number of child objects
    Element
    getElement(int index)
    returns the element at the given index.
    Element
    getElement(String namespace, String name)
    Returns the element with the given namespace and name.
    String
    getText(int index)
    Returns the text node with the given index or null if the node with the given index is not a text node.
    int
    getType(int index)
    Returns the type of the child at the given index.
    int
    indexOf(String namespace, String name, int startIndex)
    Performs search for an element with the given namespace and name, starting at the given start index.
    boolean
    isText(int i)
     
    void
    parse(org.xmlpull.v1.XmlPullParser parser)
    Recursively builds the child elements from the given parser until an end tag or end document is found.
    void
    removeChild(int idx)
    Removes the child object at the given index
    void
    write(org.xmlpull.v1.XmlSerializer writer)
    Writes this node to the given XmlWriter.
    void
    writeChildren(org.xmlpull.v1.XmlSerializer writer)
    Writes the children of this node to the given XmlWriter.

    Methods inherited from class Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • Node

      public Node()

  • Method Details

    • addChild

      public void addChild(int index, int type, Object child)
      inserts the given child object of the given type at the given index.

    • addChild

      public void addChild(int type, Object child)
      convenience method for addChild (getChildCount (), child)

    • createElement

      public Element createElement(String namespace, String name)
      Builds a default element with the given properties. Elements should always be created using this method instead of the constructor in order to enable construction of specialized subclasses by deriving custom Document classes. Please note: For no namespace, please use Xml.NO_NAMESPACE, null is not a legal value. Currently, null is converted to Xml.NO_NAMESPACE, but future versions may throw an exception.

    • getChild

      public Object getChild(int index)
      Returns the child object at the given index. For child elements, an Element object is returned. For all other child types, a String is returned.

    • getChildCount

      public int getChildCount()
      Returns the number of child objects

    • getElement

      public Element getElement(int index)
      returns the element at the given index. If the node at the given index is a text node, null is returned

    • getElement

      public Element getElement(String namespace, String name)
      Returns the element with the given namespace and name. If the element is not found, or more than one matching elements are found, an exception is thrown.

    • getText

      public String getText(int index)
      Returns the text node with the given index or null if the node with the given index is not a text node.

    • getType

      public int getType(int index)
      Returns the type of the child at the given index. Possible types are ELEMENT, TEXT, COMMENT, and PROCESSING_INSTRUCTION

    • indexOf

      public int indexOf(String namespace, String name, int startIndex)
      Performs search for an element with the given namespace and name, starting at the given start index. A null namespace matches any namespace, please use Xml.NO_NAMESPACE for no namespace). returns -1 if no matching element was found.

    • isText

      public boolean isText(int i)

    • parse

      public void parse(org.xmlpull.v1.XmlPullParser parser) throws IOException, org.xmlpull.v1.XmlPullParserException
      Recursively builds the child elements from the given parser until an end tag or end document is found. The end tag is not consumed.
      Throws:
      IOException
      org.xmlpull.v1.XmlPullParserException

    • removeChild

      public void removeChild(int idx)
      Removes the child object at the given index

    • write

      public void write(org.xmlpull.v1.XmlSerializer writer) throws IOException
      Writes this node to the given XmlWriter. For node and document, this method is identical to writeChildren, except that the stream is flushed automatically.
      Throws:
      IOException

    • writeChildren

      public void writeChildren(org.xmlpull.v1.XmlSerializer writer) throws IOException
      Writes the children of this node to the given XmlWriter.
      Throws:
      IOException