org.fujion.common

Class XMLUtil

java.lang.Object

org.fujion.common.XMLUtil

public class XMLUtil
extends Object

Utility methods for managing XML documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLUtil.TagFormat Tag format options.

Method Summary

Modifier and Type	Method and Description
static String	formatAttributes(Node node) Returns formatted attributes of the node.
static String	formatNodeName(Node node, XMLUtil.TagFormat format) Returns the formatted name for the node.
static DocumentBuilder	newDocumentBuilder(boolean nsAware) Returns a new document builder instance.
static Document	parseXMLFromList(Iterable<String> xml) Parses XML from a list of strings.
static Document	parseXMLFromLocation(String filePath) Parses XML from a file.
static Document	parseXMLFromSource(InputSource source) Parses XML from an input source.
static Document	parseXMLFromStream(InputStream stream) Parses XML from an input stream.
static Document	parseXMLFromString(String xml) Parses XML from a string.
static String	toString(Document doc) Converts an XML document to a formatted XML string.
static String	toString(Document doc, int indent) Converts an XML document to a formatted XML string.

Methods inherited from class java.lang.Object

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

Method Detail

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder(boolean nsAware)
                                          throws ParserConfigurationException

Returns a new document builder instance.

Parameters:

nsAware - If true, builder will be namespace aware.

Returns:

New document builder instance.

Throws:

ParserConfigurationException - Parser configuration error.

parseXMLFromSource

public static Document parseXMLFromSource(InputSource source)
                                   throws Exception

Parses XML from an input source.

Parameters:

source - An input source containing valid XML.

Returns:

XML document.

Throws:

Exception - Unspecified exception.

parseXMLFromString

public static Document parseXMLFromString(String xml)
                                   throws Exception

Parses XML from a string.

Parameters:

xml - String containing valid XML.

Returns:

XML document.

Throws:

Exception - Unspecified exception.

parseXMLFromList

public static Document parseXMLFromList(Iterable<String> xml)
                                 throws Exception

Parses XML from a list of strings.

Parameters:

xml - String iterable containing valid XML.

Returns:

XML document.

Throws:

Exception - Unspecified exception.

parseXMLFromLocation

public static Document parseXMLFromLocation(String filePath)
                                     throws Exception

Parses XML from a file.

Parameters:

filePath - Full path to a file containing valid XML.

Returns:

XML document.

Throws:

Exception - Unspecified exception.

parseXMLFromStream

public static Document parseXMLFromStream(InputStream stream)
                                   throws Exception

Parses XML from an input stream.

Parameters:

stream - Input stream containing valid XML.

Returns:

XML document.

Throws:

Exception - Unspecified exception.

toString

public static String toString(Document doc)

Converts an XML document to a formatted XML string.

Parameters:

doc - The document to format.

Returns:

Formatted XML document.

toString

public static String toString(Document doc,
                              int indent)

Converts an XML document to a formatted XML string.

Parameters:

doc - The document to format.

indent - Number of characters to indent.

Returns:

Formatted XML document.

formatNodeName

public static String formatNodeName(Node node,
                                    XMLUtil.TagFormat format)

Returns the formatted name for the node.

Parameters:

node - Node to format.

format - Desired format (opening tag, closing tag, empty tag, or both).

Returns:

Formatted name.

formatAttributes

public static String formatAttributes(Node node)

Returns formatted attributes of the node.

Parameters:

node - The node.

Returns:

Formatted attributes.