com.github.hypfvieh.util.xml

Class XmlUtil

java.lang.Object

com.github.hypfvieh.util.xml.XmlUtil

public final class XmlUtil
extends Object

Assorted static XML utility methods.

Since:

1.0.3 - 2018-01-10

Author:

hypfvieh

Method Summary

Modifier and Type	Method and Description
static NodeList	applyXpathExpressionToDocument(String _xpathExpression, Node _xmlDocumentOrNode) Applys a xpathExpression to a xml-Document and return a NodeList with the results.
static Map<String,String>	convertToAttributeMap(NamedNodeMap _nodeMap) Converts NamedNodeMap to a LinkedHashMap<String,String>.
static List<Element>	convertToElementList(NodeList _nodeList) Convert a NodeList to a Java List of Elements.
static boolean	isElementType(Node _node) Shortcut for checking if given node is of type Element.
static Document	parseXmlString(String _xmlStr, boolean _validating, boolean _namespaceAware) Read the given string as XML document.
static Document	parseXmlStringWithXsdValidation(String _xmlStr, boolean _namespaceAware) Loads XML from string and uses referenced XSD to validate the content.
static Document	parseXmlStringWithXsdValidation(String _xmlStr, boolean _namespaceAware, ErrorHandler _errorHandler) Loads XML from string and uses referenced XSD to validate the content.
static void	printDocument(Node _docOrNode, OutputStream _outStream) Dump a Document or Node-compatible object to the given OutputStream (e.g.
static Element	toElement(Node _node) Checks and converts given Node to Element if possible.

Methods inherited from class java.lang.Object

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

Method Detail

isElementType

public static boolean isElementType(Node _node)

Shortcut for checking if given node is of type Element.

Parameters:

_node - node

Returns:

true if Element, false otherwise

toElement

public static Element toElement(Node _node)

Checks and converts given Node to Element if possible.

Parameters:

_node - node

Returns:

Element or null if given Node is not Element subtype

applyXpathExpressionToDocument

public static NodeList applyXpathExpressionToDocument(String _xpathExpression,
                                                      Node _xmlDocumentOrNode)
                                               throws IOException

Applys a xpathExpression to a xml-Document and return a NodeList with the results.

Parameters:

_xpathExpression - xpath expression

_xmlDocumentOrNode - document or node

Returns:

NodeList

Throws:

IOException - on error

parseXmlString

public static Document parseXmlString(String _xmlStr,
                                      boolean _validating,
                                      boolean _namespaceAware)
                               throws IOException

Read the given string as XML document.

Parameters:

_xmlStr - xml string

_validating - boolean

_namespaceAware - boolean

Returns:

Document

Throws:

IOException - on error

convertToElementList

public static List<Element> convertToElementList(NodeList _nodeList)

Convert a NodeList to a Java List of Elements.

Parameters:

_nodeList - collection of nodes

Returns:

list of elements

convertToAttributeMap

public static Map<String,String> convertToAttributeMap(NamedNodeMap _nodeMap)

Converts NamedNodeMap to a LinkedHashMap<String,String>.

Parameters:

_nodeMap - node map

Returns:

LinkedHashMap, maybe empty but never null

parseXmlStringWithXsdValidation

public static Document parseXmlStringWithXsdValidation(String _xmlStr,
                                                       boolean _namespaceAware,
                                                       ErrorHandler _errorHandler)
                                                throws IOException

Loads XML from string and uses referenced XSD to validate the content.

Parameters:

_xmlStr - string to validate

_namespaceAware - take care of namespace

_errorHandler - e.g. XmlErrorHandlers.XmlErrorHandlerQuiet or XmlErrorHandlers.XmlErrorHandlerRuntimeException

Returns:

Document

Throws:

IOException - on error

parseXmlStringWithXsdValidation

public static Document parseXmlStringWithXsdValidation(String _xmlStr,
                                                       boolean _namespaceAware)
                                                throws IOException

Loads XML from string and uses referenced XSD to validate the content. This method will use XmlErrorHandlers.XmlErrorHandlerQuiet to suppress all errors/warnings when validating.

Parameters:

_xmlStr - string to validate

_namespaceAware - take care of namespace

Returns:

Document

Throws:

IOException - on error

printDocument

public static void printDocument(Node _docOrNode,
                                 OutputStream _outStream)
                          throws IOException

Dump a Document or Node-compatible object to the given OutputStream (e.g. System.out).

Parameters:

_docOrNode - Document or Node object

_outStream - OutputStream to print on

Throws:

IOException - on error