com.helger.commons.xml

Class XMLHelper

java.lang.Object

com.helger.commons.xml.XMLHelper

@Immutable
public final class XMLHelper
extends Object

This class contains multiple XML utility methods.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
static void	append(Node aSrcNode, Collection<?> aNodesToAppend)
static Node	append(Node aParentNode, Object aChild)
static Map<String,String>	getAllAttributesAsMap(Element aSrcNode)
static String	getAttributeValue(Element aElement, String sAttrName) The latest version of XercesJ 2.9 returns an empty string for non existing attributes.
static String	getAttributeValue(Element aElement, String sAttrName, String sDefault) The latest version of XercesJ 2.9 returns an empty string for non existing attributes.
static IIterableIterator<Element>	getChildElementIteratorNoNS(Node aStartNode) Get an iterator over all child elements that have no namespace.
static IIterableIterator<Element>	getChildElementIteratorNoNS(Node aStartNode, String sTagName) Get an iterator over all child elements that have no namespace and the desired tag name.
static IIterableIterator<Element>	getChildElementIteratorNS(Node aStartNode, String sNamespaceURI)
static IIterableIterator<Element>	getChildElementIteratorNS(Node aStartNode, String sNamespaceURI, String sLocalName)
static int	getDirectChildElementCountNoNS(Element aParent)
static int	getDirectChildElementCountNoNS(Element aParent, String sTagName)
static int	getDirectChildElementCountNS(Element aParent, String sNamespaceURI)
static int	getDirectChildElementCountNS(Element aParent, String sNamespaceURI, String sLocalName)
static Element	getFirstChildElement(Node aStartNode) Get the first direct child element of the passed element.
static Element	getFirstChildElementOfName(Node aStartNode, String sName) Search all child nodes of the given for the first element that has the specified tag name.
static String	getFirstChildText(Node aStartNode) Get the content of the first Text child element of the passed element.
static int	getLength(NodeList aNL)
static String	getNamespaceURI(Node aNode)
static Document	getOwnerDocument(Node aNode) Get the owner document of the passed node.
static String	getPathToNode(Node aNode) Shortcut for getPathToNode(Node, String) using "/" as the separator.
static String	getPathToNode(Node aNode, String sSep) Get the path from root node to the passed node.
static String	getPathToNode2(Node aNode) Shortcut for getPathToNode2(Node,String) using "/" as the separator.
static String	getPathToNode2(Node aNode, String sSep) Get the path from root node to the passed node.
static String	getXMLNSAttrName(String sNSPrefix) Get the full qualified attribute name to use for the given namespace prefix.
static boolean	hasChildElementNodes(Node aStartNode) Check if the passed node has at least one direct child element or not.
static boolean	hasNamespaceURI(Node aNode, String sNamespaceURI)
static boolean	isEmpty(NodeList aNL)
static boolean	isTextNode(Node aNode) Check if the passed node is a text node.
static void	removeAllChildElements(Element aElement) Remove all child nodes of the given node.

Methods inherited from class java.lang.Object

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

Method Detail

getFirstChildElement

@Nullable
public static Element getFirstChildElement(@Nonnull
                                    Node aStartNode)

Get the first direct child element of the passed element.

Parameters:

aStartNode - The element to start searching.

Returns:

null if the passed element does not have any direct child element.

hasChildElementNodes

public static boolean hasChildElementNodes(@Nonnull
                           Node aStartNode)

Check if the passed node has at least one direct child element or not.

Parameters:

aStartNode - The parent element to be searched. May not be null.

Returns:

true if the passed node has at least one child element, false otherwise.

getFirstChildElementOfName

@Nullable
public static Element getFirstChildElementOfName(@Nonnull
                                          Node aStartNode,
                                          @Nullable
                                          String sName)

Search all child nodes of the given for the first element that has the specified tag name.

Parameters:

aStartNode - The parent element to be searched. May not be null.

sName - The tag name to search.

Returns:

null if the parent element has no such child element.

getOwnerDocument

@Nullable
public static Document getOwnerDocument(@Nullable
                                 Node aNode)

Get the owner document of the passed node. If the node itself is a document, only a cast is performed.

Parameters:

aNode - The node to get the document from. May be null.

Returns:

null if the passed node was null.

append

@Nonnull
public static Node append(@Nonnull
                  Node aParentNode,
                  @Nullable
                  Object aChild)

append

public static void append(@Nonnull
          Node aSrcNode,
          @Nonnull
          Collection<?> aNodesToAppend)

getDirectChildElementCountNoNS

@Nonnegative
public static int getDirectChildElementCountNoNS(@Nullable
                                             Element aParent)

getDirectChildElementCountNoNS

@Nonnegative
public static int getDirectChildElementCountNoNS(@Nullable
                                             Element aParent,
                                             @Nonnull@Nonempty
                                             String sTagName)

getDirectChildElementCountNS

@Nonnegative
public static int getDirectChildElementCountNS(@Nullable
                                           Element aParent,
                                           @Nullable
                                           String sNamespaceURI)

getDirectChildElementCountNS

@Nonnegative
public static int getDirectChildElementCountNS(@Nullable
                                           Element aParent,
                                           @Nullable
                                           String sNamespaceURI,
                                           @Nonnull@Nonempty
                                           String sLocalName)

getChildElementIteratorNoNS

@Nonnull
public static IIterableIterator<Element> getChildElementIteratorNoNS(@Nonnull
                                                             Node aStartNode)

Get an iterator over all child elements that have no namespace.

Parameters:

aStartNode - the parent element

Returns:

a non-null Iterator

getChildElementIteratorNoNS

@Nonnull
public static IIterableIterator<Element> getChildElementIteratorNoNS(@Nonnull
                                                             Node aStartNode,
                                                             @Nonnull@Nonempty
                                                             String sTagName)

Get an iterator over all child elements that have no namespace and the desired tag name.

Parameters:

aStartNode - the parent element

sTagName - the name of the tag that is desired

Returns:

a non-null Iterator

Throws:

IllegalArgumentException - if the passed tag name is null or empty

getChildElementIteratorNS

@Nonnull
public static IIterableIterator<Element> getChildElementIteratorNS(@Nonnull
                                                           Node aStartNode,
                                                           @Nullable
                                                           String sNamespaceURI)

getChildElementIteratorNS

@Nonnull
public static IIterableIterator<Element> getChildElementIteratorNS(@Nonnull
                                                           Node aStartNode,
                                                           @Nullable
                                                           String sNamespaceURI,
                                                           @Nonnull@Nonempty
                                                           String sLocalName)

hasNamespaceURI

public static boolean hasNamespaceURI(@Nullable
                      Node aNode,
                      @Nullable
                      String sNamespaceURI)

getPathToNode

@Nonnull
public static String getPathToNode(@Nonnull
                           Node aNode)

Shortcut for getPathToNode(Node, String) using "/" as the separator.

Parameters:

aNode - The node to check.

Returns:

A non-null path.

getPathToNode

@Nonnull
public static String getPathToNode(@Nonnull
                           Node aNode,
                           @Nonnull
                           String sSep)

Get the path from root node to the passed node. This includes all nodes up to the document node!

Parameters:

aNode - The node to start. May not be null.

sSep - The separator string to use. May not be null.

Returns:

The path to the node.

getPathToNode2

@Nonnull
public static String getPathToNode2(@Nonnull
                            Node aNode)

Shortcut for getPathToNode2(Node,String) using "/" as the separator.

Parameters:

aNode - The node to check.

Returns:

A non-null path.

getPathToNode2

@Nonnull
public static String getPathToNode2(@Nonnull
                            Node aNode,
                            @Nonnull
                            String sSep)

Get the path from root node to the passed node. This includes all nodes but excluding the document node!

Parameters:

aNode - The node to start. May not be null.

sSep - The separator string to use. May not be null.

Returns:

The path to the node.

removeAllChildElements

public static void removeAllChildElements(@Nonnull
                          Element aElement)

Remove all child nodes of the given node.

Parameters:

aElement - The element whose children are to be removed.

isTextNode

public static boolean isTextNode(@Nullable
                 Node aNode)

Check if the passed node is a text node. This includes all nodes derived from CharacterData which are not Comment nodes as well as EntityReference nodes.

Parameters:

aNode - The node to be checked.

Returns:

true if the passed node is a text node, false otherwise.

getFirstChildText

@Nullable
public static String getFirstChildText(@Nullable
                                Node aStartNode)

Get the content of the first Text child element of the passed element.

Parameters:

aStartNode - the element to scan for a TextNode child

Returns:

null if the element contains no text node as child

getAttributeValue

@Nullable
public static String getAttributeValue(@Nonnull
                                Element aElement,
                                @Nonnull
                                String sAttrName)

The latest version of XercesJ 2.9 returns an empty string for non existing attributes. To differentiate between empty attributes and non-existing attributes, this method returns null for non existing attributes.

Parameters:

aElement - the source element to get the attribute from

sAttrName - the name of the attribute to query

Returns:

null if the attribute does not exists, the string value otherwise

getAttributeValue

@Nullable
public static String getAttributeValue(@Nonnull
                                Element aElement,
                                @Nonnull
                                String sAttrName,
                                @Nullable
                                String sDefault)

The latest version of XercesJ 2.9 returns an empty string for non existing attributes. To differentiate between empty attributes and non-existing attributes, this method returns a default value for non existing attributes.

Parameters:

aElement - the source element to get the attribute from. May not be null.

sAttrName - the name of the attribute to query. May not be null.

sDefault - the value to be returned if the attribute is not present.

Returns:

the default value if the attribute does not exists, the string value otherwise

getAllAttributesAsMap

@Nullable
public static Map<String,String> getAllAttributesAsMap(@Nullable
                                                Element aSrcNode)

getXMLNSAttrName

@Nonnull
public static String getXMLNSAttrName(@Nullable
                              String sNSPrefix)

Get the full qualified attribute name to use for the given namespace prefix. The result will e.g. be xmlns or xmlns:foo.

Parameters:

sNSPrefix - The namespace prefix to build the attribute name from. May be null or empty.

Returns:

If the namespace prefix is empty (if it equals XMLConstants.DEFAULT_NS_PREFIX or null) than "xmlns" is returned, else "xmlns:prefix" is returned.

getNamespaceURI

@Nullable
public static String getNamespaceURI(@Nullable
                              Node aNode)

getLength

@Nonnegative
public static int getLength(@Nullable
                        NodeList aNL)

isEmpty

public static boolean isEmpty(@Nullable
              NodeList aNL)