net.sf.practicalxml.builder

Class ElementNode

java.lang.Object

net.sf.practicalxml.builder.Node

net.sf.practicalxml.builder.ElementNode

All Implemented Interfaces:

Serializable

public final class ElementNode
extends Node

The primary class for building XML trees and converting them to different JAXP-centric forms. Callers should not create instances of this class directly; instead use the static factory methods in XmlBuilder.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
ElementNode	addChild(Node child) Adds a child node -- of any type -- to this element.
protected void	appendToElement(Element parent) This method is called internally by ElementNode, to append its children to the DOM subtree rooted at the specified element.
Document	toDOM() Generates a new DOM document with this element as the root.
protected void	toSAX(ContentHandler handler) Invokes the passed ContentHandler for this element and its children.
void	toStream(OutputStream out) Writes the tree rooted at this element to an OutputStream, using UTF-8 encoding, without a prologue or whitepspace between nodes.
void	toStream(OutputStream out, String encoding) Writes the tree rooted at this element to an OutputStream, using a specified encoding, without a prologue or whitepspace between nodes.
String	toString() Generates an XML string, where this node is the root element.
String	toString(int indentSize) Generates an XML string, where this node is the root element.

Methods inherited from class net.sf.practicalxml.builder.Node

getLocalName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addChild

public ElementNode addChild(Node child)

Adds a child node -- of any type -- to this element. Returns this as a convenience to caller, allowing calls to be chained.

toDOM

public Document toDOM()

Generates a new DOM document with this element as the root.

toSAX

protected void toSAX(ContentHandler handler)
              throws SAXException

Invokes the passed ContentHandler for this element and its children. Note that the implementation class must also implement LexicalHandler to receive events from all nodes in the tree (particularly comments).

Overrides:

toSAX in class Node

Throws:

SAXException

toString

public String toString()

Generates an XML string, where this node is the root element. Does not insert whitespace between elements. Note that you must use UTF-8 encoding or add a prologue that specifies encoding when writing this string to a stream.

Overrides:

toString in class Object

toString

public String toString(int indentSize)

Generates an XML string, where this node is the root element. Inserts whitespace between nodes, along with newlines and the specified indent between elements.

This is the best choice for writing log output. If you write this string to a stream, you must use UTF-8 encoding or attach a prologue that specifies the encoding used.

toStream

public void toStream(OutputStream out)

Writes the tree rooted at this element to an OutputStream, using UTF-8 encoding, without a prologue or whitepspace between nodes.

This is the best choice for writing XML that will be read by another party.

toStream

public void toStream(OutputStream out,
            String encoding)

Writes the tree rooted at this element to an OutputStream, using a specified encoding, without a prologue or whitepspace between nodes.

appendToElement

protected void appendToElement(Element parent)

Description copied from class: Node

This method is called internally by ElementNode, to append its children to the DOM subtree rooted at the specified element.

Specified by:

appendToElement in class Node