org.xmlunit.util

Class Nodes

java.lang.Object

org.xmlunit.util.Nodes

public final class Nodes
extends Object

Utility algorithms that work on DOM nodes.

Method Summary

Modifier and Type	Method and Description
static Map<QName,String>	getAttributes(Node n) Obtains an element's attributes as Map.
static Map<QName,String>	getAttributes(Node n, Predicate<Attr> attributeFilter) Obtains an element's attributes as Map.
static NodeList	getChildNodes(Node n) Helper deals with the getChildNodes implementation of Attr.
static String	getMergedNestedText(Node n) Tries to merge all direct Text and CDATA children of the given Node and concatenates their value.
static QName	getQName(Node n) Extracts a Node's name, namespace URI (if any) and prefix as a QName.
static Node	normalizeWhitespace(Node original) Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any empty text or CDATA nodes and where all textual content including attribute values or comments are trimmed and normalized.
static Node	stripElementContentWhitespace(Node original) Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any text or CDATA nodes that only consist of whitespace.
static Node	stripWhitespace(Node original) Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any empty text or CDATA nodes and where all textual content including attribute values or comments are trimmed.

Methods inherited from class java.lang.Object

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

Method Detail

getQName

public static QName getQName(Node n)

Extracts a Node's name, namespace URI (if any) and prefix as a QName.

Parameters:

n - the node

Returns:

its QName

getMergedNestedText

public static String getMergedNestedText(Node n)

Tries to merge all direct Text and CDATA children of the given Node and concatenates their value.

Parameters:

n - the node

Returns:

an empty string if the Node has no Text or CDATA children.

getAttributes

public static Map<QName,String> getAttributes(Node n)

Obtains an element's attributes as Map.

Parameters:

n - the node

Returns:

attributes

getAttributes

public static Map<QName,String> getAttributes(Node n,
                                              Predicate<Attr> attributeFilter)

Obtains an element's attributes as Map.

Parameters:

n - the node

attributeFilter - is used to suppress unwanted attributes. Only attributes where the filter's test returns true are returned

Returns:

attributes

Since:

XMLUnit 2.10.0

stripWhitespace

public static Node stripWhitespace(Node original)

Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any empty text or CDATA nodes and where all textual content including attribute values or comments are trimmed.

Parameters:

original - the original node

Returns:

cloned node without empty text or cdata children

normalizeWhitespace

public static Node normalizeWhitespace(Node original)

Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any empty text or CDATA nodes and where all textual content including attribute values or comments are trimmed and normalized.

"normalized" in this context means all whitespace characters are replaced by space characters and consecutive whitespace characaters are collapsed.

Parameters:

original - the original node

Returns:

cloned node without empty text or cdata children and where all attributes and texts are normalized

stripElementContentWhitespace

public static Node stripElementContentWhitespace(Node original)

Creates a new Node (of the same type as the original node) that is similar to the orginal but doesn't contain any text or CDATA nodes that only consist of whitespace.

This doesn't have any effect if applied to a text or CDATA node itself.

Parameters:

original - the original node

Returns:

cloned node without whitespace-only text or cdata children

Since:

XMLUnit 2.6.0

getChildNodes

public static NodeList getChildNodes(Node n)

Helper deals with the getChildNodes implementation of Attr.

For non-Attr nodes this method simply returns n.getChildNodes. For the special case of an Attr with a null value this returns a NodeList with an empty Text element containing a empty string rather than a NodeList containing a single null Node.

Parameters:

n - the node to obtain the children of

Returns:

children of the node

Since:

XMLUnit 2.10.4