com.actional.util

Class DomUtil

java.lang.Object

com.actional.util.DomUtil

public class DomUtil
extends java.lang.Object

Utilities for plugins for managing DOMs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DomUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getContentValue(org.w3c.dom.Element elem) This methods returns the content of the element as a string.
static org.w3c.dom.Element	getElement(org.w3c.dom.Node node, java.lang.String localName) Returns the first child element (if any) of the passed in node whose local name is the one passed in argument.
static org.w3c.dom.Element	getFirstChildElement(org.w3c.dom.Node node) Returns the first child element (if any) of the passed in node.
static org.w3c.dom.Element	getNextElement(org.w3c.dom.Node node) Returns the element (if any) that is following the node that is passed in.
static java.lang.String	getNodeName(org.w3c.dom.Node node) This methods returns the content of the element as a string.
static boolean	isXmlWhiteSpace(byte b) This method returns true if the passed in byte is an XML whitespace character, i.e. one of blank space, tab, cariage return, or line feed.
static org.w3c.dom.Element	parseSettings(java.lang.String settings) Parse the settings string and extract the root Element.
static void	serialize(org.w3c.dom.Document doc, java.io.Writer writer) Deprecated. Explicitly specify the document encoding by using serialize(Document, Writer, String) instead.
static void	serialize(org.w3c.dom.Document doc, java.io.Writer writer, java.lang.String encoding) Serializes the Document and outputs it in the Writer that is passed.
static void	serialize(org.w3c.dom.Element element, java.io.Writer writer, boolean prettyPrint) Deprecated. Explicitly specify the element encoding by using serialize(Element, Writer, String, boolean).
static void	serialize(org.w3c.dom.Element element, java.io.Writer writer, java.lang.String encoding, boolean prettyPrint) See toString(Document, boolean).
private static void	serialize(org.w3c.dom.Node node, org.w3c.dom.Document document, java.io.Writer writer, java.lang.String charset, boolean prettyPrint)
static int	skipSpacesBeforeProlog(byte[] buf) This method is used to figure out whether there are whitespaces to be skipped before the XML prolog.
static java.lang.String	toString(org.w3c.dom.Document doc) Serializes the Document into a String.
static java.lang.String	toString(org.w3c.dom.Document doc, boolean prettyPrint) Serializes the Document into a String.
static java.lang.String	toString(org.w3c.dom.Document doc, java.lang.String charsetName, boolean prettyPrint) Serializes the Document into a String.
static java.lang.String	toString(org.w3c.dom.Element element) Serializes the Element into a String.
static java.lang.String	toString(org.w3c.dom.Element element, boolean indent) Serializes the Element into a String.
static java.lang.String	toString(org.w3c.dom.Node node) Serializes the Node into a String.
static java.lang.String	toString(java.lang.Object node)
static java.lang.String	toStringUnwrap(org.w3c.dom.Element element) Serializes the Element into a String.
static java.lang.String	toStringUnwrap(org.w3c.dom.Element element, boolean format) Serializes the Element into a String.
static java.lang.String	toStringUnwrap(org.w3c.dom.Node node) Serializes the Node into a String.
static void	turnOffValidation(javax.xml.parsers.DocumentBuilderFactory factory) This method allows turning off downloading external DTDs as well as turning off DTD validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomUtil

protected DomUtil()

Method Detail

turnOffValidation

public static void turnOffValidation(javax.xml.parsers.DocumentBuilderFactory factory)

This method allows turning off downloading external DTDs as well as turning off DTD validation.

Most of our code should call this method on their DocumentBuilderFactory to avoid runtime failures due to network failures that might happen.

getFirstChildElement

public static final org.w3c.dom.Element getFirstChildElement(org.w3c.dom.Node node)

Returns the first child element (if any) of the passed in node.

Parameters:

node - - a Node

Returns:

Element

getNextElement

public static final org.w3c.dom.Element getNextElement(org.w3c.dom.Node node)

Returns the element (if any) that is following the node that is passed in.

Parameters:

node - - a Node

Returns:

Element

getElement

public static final org.w3c.dom.Element getElement(org.w3c.dom.Node node,
                                                   java.lang.String localName)

Returns the first child element (if any) of the passed in node whose local name is the one passed in argument.

Parameters:

node - - a Node

Returns:

Element

getNodeName

public static final java.lang.String getNodeName(org.w3c.dom.Node node)

This methods returns the content of the element as a string. If the element contains nodes that are not text or CDATA, an exception is thrown.

Returns:

String

getContentValue

public static final java.lang.String getContentValue(org.w3c.dom.Element elem)

This methods returns the content of the element as a string. If the element contains nodes that are not text or CDATA, an exception is thrown.

Parameters:

elem - - an Element

Returns:

String

serialize

@Deprecated
public static final void serialize(org.w3c.dom.Document doc,
                                                java.io.Writer writer)
                                         throws java.io.IOException

Deprecated. Explicitly specify the document encoding by using serialize(Document, Writer, String) instead.

Serializes the Document and outputs it in the Writer that is passed. This method assumes UTF-8 for the encoding of the document

Parameters:

doc - the Document

writer - the Writer

Throws:

java.io.IOException

serialize

public static final void serialize(org.w3c.dom.Document doc,
                                   java.io.Writer writer,
                                   java.lang.String encoding)
                            throws java.io.IOException

Serializes the Document and outputs it in the Writer that is passed.

Parameters:

doc - the Document

writer - the Writer

encoding - the encoding of the document

Throws:

java.io.IOException

serialize

private static void serialize(org.w3c.dom.Node node,
                              org.w3c.dom.Document document,
                              java.io.Writer writer,
                              java.lang.String charset,
                              boolean prettyPrint)
                       throws java.io.IOException

Throws:

java.io.IOException

serialize

public static final void serialize(org.w3c.dom.Element element,
                                   java.io.Writer writer,
                                   java.lang.String encoding,
                                   boolean prettyPrint)
                            throws java.io.IOException

See toString(Document, boolean).

Throws:

java.io.IOException

serialize

@Deprecated
public static final void serialize(org.w3c.dom.Element element,
                                                java.io.Writer writer,
                                                boolean prettyPrint)
                                         throws java.io.IOException

Deprecated. Explicitly specify the element encoding by using serialize(Element, Writer, String, boolean).

See toString(Document, boolean).

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Document doc)
                                       throws java.io.IOException

Serializes the Document into a String.

Parameters:

doc - the Document

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Document doc,
                                              boolean prettyPrint)
                                       throws java.io.IOException

Serializes the Document into a String. The stringified document matches is a faithful representation of the one being passed-in: no namespace fixup is made. This method assumes that the charset of the document is UTF-8.

Parameters:

doc - the document

prettyPrint - format the output by adding whitespace to produce a pretty-printed, indented, human-readable form

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Document doc,
                                              java.lang.String charsetName,
                                              boolean prettyPrint)
                                       throws java.io.IOException

Serializes the Document into a String. The stringified document matches is a faithful representation of the one being passed-in: no namespace fixup is made. This method assumes that the charset of the document is UTF-8.

Parameters:

doc - the document

charsetName - the character set of the document

prettyPrint - format the output by adding whitespace to produce a pretty-printed, indented, human-readable form

Throws:

java.io.IOException

toStringUnwrap

public static final java.lang.String toStringUnwrap(org.w3c.dom.Element element)
                                             throws java.io.IOException

Serializes the Element into a String.
If the element does not have sub-elements, the string returned does not contain the tag of the element, only its content (i.e. the text). Otherwise, the string returned contains both tag of the element as well as its sub-elements.

Throws:

java.io.IOException

toStringUnwrap

public static final java.lang.String toStringUnwrap(org.w3c.dom.Element element,
                                                    boolean format)
                                             throws java.io.IOException

Serializes the Element into a String.
If the element does not have sub-elements, the string returned does not contain the tag of the element, only its content (i.e. the text). Otherwise, the string returned contains both tag of the element as well as its sub-elements.

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Element element)
                                       throws java.io.IOException

Serializes the Element into a String.

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Element element,
                                              boolean indent)
                                       throws java.io.IOException

Serializes the Element into a String.

Throws:

java.io.IOException

toStringUnwrap

public static final java.lang.String toStringUnwrap(org.w3c.dom.Node node)
                                             throws java.io.IOException

Serializes the Node into a String. If the node is an element and the element does not have sub-elements, the string returned does not contain the tag of the element, only its content (i.e. the text). Otherwise, the string returned contains both tag of the element as well as its sub-elements.

Parameters:

node - the Node

Throws:

java.io.IOException

toString

public static final java.lang.String toString(org.w3c.dom.Node node)
                                       throws java.io.IOException

Serializes the Node into a String.

Parameters:

node - the Node

Throws:

java.io.IOException

toString

public static final java.lang.String toString(java.lang.Object node)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseSettings

public static org.w3c.dom.Element parseSettings(java.lang.String settings)
                                         throws java.lang.Exception

Parse the settings string and extract the root Element.

Parameters:

settings - The settings String

Returns:

Element

Throws:

java.lang.Exception

skipSpacesBeforeProlog

public static int skipSpacesBeforeProlog(byte[] buf)

This method is used to figure out whether there are whitespaces to be skipped before the XML prolog. If there are whitespaces, then the offset of where the XML prolog starts is returned by the method. If there is no XML prolog, then the beginning of the buffer is returned.
This method is called when you need to be backward compatible with clients that are not XML 1.1 compliant. Indeed, it is clearly said in the specifications that if there is an XML prolog, it has to be the very first character of the XML document. However, some older clients do not respect that rule hence the next to call this method.

isXmlWhiteSpace

public static boolean isXmlWhiteSpace(byte b)

This method returns true if the passed in byte is an XML whitespace character, i.e. one of blank space, tab, cariage return, or line feed.