Package org.xmlunit.diff

Class Diff

java.lang.Object

org.xmlunit.diff.Diff

public class Diff
extends java.lang.Object

The Diff-Object is the result of two comparisons.

See Also:

DiffBuilder

Constructor Summary

Constructors

Constructor	Description
Diff(javax.xml.transform.Source controlSource, javax.xml.transform.Source testSource, java.lang.Iterable<Difference> differences)	Encapsulates the compared sources and the differences found.
Diff(javax.xml.transform.Source controlSource, javax.xml.transform.Source testSource, ComparisonFormatter formatter, java.lang.Iterable<Difference> differences)	Encapsulates the compared sources and the differences found.

Method Summary

Modifier and Type	Method	Description
java.lang.String	fullDescription()	Returns a string representation of this diff using internal ComparisonFormatter or DefaultComparisonFormatter if formatter wasn't set.
java.lang.String	fullDescription(ComparisonFormatter formatter)	Returns a string representation of this diff using the given ComparisonFormatter
javax.xml.transform.Source	getControlSource()
java.lang.Iterable<Difference>	getDifferences()
javax.xml.transform.Source	getTestSource()
boolean	hasDifferences()
java.lang.String	toString()	Returns a string representation of first found difference in this diff using internal ComparisonFormatter or DefaultComparisonFormatter if formatter wasn't set
java.lang.String	toString(ComparisonFormatter formatter)	Returns a string representation of first found difference in this diff using the given ComparisonFormatter

Methods inherited from class java.lang.Object

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

Constructor Detail

Diff

public Diff(javax.xml.transform.Source controlSource,
            javax.xml.transform.Source testSource,
            java.lang.Iterable<Difference> differences)

Encapsulates the compared sources and the differences found.

Parameters:

controlSource - the control XML source

testSource - the test XML source

differences - the differences found

Diff

public Diff(javax.xml.transform.Source controlSource,
            javax.xml.transform.Source testSource,
            ComparisonFormatter formatter,
            java.lang.Iterable<Difference> differences)

Encapsulates the compared sources and the differences found.

Parameters:

controlSource - the control XML source

testSource - the test XML source

differences - the differences found

formatter - formatter to use when displaying the differences

Method Detail

fullDescription

public java.lang.String fullDescription()

Returns a string representation of this diff using internal ComparisonFormatter or DefaultComparisonFormatter if formatter wasn't set.

Each comparison result separated by the end of the line.

Returns:

a string representation of this diff

Since:

2.8.3

fullDescription

public java.lang.String fullDescription(ComparisonFormatter formatter)

Returns a string representation of this diff using the given ComparisonFormatter

Each comparison result separated by the end of the line.

Parameters:

formatter - the ComparisonFormatter to use

Returns:

a string representation of this diff

Since:

2.8.3

hasDifferences

public boolean hasDifferences()

Returns:

true if there was at least one difference.

getDifferences

public java.lang.Iterable<Difference> getDifferences()

Returns:

all differences found before the comparison process stopped.

getControlSource

public javax.xml.transform.Source getControlSource()

Returns:

the control XML source

getTestSource

public javax.xml.transform.Source getTestSource()

Returns:

the test XML source

toString

public java.lang.String toString()

Returns a string representation of first found difference in this diff using internal ComparisonFormatter or DefaultComparisonFormatter if formatter wasn't set

Overrides:

toString in class java.lang.Object

Returns:

a string representation of first found difference in this diff

See Also:

fullDescription()

toString

public java.lang.String toString(ComparisonFormatter formatter)

Returns a string representation of first found difference in this diff using the given ComparisonFormatter

Parameters:

formatter - the ComparisonFormatter to use

Returns:

a string representation of first found difference in this diff

See Also:

fullDescription(ComparisonFormatter)