org.xins.common.xml

Class ElementFormatter

java.lang.Object

org.xins.common.xml.ElementFormatter

public class ElementFormatter
extends Object

Converter from Element to String and vice versa.

Since:

XINS 3.0

Author:

Anthony Goubard

Method Summary

Methods

Modifier and Type	Method and Description
static Element	createMainElement(String name) Creates an empty DOM element with the specified name.
static Element	createMainElementNS(String namespaceURI, String qualifiedName) Creates an empty DOM element with the specified name.
static String	format(Element element) Returns the String representation of the element as XML.
static void	format(Element element, XMLOutputter xmlout) Serializes the DOM Element in the XMLOutputter.
static Element	parse(InputStream stream) Creates a DOM element by parsing the XML included in the input stream.
static Element	parse(Reader reader) Creates a DOM element by parsing the XML included in the reader.
static Element	parse(String xml) Creates a DOM element by parsing the given XML.
static Element	parseURI(String uri) Creates a DOM element by parsing the given XML location.

Methods inherited from class java.lang.Object

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

Method Detail

format

public static String format(Element element)

Returns the String representation of the element as XML. The XML declaration is not included.

Parameters:

element - the element to serialize, cannot be null.

Returns:

the XML representation of the XML or an empty element if an error occured.

format

public static void format(Element element,
          XMLOutputter xmlout)
                   throws IOException

Serializes the DOM Element in the XMLOutputter.

Parameters:

element - the DOM element to serialize, cannot be null.

xmlout - the XMLOutputer to serialize the element, cannot be null.

Throws:

IOException - if the serialization failed.

Since:

XINS 3.1

parse

public static Element parse(String xml)
                     throws SAXException

Creates a DOM element by parsing the given XML.

Parameters:

xml - the XML text to parse, cannot be null.

Returns:

the DOM element representing the parsed XML, never null.

Throws:

SAXException - if for any reason the XML cannot be parsed correctly.

parseURI

public static Element parseURI(String uri)
                        throws SAXException

Creates a DOM element by parsing the given XML location.

Parameters:

uri - the URI location of the XML resource to parse, cannot be null.

Returns:

the DOM element representing the parsed XML, never null.

Throws:

SAXException - if for any reason the XML cannot be parsed correctly.

parse

public static Element parse(Reader reader)
                     throws SAXException

Creates a DOM element by parsing the XML included in the reader.

Parameters:

reader - the reader to use to read the XML source, cannot be null.

Returns:

the DOM element representing the parsed XML, never null.

Throws:

SAXException - if for any reason the XML cannot be parsed correctly.

parse

public static Element parse(InputStream stream)
                     throws SAXException

Creates a DOM element by parsing the XML included in the input stream.

Parameters:

stream - the input stream to use to read the XML source, cannot be null.

Returns:

the DOM element representing the parsed XML, never null.

Throws:

SAXException - if for any reason the XML cannot be parsed correctly.

createMainElement

public static Element createMainElement(String name)

Creates an empty DOM element with the specified name.

Parameters:

name - the local name of the XML element, cannot be null.

Returns:

a new DOM element with the specified name, never null.

createMainElementNS

public static Element createMainElementNS(String namespaceURI,
                          String qualifiedName)

Creates an empty DOM element with the specified name.

Parameters:

namespaceURI - the namespace URI of the XML element, can be null.

qualifiedName - the qualified name of the XML element, cannot be null.

Returns:

a new DOM element with the specified name, never null.