org.custommonkey.xmlunit

Class Difference

java.lang.Object

org.custommonkey.xmlunit.Difference

public class Difference
extends Object

Value object that describes a difference between DOM Nodes using one of the DifferenceConstants ID values and a NodeDetail instance.

See Also:

NodeDetail

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Difference(Difference prototype, NodeDetail controlNodeDetail, NodeDetail testNodeDetail) Copy constructor using prototype Difference and encountered NodeDetails
protected	Difference(int id, String description) Constructor for non-similar Difference instances
protected	Difference(int id, String description, boolean recoverable) Constructor for similar or non-similar Difference instances

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Now that Differences can be constructed from prototypes we need to be able to compare them to those in DifferenceConstants
NodeDetail	getControlNodeDetail()
String	getDescription()
int	getId()
NodeDetail	getTestNodeDetail()
int	hashCode() hashcode implementation to go with equals.
boolean	isRecoverable()
protected void	setRecoverable(boolean overrideValue) Allow the recoverable field value to be overridden.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Difference

protected Difference(int id,
                     String description)

Constructor for non-similar Difference instances

Parameters:

id - type of difference

description - description of the difference

Difference

protected Difference(int id,
                     String description,
                     boolean recoverable)

Constructor for similar or non-similar Difference instances

Parameters:

id - type of difference

description - description of the difference

recoverable - whether the difference represents a similarity

Difference

protected Difference(Difference prototype,
                     NodeDetail controlNodeDetail,
                     NodeDetail testNodeDetail)

Copy constructor using prototype Difference and encountered NodeDetails

Parameters:

prototype - the difference to copy from

controlNodeDetail - details of the control node

testNodeDetail - details of the test node

Method Detail

getId

public int getId()

Returns:

the id

getDescription

public String getDescription()

Returns:

the description

isRecoverable

public boolean isRecoverable()

Returns:

TRUE if the difference represents a similarity, FALSE otherwise

setRecoverable

protected void setRecoverable(boolean overrideValue)

Allow the recoverable field value to be overridden. Used when an override DifferenceListener is used in conjunction with a DetailedDiff.

Parameters:

overrideValue - whether the difference represents a similarity

getControlNodeDetail

public NodeDetail getControlNodeDetail()

Returns:

the NodeDetail from the piece of XML used as the control at the Node where this difference was encountered

getTestNodeDetail

public NodeDetail getTestNodeDetail()

Returns:

the NodeDetail from the piece of XML used as the test at the Node where this difference was encountered

equals

public boolean equals(Object other)

Now that Differences can be constructed from prototypes we need to be able to compare them to those in DifferenceConstants

Overrides:

equals in class Object

hashCode

public int hashCode()

hashcode implementation to go with equals.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

a basic representation of the object state and identity and if NodeDetail instances are populated append their details also