XMLAssert (XMLUnit Documentation)

Class XMLAssert

public class XMLAssert extends Assert implements XSLTConstants

Collection of static methods so that XML assertion facilities are available in any class, not just test suites. Thanks to Andrew McCormick and others for suggesting this refactoring.
Available assertion methods are:

assertXMLEqual
assert that two pieces of XML markup are similar
assertXMLNotEqual
assert that two pieces of XML markup are different
assertXMLIdentical
assert that two pieces of XML markup are identical. In most cases this assertion is too strong and assertXMLEqual is sufficient
assertXpathExists
assert that an XPath expression matches at least one node
assertXpathNotExists
assert that an XPath expression does not match any nodes
assertXpathsEqual
assert that the nodes obtained by executing two Xpaths are similar
assertXpathsNotEqual
assert that the nodes obtained by executing two Xpaths are different
assertXpathValuesEqual
assert that the flattened String obtained by executing two Xpaths are similar
assertXpathValuesNotEqual
assert that the flattened String obtained by executing two Xpaths are different
assertXpathEvaluatesTo
assert that the flattened String obtained by executing an Xpath is a particular value
assertXMLValid
assert that a piece of XML markup is valid with respect to a DTD: either by using the markup's own DTD or a different DTD
assertNodeTestPasses
assert that a piece of XML markup passes a NodeTest

All underlying similarity and difference testing is done using Diff instances which can be instantiated and evaluated independently of this class.

Constructor Summary
protected	XMLAssert()

Constructor Summary

protected

XMLAssert()

Method Summary
static void	assertNodeTestPasses(String xmlString, NodeTester tester, short nodeType) Execute a `NodeTest for a single node type and assert that it passes`
static void	assertNodeTestPasses(NodeTest test, NodeTester tester, short[] nodeTypes, boolean assertion) Execute a `NodeTest for multiple node types and make an assertion about it whether it is expected to pass`
static void	assertXMLEqual(Diff diff, boolean assertion) Assert that the result of an XML comparison is or is not similar.
static void	assertXMLEqual(String msg, Diff diff, boolean assertion) Assert that the result of an XML comparison is or is not similar.
static void	assertXMLEqual(String control, String test) Assert that two XML documents are similar
static void	assertXMLEqual(Document control, Document test) Assert that two XML documents are similar
static void	assertXMLEqual(Reader control, Reader test) Assert that two XML documents are similar
static void	assertXMLEqual(String err, String control, String test) Assert that two XML documents are similar
static void	assertXMLEqual(String err, Document control, Document test) Assert that two XML documents are similar
static void	assertXMLEqual(String err, Reader control, Reader test) Assert that two XML documents are similar
static void	assertXMLIdentical(Diff diff, boolean assertion) Assert that the result of an XML comparison is or is not identical
static void	assertXMLIdentical(Diff diff, boolean assertion, String msg) Assert that the result of an XML comparison is or is not identical
static void	assertXMLIdentical(String msg, Diff diff, boolean assertion) Assert that the result of an XML comparison is or is not identical
static void	assertXMLNotEqual(String control, String test) Assert that two XML documents are NOT similar
static void	assertXMLNotEqual(String err, String control, String test) Assert that two XML documents are NOT similar
static void	assertXMLNotEqual(Document control, Document test) Assert that two XML documents are NOT similar
static void	assertXMLNotEqual(String err, Document control, Document test) Assert that two XML documents are NOT similar
static void	assertXMLNotEqual(Reader control, Reader test) Assert that two XML documents are NOT similar
static void	assertXMLNotEqual(String err, Reader control, Reader test) Assert that two XML documents are NOT similar
static void	assertXMLValid(String xmlString) Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE declaration to be validated
static void	assertXMLValid(String xmlString, String systemId) Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE to be validated, but the validation will use the systemId to obtain the DTD
static void	assertXMLValid(String xmlString, String systemId, String doctype) Assert that a String containing XML contains valid XML: the String will be given a DOCTYPE to be validated with the name and systemId specified regardless of whether it already contains a doctype declaration.
static void	assertXMLValid(Validator validator) Assert that a Validator instance returns `isValid() == true`
static void	assertXpathEvaluatesTo(String expectedValue, String xpathExpression, String inXMLString) Assert the value of an Xpath expression in an XML String
static void	assertXpathEvaluatesTo(String expectedValue, String xpathExpression, Document inDocument) Assert the value of an Xpath expression in an DOM Document
static void	assertXpathExists(String xPathExpression, String inXMLString) Assert that a specific XPath exists in some given XML
static void	assertXpathExists(String xPathExpression, Document inDocument) Assert that a specific XPath exists in some given XML
static void	assertXpathNotExists(String xPathExpression, String inXMLString) Assert that a specific XPath does NOT exist in some given XML
static void	assertXpathNotExists(String xPathExpression, Document inDocument) Assert that a specific XPath does NOT exist in some given XML
static void	assertXpathsEqual(String controlXpath, String testXpath, Document document) Assert that the node lists of two Xpaths in the same document are equal
static void	assertXpathsEqual(String controlXpath, String testXpath, String inXMLString) Assert that the node lists of two Xpaths in the same XML string are equal
static void	assertXpathsEqual(String controlXpath, String inControlXMLString, String testXpath, String inTestXMLString) Assert that the node lists of two Xpaths in two XML strings are equal
static void	assertXpathsEqual(String controlXpath, Document controlDocument, String testXpath, Document testDocument) Assert that the node lists of two Xpaths in two documents are equal
static void	assertXpathsNotEqual(String controlXpath, String testXpath, Document document) Assert that the node lists of two Xpaths in the same document are NOT equal
static void	assertXpathsNotEqual(String controlXpath, String testXpath, String inXMLString) Assert that the node lists of two Xpaths in the same XML string are NOT equal
static void	assertXpathsNotEqual(String controlXpath, String inControlXMLString, String testXpath, String inTestXMLString) Assert that the node lists of two Xpaths in two XML strings are NOT equal
static void	assertXpathsNotEqual(String controlXpath, Document controlDocument, String testXpath, Document testDocument) Assert that the node lists of two Xpaths in two documents are NOT equal
static void	assertXpathValuesEqual(String controlXpath, String testXpath, Document document) Assert that the evaluation of two Xpaths in the same document are equal
static void	assertXpathValuesEqual(String controlXpath, String testXpath, String inXMLString) Assert that the evaluation of two Xpaths in the same XML string are equal
static void	assertXpathValuesEqual(String controlXpath, String inControlXMLString, String testXpath, String inTestXMLString) Assert that the evaluation of two Xpaths in two XML strings are equal
static void	assertXpathValuesEqual(String controlXpath, Document controlDocument, String testXpath, Document testDocument) Assert that the evaluation of two Xpaths in two documents are equal
static void	assertXpathValuesNotEqual(String controlXpath, String testXpath, String inXMLString) Assert that the evaluation of two Xpaths in the same XML string are NOT equal
static void	assertXpathValuesNotEqual(String controlXpath, String testXpath, Document document) Assert that the evaluation of two Xpaths in the same document are NOT equal
static void	assertXpathValuesNotEqual(String controlXpath, String inControlXMLString, String testXpath, String inTestXMLString) Assert that the evaluation of two Xpaths in two XML strings are NOT equal
static void	assertXpathValuesNotEqual(String controlXpath, Document controlDocument, String testXpath, Document testDocument) Assert that the evaluation of two Xpaths in two documents are NOT equal

Method Summary

static void

assertNodeTestPasses(String xmlString, NodeTester tester, short nodeType)

Execute a

NodeTest for a single node type
 and assert that it passes

static void

assertNodeTestPasses(NodeTest test, NodeTester tester, short[] nodeTypes, boolean assertion)

Execute a

NodeTest for multiple node types and make an
 assertion about it whether it is expected to pass

static void

assertXMLEqual(Diff diff, boolean assertion)

Assert that the result of an XML comparison is or is not similar.

static void

assertXMLEqual(String msg, Diff diff, boolean assertion)

Assert that the result of an XML comparison is or is not similar.

static void

assertXMLEqual(String control, String test)

Assert that two XML documents are similar

static void

assertXMLEqual(Document control, Document test)

Assert that two XML documents are similar

static void

assertXMLEqual(Reader control, Reader test)

Assert that two XML documents are similar

static void

assertXMLEqual(String err, String control, String test)

Assert that two XML documents are similar

static void

assertXMLEqual(String err, Document control, Document test)

Assert that two XML documents are similar

static void

assertXMLEqual(String err, Reader control, Reader test)

Assert that two XML documents are similar

static void

assertXMLIdentical(Diff diff, boolean assertion)

Assert that the result of an XML comparison is or is not identical

static void

assertXMLIdentical(Diff diff, boolean assertion, String msg)

Assert that the result of an XML comparison is or is not identical

static void

assertXMLIdentical(String msg, Diff diff, boolean assertion)

Assert that the result of an XML comparison is or is not identical

static void

assertXMLNotEqual(String control, String test)