org.gatein.common.xml

Class XMLTools

java.lang.Object

org.gatein.common.xml.XMLTools

public class XMLTools
extends Object

Utilities for dealing with XML.

Version:

$Revision: 7686 $

Author:

Martin Holzner, Julien Viet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLTools.Filter<N extends Node>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_CDATA_SECTION_ELEMENTS .
static String	ATTRIB_HREF .
static String	ATTRIB_INDENT .
static String	ATTRIB_METHOD .
static String	ATTRIB_OMIT_XML_DECLARATION .
static boolean	DEFAULT_NAMESPACE_AWARE .
static boolean	DEFAULT_VALIDATION .
static String	DIRECTIVE_IMPORT .
static String	DIRECTIVE_INCLUDE .
static String	PARAM_NO .
static String	PARAM_YES .
static String	XML_LANG_NAMESPACE_URI Namespace URI for XML lang.

Method Summary

Methods

Modifier and Type	Method and Description
static String	asString(Element element) Perform trimming by default
static String	asString(Element element, boolean trim) Get the element's content as a string.
static XMLTools.Filter<Element>	byName(String uri, Set<String> names)
static XMLTools.Filter<Element>	byName(String uri, String name)
static List<Element>	getChildren(Element element) Return all the children of the given element.
static List<Element>	getChildren(Element element, String name) Return all the children of the given element having the specified name.
static List<Element>	getChildren(Element element, String uri, String name) Return all the children of the given element having the optionally specified name and the namespace URI.
static <T extends Node> List<T>	getChildren(Node node, XMLTools.Filter<T> filter) Return all the children of the given node that match the provided filter.
static Iterator<Element>	getChildrenIterator(Element element) Return an iterator for all the children of the given element.
static Iterator<Element>	getChildrenIterator(Element element, String name) Return an iterator for all the children of the given element having the specified name.
static Iterator<Element>	getChildrenIterator(Element element, String uri, String name) Return an iterator for all the children of the given element having the specified name and the optionally specified namesspace uri.
static DocumentBuilderFactory	getDocumentBuilderFactory() Return the builder factory.
static Element	getUniqueChild(Element element, boolean strict) Return the optional unique child of an element.
static Element	getUniqueChild(Element element, String name, boolean strict) Return an optional child of an element with the specified name.
static Element	getUniqueChild(Element element, String uri, String name, boolean strict) Return an optional child of an element with the specified name and the optionally specified namespace uri.
static Properties	loadXMLProperties(Document doc)
static Properties	loadXMLProperties(Element propertiesElt)
static Document	toDocument(Element element)
static Document	toDocument(String text) Parse a string into a document.
static Element	toElement(String text) Parse a string into an element.
static String	toString(Document doc) Serialize the document with the default format : - No XML declaration - Indented - Encoding is UTF-8
static String	toString(Document doc, boolean omitXMLDeclaration, boolean standalone, boolean indented, String encoding)
static String	toString(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

XML_LANG_NAMESPACE_URI

public static final String XML_LANG_NAMESPACE_URI

Namespace URI for XML lang.

See Also:

Constant Field Values

PARAM_YES

public static final String PARAM_YES

.

See Also:

Constant Field Values

PARAM_NO

public static final String PARAM_NO

.

See Also:

Constant Field Values

ATTRIB_OMIT_XML_DECLARATION

public static final String ATTRIB_OMIT_XML_DECLARATION

.

See Also:

Constant Field Values

ATTRIB_CDATA_SECTION_ELEMENTS

public static final String ATTRIB_CDATA_SECTION_ELEMENTS

.

See Also:

Constant Field Values

ATTRIB_METHOD

public static final String ATTRIB_METHOD

.

See Also:

Constant Field Values

ATTRIB_INDENT

public static final String ATTRIB_INDENT

.

See Also:

Constant Field Values

ATTRIB_HREF

public static final String ATTRIB_HREF

.

See Also:

Constant Field Values

DIRECTIVE_IMPORT

public static final String DIRECTIVE_IMPORT

.

See Also:

Constant Field Values

DIRECTIVE_INCLUDE

public static final String DIRECTIVE_INCLUDE

.

See Also:

Constant Field Values

DEFAULT_NAMESPACE_AWARE

public static final boolean DEFAULT_NAMESPACE_AWARE

.

See Also:

Constant Field Values

DEFAULT_VALIDATION

public static final boolean DEFAULT_VALIDATION

.

See Also:

Constant Field Values

Method Detail

getDocumentBuilderFactory

public static DocumentBuilderFactory getDocumentBuilderFactory()

Return the builder factory.

toString

public static String toString(Document doc,
              boolean omitXMLDeclaration,
              boolean standalone,
              boolean indented,
              String encoding)
                       throws TransformerException

Throws:

TransformerException

toString

public static String toString(Document doc)
                       throws TransformerException

Serialize the document with the default format : - No XML declaration - Indented - Encoding is UTF-8

Throws:

TransformerException

See Also:

toString(Document,Properties)

toString

public static String toString(Element element)
                       throws ParserConfigurationException,
                              TransformerException

Throws:

ParserConfigurationException

TransformerException

See Also:

toString(Document)

toDocument

public static Document toDocument(String text)
                           throws ParserConfigurationException,
                                  SAXException,
                                  IOException

Parse a string into a document.

Throws:

ParserConfigurationException

SAXException

IOException

toElement

public static Element toElement(String text)
                         throws ParserConfigurationException,
                                SAXException,
                                IOException

Parse a string into an element.

Throws:

ParserConfigurationException

SAXException

IOException

toDocument

public static Document toDocument(Element element)
                           throws ParserConfigurationException,
                                  SAXException,
                                  IOException

Throws:

ParserConfigurationException

SAXException

IOException

asString

public static String asString(Element element)
                       throws IllegalArgumentException

Perform trimming by default

Parameters:

element -

Returns:

Throws:

IllegalArgumentException

See Also:

asString(org.w3c.dom.Element,boolean)

asString

public static String asString(Element element,
              boolean trim)
                       throws IllegalArgumentException

Get the element's content as a string.

Parameters:

element - the container

trim - true if text should be trimmed before returning result

Throws:

IllegalArgumentException - if the element content is mixed or null

getUniqueChild

public static Element getUniqueChild(Element element,
                     boolean strict)
                              throws IllegalArgumentException,
                                     NoSuchElementException,
                                     TooManyElementException

Return the optional unique child of an element.

Parameters:

element - the parent element

strict - true if the element must be present

Returns:

the child element or null if it does not exist and strict is false

Throws:

IllegalArgumentException - if an argument is null

NoSuchElementException - if strict is true and the element is not present

TooManyElementException - if more than one element is found

getUniqueChild

public static Element getUniqueChild(Element element,
                     String name,
                     boolean strict)
                              throws IllegalArgumentException,
                                     NoSuchElementException,
                                     TooManyElementException

Return an optional child of an element with the specified name.

Parameters:

element - the parent element

name - the child name

strict - if the child must be present

Returns:

the child element or null if it does not exist and strict is set to false

Throws:

IllegalArgumentException - if an argument is null

NoSuchElementException - if strict is true and the element is not present

TooManyElementException - if more than one element is found

getUniqueChild

public static Element getUniqueChild(Element element,
                     String uri,
                     String name,
                     boolean strict)
                              throws IllegalArgumentException,
                                     NoSuchElementException,
                                     TooManyElementException

Return an optional child of an element with the specified name and the optionally specified namespace uri.

Parameters:

element - the parent element

name - the child name

uri - the child uri

strict - if the child must be present

Returns:

the child element or null if it does not exist and strict is set to false

Throws:

IllegalArgumentException - if an argument is null

NoSuchElementException - if strict is true and the element is not present

TooManyElementException - if more than one element is found

getChildrenIterator

public static Iterator<Element> getChildrenIterator(Element element)
                                             throws IllegalArgumentException

Return an iterator for all the children of the given element.

Parameters:

element - the parent element

Returns:

an iterator for the designated elements

Throws:

IllegalArgumentException - if the element is null or the name is null

getChildrenIterator

public static Iterator<Element> getChildrenIterator(Element element,
                                    String name)
                                             throws IllegalArgumentException

Return an iterator for all the children of the given element having the specified name.

Parameters:

element - the parent element

name - the child names

Returns:

an iterator for the designated elements

Throws:

IllegalArgumentException - if the element is null or the name is null

getChildrenIterator

public static Iterator<Element> getChildrenIterator(Element element,
                                    String uri,
                                    String name)
                                             throws IllegalArgumentException

Return an iterator for all the children of the given element having the specified name and the optionally specified namesspace uri.

Parameters:

element - the parent element

uri - the children uri

name - the children name

Returns:

an iterator for the designated elements

Throws:

IllegalArgumentException - if the element is null or the name is null

getChildren

public static List<Element> getChildren(Element element)
                                 throws IllegalArgumentException

Return all the children of the given element. The collection object can be modified.

Parameters:

element - the parent element

Returns:

a list of elements

Throws:

IllegalArgumentException - if the element is null or the name is null

getChildren

public static List<Element> getChildren(Element element,
                        String name)
                                 throws IllegalArgumentException

Return all the children of the given element having the specified name. The collection object can be modified.

Parameters:

element - the parent element

name - the child names

Returns:

a list of elements

Throws:

IllegalArgumentException - if the element is null or the name is null

getChildren

public static List<Element> getChildren(Element element,
                        String uri,
                        String name)
                                 throws IllegalArgumentException

Return all the children of the given element having the optionally specified name and the namespace URI.

If the URI is specified then the element must have the same URI namespace in order to be included otherwise it will be included. If the URI is specified the name matching will be done against the element local name otherwise it will be done against the element tag name.

If the name is specified then the element must have the same tag name or the same local name to be retained otherwise it will be included.

The resulting element collection can be safely modified.

Parameters:

element - the parent element

uri - the children uri

name - the children name

Returns:

a list of elements

Throws:

IllegalArgumentException - if the element is null

getChildren

public static <T extends Node> List<T> getChildren(Node node,
                                   XMLTools.Filter<T> filter)
                                        throws IllegalArgumentException

Return all the children of the given node that match the provided filter.

The resulting element collection can be safely modified.

Parameters:

node - the parent element

filter - the filter

Returns:

a list of elements

Throws:

IllegalArgumentException - if the element is null

byName

public static XMLTools.Filter<Element> byName(String uri,
                              Set<String> names)

byName

public static XMLTools.Filter<Element> byName(String uri,
                              String name)

loadXMLProperties

public static Properties loadXMLProperties(Element propertiesElt)

loadXMLProperties

public static Properties loadXMLProperties(Document doc)