xdev.io

Class XMLUtils

java.lang.Object

xdev.io.XMLUtils

public final class XMLUtils
extends Object

Utility class with static methods for XML handling.

To read XML data from a source use the parse(...) methods.
To write XML data to a target use the transform(...) methods.

Since:

3.1

Author:

XDEV Software

Method Summary

Modifier and Type	Method and Description
static Document	parse(File file) Parse the content of the given file as an XML document and return a new DOM Document object.
static void	parse(File f, DefaultHandler handler) Parse the content of the file specified as XML using the specified DefaultHandler.
static Document	parse(InputSource is) Parse the content of the given input source as an XML document and return a new DOM Document object.
static void	parse(InputSource is, DefaultHandler handler) Parse the content given InputSource as XML using the specified DefaultHandler.
static Document	parse(InputStream is) Parse the content of the given InputStream as an XML document and return a new DOM Document object.
static void	parse(InputStream is, DefaultHandler handler) Parse the content of the given InputStream instance as XML using the specified DefaultHandler.
static Document	parse(InputStream is, String systemId) Parse the content of the given InputStream as an XML document and return a new DOM Document object.
static void	parse(InputStream is, String systemId, DefaultHandler handler) Parse the content of the given InputStream instance as XML using the specified DefaultHandler.
static Document	parse(String uri) Parse the content of the given URI as an XML document and return a new DOM Document object.
static void	parse(String uri, DefaultHandler handler) Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler.
static void	transform(Document doc, File file) Transform the document to a file.
static void	transform(Document doc, OutputStream os) Transform the document to an output stream.
static void	transform(Document doc, String uri) Transform the document to an URI.
static void	transform(Document doc, Writer writer) Transform the document to a writer.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static Document parse(File file)
                      throws SAXException,
                             IOException

Parse the content of the given file as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the File is null null.

Parameters:

file - The file containing the XML to parse.

Returns:

A new DOM Document object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When f is null

parse

public static Document parse(InputSource is)
                      throws SAXException,
                             IOException

Parse the content of the given input source as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputSource is null null.

Parameters:

is - InputSource containing the content to be parsed.

Returns:

A new DOM Document object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

parse

public static Document parse(String uri)
                      throws SAXException,
                             IOException

Parse the content of the given URI as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the URI is null null.

Parameters:

uri - The location of the content to be parsed.

Returns:

A new DOM Document object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When uri is null

parse

public static Document parse(InputStream is)
                      throws SAXException,
                             IOException

Parse the content of the given InputStream as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputStream is null.

Parameters:

is - InputStream containing the content to be parsed.

Returns:

Document result of parsing the InputStream

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

parse

public static Document parse(InputStream is,
                             String systemId)
                      throws SAXException,
                             IOException

Parse the content of the given InputStream as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the InputStream is null.

Parameters:

is - InputStream containing the content to be parsed.

systemId - Provide a base for resolving relative URIs.

Returns:

A new DOM Document object.

Throws:

IOException - If any IO errors occur.

SAXException - If any parse errors occur.

IllegalArgumentException - When is is null

parse

public static void parse(File f,
                         DefaultHandler handler)
                  throws SAXException,
                         IOException

Parse the content of the file specified as XML using the specified DefaultHandler.

Parameters:

f - The file containing the XML to parse

handler - The SAX DefaultHandler to use.

Throws:

IllegalArgumentException - If the File object is null.

IOException - If any IO errors occur.

SAXException - If any SAX errors occur during processing.

parse

public static void parse(InputSource is,
                         DefaultHandler handler)
                  throws SAXException,
                         IOException

Parse the content given InputSource as XML using the specified DefaultHandler.

Parameters:

is - The InputSource containing the content to be parsed.

handler - The SAX DefaultHandler to use.

Throws:

IllegalArgumentException - If the InputSource object is null.

IOException - If any IO errors occur.

SAXException - If any SAX errors occur during processing.

parse

public static void parse(String uri,
                         DefaultHandler handler)
                  throws SAXException,
                         IOException

Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specified DefaultHandler.

Parameters:

uri - The location of the content to be parsed.

handler - The SAX DefaultHandler to use.

Throws:

IllegalArgumentException - If the uri is null.

IOException - If any IO errors occur.

SAXException - If any SAX errors occur during processing.

parse

public static void parse(InputStream is,
                         DefaultHandler handler)
                  throws SAXException,
                         IOException

Parse the content of the given InputStream instance as XML using the specified DefaultHandler.

Parameters:

is - InputStream containing the content to be parsed.

handler - The SAX DefaultHandler to use.

Throws:

IllegalArgumentException - If the given InputStream is null.

IOException - If any IO errors occur.

SAXException - If any SAX errors occur during processing.

parse

public static void parse(InputStream is,
                         String systemId,
                         DefaultHandler handler)
                  throws SAXException,
                         IOException

Parse the content of the given InputStream instance as XML using the specified DefaultHandler.

Parameters:

is - InputStream containing the content to be parsed.

handler - The SAX DefaultHandler to use.

systemId - The systemId which is needed for resolving relative URIs.

Throws:

IllegalArgumentException - If the given InputStream is null.

IOException - If any IO errors occur.

SAXException - If any SAX errors occur during processing.

transform

public static void transform(Document doc,
                             File file)
                      throws TransformerException

Transform the document to a file.

Parameters:

doc - The document transform.

file - The target to transform the document to

Throws:

TransformerException - If an unrecoverable error occurs during the course of the transformation.

transform

public static void transform(Document doc,
                             Writer writer)
                      throws TransformerException

Transform the document to a writer.

Parameters:

doc - The document transform.

writer - The target to transform the document to

Throws:

TransformerException - If an unrecoverable error occurs during the course of the transformation.

transform

public static void transform(Document doc,
                             OutputStream os)
                      throws TransformerException

Transform the document to an output stream.

Parameters:

doc - The document transform.

os - The target to transform the document to

Throws:

TransformerException - If an unrecoverable error occurs during the course of the transformation.

transform

public static void transform(Document doc,
                             String uri)
                      throws TransformerException

Transform the document to an URI.

Parameters:

doc - The document transform.

uri - Must be a String that conforms to the URI syntax

Throws:

TransformerException - If an unrecoverable error occurs during the course of the transformation.