com.edorasware.commons.core.util.xml

Class XmlUtils

java.lang.Object

com.edorasware.commons.core.util.xml.XmlUtils

public final class XmlUtils
extends Object

Provides utility methods related to XML.

Method Summary

Modifier and Type	Method and Description
static String	getAttributeValue(Element element, String attributeName) Gets the optional attribute with the given name from the given element.
static String	getAttributeValue(Element element, String attributeName, String defaultValue) Gets the optional attribute with the given name from the given element.
static Element	getChildElement(Element parentElement, String childElementName) Gets the child element with the given name from the given parent element.
static com.google.common.collect.ImmutableList<Element>	getChildElements(Element parentElement, String... childElementNames) Gets the child elements with the given names from the given parent element.
static String	getRequiredAttributeValue(Element element, String attributeName) Gets the required attribute with the given name from the given element.
static Document	parseAndValidate(org.springframework.core.io.Resource xmlResource, EntityResolver entityResolver, ErrorHandler errorHandler) Parse the given XML resource into a document and applies schema validation during the parsing process.
static Document	parseAndValidate(String xml, EntityResolver entityResolver, ErrorHandler errorHandler) Parses the given XML string into a document and applies schema validation during the parsing process.
static Document	parseWithoutValidate(String xml, ErrorHandler errorHandler) Parses the given XML string into a document without applying any validation during the parsing process.

Methods inherited from class java.lang.Object

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

Method Detail

getRequiredAttributeValue

public static String getRequiredAttributeValue(Element element,
                                               String attributeName)

Gets the required attribute with the given name from the given element. An IllegalArgumentException is thrown in case the attribute is not available on the element.

Parameters:

element - the element

attributeName - the name of the required attribute

Returns:

the attribute value

Throws:

IllegalArgumentException - thrown if the attribute is not available on the element

getAttributeValue

public static String getAttributeValue(Element element,
                                       String attributeName)

Gets the optional attribute with the given name from the given element. Null is returned in case the attribute is not available on the element.

Parameters:

element - the element

attributeName - the name of the optional attribute

Returns:

the attribute value

getAttributeValue

public static String getAttributeValue(Element element,
                                       String attributeName,
                                       String defaultValue)

Gets the optional attribute with the given name from the given element. The given default value is returned in case the attribute is either not available on the element or its value is empty.

Parameters:

element - the element

attributeName - the name of the optional attribute

defaultValue - the default value to return in case the optional attribute is either not defined on the element or its value is empty

Returns:

the attribute value if available, otherwise the default value

getChildElement

public static Element getChildElement(Element parentElement,
                                      String childElementName)

Gets the child element with the given name from the given parent element.

Parameters:

parentElement - the parent element

childElementName - the name of the child element

Returns:

the child element

getChildElements

public static com.google.common.collect.ImmutableList<Element> getChildElements(Element parentElement,
                                                                                String... childElementNames)

Gets the child elements with the given names from the given parent element.

Parameters:

parentElement - the parent element

childElementNames - the names of the child elements

Returns:

the child elements

parseAndValidate

public static Document parseAndValidate(org.springframework.core.io.Resource xmlResource,
                                        EntityResolver entityResolver,
                                        ErrorHandler errorHandler)
                                 throws Exception

Parse the given XML resource into a document and applies schema validation during the parsing process.

Parameters:

xmlResource - the XML resource

entityResolver - the entity resolver

errorHandler - the error handler

Returns:

the XML document

Throws:

Exception - thrown in case something goes wrong during the XML parsing process

parseAndValidate

public static Document parseAndValidate(String xml,
                                        EntityResolver entityResolver,
                                        ErrorHandler errorHandler)
                                 throws Exception

Parses the given XML string into a document and applies schema validation during the parsing process.

Parameters:

xml - the XML string to parse

entityResolver - the entity resolver

errorHandler - the error handler

Returns:

the document

Throws:

Exception - thrown if the parsing fails

parseWithoutValidate

public static Document parseWithoutValidate(String xml,
                                            ErrorHandler errorHandler)
                                     throws Exception

Parses the given XML string into a document without applying any validation during the parsing process.

Parameters:

xml - the XML string to parse

errorHandler - the error handler

Returns:

the document

Throws:

Exception - thrown if the parsing fails