Package org.xmlunit.diff

Class DefaultNodeMatcher

java.lang.Object

org.xmlunit.diff.DefaultNodeMatcher

All Implemented Interfaces:

NodeMatcher

public class DefaultNodeMatcher
extends Object
implements NodeMatcher

Default implemetation of NodeMatcher that matches control and tests nodes for comparison with the help of DefaultNodeMatcher.NodeTypeMatcher and ElementSelectors.

There is an important difference between using ElementSelectors.or(org.xmlunit.diff.ElementSelector...) to combine multiple ElementSelectors and using DefaultNodeMatcher's constructor with multiple ElementSelectors:

Consider ElementSelectors e1 and e2 and two control and test nodes each. Assume e1 would match the first control node to the second test node and vice versa if used alone, while e2 would match the nodes in order (the first control node to the first test and so on).

ElementSelectors.or(org.xmlunit.diff.ElementSelector...) creates a combined ElementSelector that is willing to match the first control node to both of the test nodes - and the same for the second control node. Since nodes are compared in order when possible the result will be the same as running e2 alone.

DefaultNodeMatcher with two ElementSelectors will consult the ElementSelectors separately and only invoke e2 if there are any nodes not matched by e1 at all. In this case the result will be the same as running e1 alone.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultNodeMatcher.DefaultNodeTypeMatcher	DefaultNodeMatcher.NodeTypeMatcher that marks pairs of nodes of the same node type as well as pairs of CDATA sections and text nodes as eligible.
static interface	DefaultNodeMatcher.NodeTypeMatcher	Determines whether two Nodes are eligible for comparison based on their node type.

Constructor Summary

Constructors

Constructor	Description
DefaultNodeMatcher()	Creates a matcher using ElementSelectors.Default and DefaultNodeMatcher.DefaultNodeTypeMatcher.
DefaultNodeMatcher(DefaultNodeMatcher.NodeTypeMatcher ntm, ElementSelector... es)	Creates a matcher using the given ElementSelectors and DefaultNodeMatcher.NodeTypeMatcher.
DefaultNodeMatcher(ElementSelector... es)	Creates a matcher using the given ElementSelectors and DefaultNodeMatcher.DefaultNodeTypeMatcher.

Method Summary

Modifier and Type	Method	Description
Iterable<Map.Entry<Node,Node>>	match(Iterable<Node> controlNodes, Iterable<Node> testNodes)	Matches control and test nodes against each other, returns the matching pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNodeMatcher

public DefaultNodeMatcher()

Creates a matcher using ElementSelectors.Default and DefaultNodeMatcher.DefaultNodeTypeMatcher.

DefaultNodeMatcher

public DefaultNodeMatcher(ElementSelector... es)

Creates a matcher using the given ElementSelectors and DefaultNodeMatcher.DefaultNodeTypeMatcher.

Parameters:

es - the ElementSelectors to use

DefaultNodeMatcher

public DefaultNodeMatcher(DefaultNodeMatcher.NodeTypeMatcher ntm,
                          ElementSelector... es)

Creates a matcher using the given ElementSelectors and DefaultNodeMatcher.NodeTypeMatcher.

The ElementSelectors are consulted in order so that the second ElementSelector only gets to match the nodes that the first one couldn't match to any test nodes ate all and so on.

Parameters:

ntm - the NodeTypeMatcher to use

es - the ElementSelectors to use

Method Detail

match

public Iterable<Map.Entry<Node,Node>> match(Iterable<Node> controlNodes,
                                                  Iterable<Node> testNodes)

Description copied from interface: NodeMatcher

Matches control and test nodes against each other, returns the matching pairs.

Nodes passed in as attributes but not returned as member of any pair will cause ComparisonType.CHILD_LOOKUP differences}.

Specified by:

match in interface NodeMatcher

Parameters:

controlNodes - the control nodes

testNodes - the test nodes

Returns:

a Map.Entry containing the pair for each matched pair of nodes