org.xmlunit.assertj

Class CompareAssert

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,ACTUAL>

org.xmlunit.assertj.CompareAssert

All Implemented Interfaces:

org.assertj.core.api.Assert<CompareAssert,Object>, org.assertj.core.api.Descriptable<CompareAssert>, org.assertj.core.api.ExtensionPoints<CompareAssert,Object>, DifferenceEngineConfigurer<CompareAssert>

public class CompareAssert
extends org.assertj.core.api.AbstractAssert<SELF,ACTUAL>
implements DifferenceEngineConfigurer<CompareAssert>

Assertion methods for XMLs comparison.

Simple Example

 import static org.xmlunit.assertj.XmlAssert.assertThat;

 final String control = "<a><b attr=\"abc\"></b></a>";
 final String test = "<a><b attr=\"xyz\"NodeAssertFactory></b></a>";

 assertThat(test).and(control).areIdentical();
 assertThat(test).and(control).areNotSimilar();
 

Since:

XMLUnit 2.6.1

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Method Summary

Modifier and Type	Method and Description
CompareAssert	areIdentical() Check if actual and control XMLs are identical.
CompareAssert	areNotIdentical() Check if actual and control XMLs are not identical.
CompareAssert	areNotSimilar() Check if actual and control XMLs are not similar.
CompareAssert	areSimilar() Check if actual and control XMLs are similar.
CompareAssert	ignoreChildNodesOrder() Equivalent for .withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndText)) .withDifferenceEvaluator( chain( Default, DifferenceEvaluators.downgradeDifferencesToEqual(ComparisonType.CHILD_NODELIST_SEQUENCE)));
CompareAssert	ignoreComments() Will remove all comment-Tags "<!
CompareAssert	ignoreCommentsUsingXSLTVersion(String xsltVersion) Will remove all comment-Tags "<!
CompareAssert	ignoreElementContentWhitespace() Ignore element content whitespace by removing all text nodes solely consisting of whitespace.
CompareAssert	ignoreWhitespace() Ignore whitespace by removing all empty text nodes and trimming the non-empty ones.
CompareAssert	normalizeWhitespace() Normalize Text-Elements by removing all empty text nodes and normalizing the non-empty ones.
CompareAssert	withAttributeFilter(Predicate<Attr> attributeFilter)
CompareAssert	withComparisonController(ComparisonController comparisonController)
CompareAssert	withComparisonFormatter(ComparisonFormatter formatter)
CompareAssert	withComparisonListeners(ComparisonListener... comparisonListeners)
CompareAssert	withDifferenceEvaluator(DifferenceEvaluator differenceEvaluator)
CompareAssert	withDifferenceListeners(ComparisonListener... comparisonListeners)
CompareAssert	withDocumentBuilderFactory(DocumentBuilderFactory f) Sets the DocumentBuilderFactory to use when creating a Document from the Sources to compare.
CompareAssert	withNamespaceContext(Map<String,String> prefix2Uri)
CompareAssert	withNodeFilter(Predicate<Node> nodeFilter)
CompareAssert	withNodeMatcher(NodeMatcher nodeMatcher)

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, setCustomRepresentation, throwAssertionError, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Method Detail

withNodeMatcher

public CompareAssert withNodeMatcher(NodeMatcher nodeMatcher)

Specified by:

withNodeMatcher in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withNodeMatcher(NodeMatcher)

withDifferenceEvaluator

public CompareAssert withDifferenceEvaluator(DifferenceEvaluator differenceEvaluator)

Specified by:

withDifferenceEvaluator in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withDifferenceEvaluator(DifferenceEvaluator)

withComparisonController

public CompareAssert withComparisonController(ComparisonController comparisonController)

Specified by:

withComparisonController in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withComparisonController(ComparisonController)

withComparisonListeners

public CompareAssert withComparisonListeners(ComparisonListener... comparisonListeners)

Specified by:

withComparisonListeners in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withComparisonListeners(ComparisonListener...)

withDifferenceListeners

public CompareAssert withDifferenceListeners(ComparisonListener... comparisonListeners)

Specified by:

withDifferenceListeners in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withDifferenceListeners(ComparisonListener...)

withNamespaceContext

public CompareAssert withNamespaceContext(Map<String,String> prefix2Uri)

Specified by:

withNamespaceContext in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withNamespaceContext(Map)

withAttributeFilter

public CompareAssert withAttributeFilter(Predicate<Attr> attributeFilter)

Specified by:

withAttributeFilter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withAttributeFilter(Predicate)

withNodeFilter

public CompareAssert withNodeFilter(Predicate<Node> nodeFilter)

Specified by:

withNodeFilter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withNodeFilter(Predicate)

withComparisonFormatter

public CompareAssert withComparisonFormatter(ComparisonFormatter formatter)

Specified by:

withComparisonFormatter in interface DifferenceEngineConfigurer<CompareAssert>

See Also:

DiffBuilder.withComparisonFormatter(ComparisonFormatter)

withDocumentBuilderFactory

public CompareAssert withDocumentBuilderFactory(DocumentBuilderFactory f)

Sets the DocumentBuilderFactory to use when creating a Document from the Sources to compare.

Parameters:

f - the DocumentBuilderFactory to use

Returns:

this

See Also:

DiffBuilder.withDocumentBuilderFactory(DocumentBuilderFactory)

ignoreWhitespace

public CompareAssert ignoreWhitespace()

Ignore whitespace by removing all empty text nodes and trimming the non-empty ones.

Returns:

this

See Also:

DiffBuilder.ignoreWhitespace()

normalizeWhitespace

public CompareAssert normalizeWhitespace()

Normalize Text-Elements by removing all empty text nodes and normalizing the non-empty ones.

Returns:

this

See Also:

DiffBuilder.normalizeWhitespace()

ignoreElementContentWhitespace

public CompareAssert ignoreElementContentWhitespace()

Ignore element content whitespace by removing all text nodes solely consisting of whitespace.

Returns:

this

See Also:

DiffBuilder.ignoreElementContentWhitespace()

ignoreComments

public CompareAssert ignoreComments()

Will remove all comment-Tags "<!-- Comment -->" from test- and control-XML before comparing.

Returns:

this

See Also:

DiffBuilder.ignoreComments()

ignoreCommentsUsingXSLTVersion

public CompareAssert ignoreCommentsUsingXSLTVersion(String xsltVersion)

Will remove all comment-Tags "<!-- Comment -->" from test- and control-XML before comparing.

Parameters:

xsltVersion - use this version for the stylesheet

Returns:

this

See Also:

DiffBuilder.ignoreCommentsUsingXSLTVersion(String)

ignoreChildNodesOrder

public CompareAssert ignoreChildNodesOrder()

Equivalent for

     .withNodeMatcher(new DefaultNodeMatcher(ElementSelectors.byNameAndText))
     .withDifferenceEvaluator(
          chain(
              Default,
              DifferenceEvaluators.downgradeDifferencesToEqual(ComparisonType.CHILD_NODELIST_SEQUENCE)));
 

Returns:

this

See Also:

DiffBuilder.withNodeMatcher(NodeMatcher)

areIdentical

public CompareAssert areIdentical()

Check if actual and control XMLs are identical. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenSimilar is used.

Returns:

this

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

DiffBuilder.checkForIdentical()

areNotIdentical

public CompareAssert areNotIdentical()

Check if actual and control XMLs are not identical. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenSimilar is used.

Returns:

this

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

DiffBuilder.checkForSimilar()

areSimilar

public CompareAssert areSimilar()

Check if actual and control XMLs are similar. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenDifferent is used.

Returns:

this

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

DiffBuilder.checkForSimilar()

areNotSimilar

public CompareAssert areNotSimilar()

Check if actual and control XMLs are not similar. If custom comparison controller wasn't defined then ComparisonControllers.StopWhenDifferent is used.

Returns:

this

Throws:

AssertionError - if the test value is invalid

AssertionError - if the control value is invalid

See Also:

DiffBuilder.checkForSimilar()