org.custommonkey.xmlunit

Class NewDifferenceEngine

java.lang.Object

org.custommonkey.xmlunit.NewDifferenceEngine

All Implemented Interfaces:

DifferenceConstants, DifferenceEngineContract

public class NewDifferenceEngine
extends Object
implements DifferenceConstants, DifferenceEngineContract

Class that has responsibility for comparing Nodes and notifying a DifferenceListener of any differences or dissimilarities that are found. Knows how to compare namespaces and nested child nodes, but currently only compares nodes of type ELEMENT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_TYPE_NODE, PROCESSING_INSTRUCTION_NODE and TEXT_NODE. Nodes of other types (eg ENTITY_NODE) will be skipped.

See Also:

DifferenceListener.differenceFound(Difference)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewDifferenceEngine.ComparisonController2ComparisonController
static class	NewDifferenceEngine.DifferenceListener2DifferenceEvaluator
static class	NewDifferenceEngine.ElementQualifier2ElementSelector
static class	NewDifferenceEngine.MatchTracker2ComparisonListener

Field Summary

Fields inherited from interface org.custommonkey.xmlunit.DifferenceConstants

ATTR_NAME_NOT_FOUND, ATTR_NAME_NOT_FOUND_ID, ATTR_SEQUENCE, ATTR_SEQUENCE_ID, ATTR_VALUE, ATTR_VALUE_EXPLICITLY_SPECIFIED, ATTR_VALUE_EXPLICITLY_SPECIFIED_ID, ATTR_VALUE_ID, CDATA_VALUE, CDATA_VALUE_ID, CHILD_NODE_NOT_FOUND, CHILD_NODE_NOT_FOUND_ID, CHILD_NODELIST_LENGTH, CHILD_NODELIST_LENGTH_ID, CHILD_NODELIST_SEQUENCE, CHILD_NODELIST_SEQUENCE_ID, COMMENT_VALUE, COMMENT_VALUE_ID, DOCTYPE_NAME, DOCTYPE_NAME_ID, DOCTYPE_PUBLIC_ID, DOCTYPE_PUBLIC_ID_ID, DOCTYPE_SYSTEM_ID, DOCTYPE_SYSTEM_ID_ID, ELEMENT_NUM_ATTRIBUTES, ELEMENT_NUM_ATTRIBUTES_ID, ELEMENT_TAG_NAME, ELEMENT_TAG_NAME_ID, HAS_CHILD_NODES, HAS_CHILD_NODES_ID, HAS_DOCTYPE_DECLARATION, HAS_DOCTYPE_DECLARATION_ID, NAMESPACE_PREFIX, NAMESPACE_PREFIX_ID, NAMESPACE_URI, NAMESPACE_URI_ID, NO_NAMESPACE_SCHEMA_LOCATION, NO_NAMESPACE_SCHEMA_LOCATION_ID, NODE_TYPE, NODE_TYPE_ID, PROCESSING_INSTRUCTION_DATA, PROCESSING_INSTRUCTION_DATA_ID, PROCESSING_INSTRUCTION_TARGET, PROCESSING_INSTRUCTION_TARGET_ID, SCHEMA_LOCATION, SCHEMA_LOCATION_ID, TEXT_VALUE, TEXT_VALUE_ID

Constructor Summary

Constructors

Constructor and Description
NewDifferenceEngine(ComparisonController controller) Simple constructor that uses no MatchTracker at all.
NewDifferenceEngine(ComparisonController controller, MatchTracker matchTracker) Simple constructor

Method Summary

Modifier and Type	Method and Description
void	compare(Node control, Node test, DifferenceListener listener, ElementQualifier elementQualifier) Entry point for Node comparison testing.
void	setMatchTracker(MatchTracker matchTracker)
static Iterable<Difference>	toDifference(Comparison comp)
static NodeDetail	toNodeDetail(Comparison.Detail detail)

Methods inherited from class java.lang.Object

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

Constructor Detail

NewDifferenceEngine

public NewDifferenceEngine(ComparisonController controller)

Simple constructor that uses no MatchTracker at all.

Parameters:

controller - the instance used to determine whether a Difference detected by this class should halt further comparison or not

See Also:

ComparisonController.haltComparison(Difference)

NewDifferenceEngine

public NewDifferenceEngine(ComparisonController controller,
                           MatchTracker matchTracker)

Simple constructor

Parameters:

controller - the instance used to determine whether a Difference detected by this class should halt further comparison or not

matchTracker - the instance that is notified on each successful match. May be null.

See Also:

ComparisonController.haltComparison(Difference), MatchTracker.matchFound(Difference)

Method Detail

setMatchTracker

public void setMatchTracker(MatchTracker matchTracker)

Specified by:

setMatchTracker in interface DifferenceEngineContract

Parameters:

matchTracker - the instance that is notified on each successful match. May be null.

compare

public void compare(Node control,
                    Node test,
                    DifferenceListener listener,
                    ElementQualifier elementQualifier)

Entry point for Node comparison testing.

Specified by:

compare in interface DifferenceEngineContract

Parameters:

control - Control XML to compare

test - Test XML to compare

listener - Notified of any differences detected during node comparison testing

elementQualifier - Used to determine which elements qualify for comparison e.g. when a node has repeated child elements that may occur in any sequence and that sequence is not considered important.

toDifference

public static Iterable<Difference> toDifference(Comparison comp)

toNodeDetail

public static NodeDetail toNodeDetail(Comparison.Detail detail)