XMLAssert (XMLUnit Documentation)

java.lang.Object
- junit.framework.Assert
- - org.custommonkey.xmlunit.XMLAssert

All Implemented Interfaces:

XMLConstants, XSLTConstants
```
public class XMLAssert
extends junit.framework.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.
See Also:
Diff.similar(), Examples and more atxmlunit.sourceforge.net

Field Summary
- Fields inherited from interface org.custommonkey.xmlunit.XSLTConstants
  JAVA5_XSLTC_FACTORY_NAME, XSLT_END, XSLT_IDENTITY_TEMPLATE, XSLT_START, XSLT_START_NO_VERSION, XSLT_STRIP_COMMENTS_TEMPLATE, XSLT_STRIP_WHITESPACE, XSLT_XML_OUTPUT_NOINDENT
- Fields inherited from interface org.custommonkey.xmlunit.XMLConstants
  CLOSE_NODE, END_CDATA, END_COMMENT, END_PROCESSING_INSTRUCTION, NULL_NS_URI, OPEN_END_NODE, OPEN_START_NODE, START_CDATA, START_COMMENT, START_DOCTYPE, START_PROCESSING_INSTRUCTION, W3C_XML_SCHEMA_INSTANCE_NO_NAMESPACE_SCHEMA_LOCATION_ATTR, W3C_XML_SCHEMA_INSTANCE_NS_URI, W3C_XML_SCHEMA_INSTANCE_SCHEMA_LOCATION_ATTR, W3C_XML_SCHEMA_INSTANCE_TYPE_ATTR, W3C_XML_SCHEMA_NS_URI, XML_DECLARATION, XMLNS_ATTRIBUTE_URI, XMLNS_PREFIX, XPATH_ATTRIBUTE_IDENTIFIER, XPATH_CHARACTER_NODE_IDENTIFIER, XPATH_COMMENT_IDENTIFIER, XPATH_NODE_INDEX_END, XPATH_NODE_INDEX_START, XPATH_PROCESSING_INSTRUCTION_IDENTIFIER, XPATH_SEPARATOR

Constructor Summary

Constructors
Modifier Constructor and Description

protected XMLAssert()

Constructors
Modifier	Constructor and Description
`protected`	`XMLAssert()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`assertNodeTestPasses(org.xml.sax.InputSource xml, 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`	`assertNodeTestPasses(java.lang.String xmlString, NodeTester tester, short nodeType)` Execute a `NodeTest for a single node type and assert that it passes`
`static void`	`assertXMLEqual(Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not similar.
`static void`	`assertXMLEqual(org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.io.Reader control, java.io.Reader test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.lang.String msg, Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not similar.
`static void`	`assertXMLEqual(java.lang.String err, org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.lang.String err, org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.lang.String err, java.io.Reader control, java.io.Reader test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.lang.String control, java.lang.String test)` Assert that two XML documents are similar
`static void`	`assertXMLEqual(java.lang.String err, java.lang.String control, java.lang.String 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(java.lang.String msg, Diff diff, boolean assertion)` Assert that the result of an XML comparison is or is not identical
`static void`	`assertXMLNotEqual(org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.io.Reader control, java.io.Reader test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.lang.String err, org.w3c.dom.Document control, org.w3c.dom.Document test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.lang.String err, org.xml.sax.InputSource control, org.xml.sax.InputSource test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.lang.String err, java.io.Reader control, java.io.Reader test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.lang.String control, java.lang.String test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLNotEqual(java.lang.String err, java.lang.String control, java.lang.String test)` Assert that two XML documents are NOT similar
`static void`	`assertXMLValid(org.xml.sax.InputSource xml)` Assert that an InputSource containing XML contains valid XML: the document must contain a DOCTYPE declaration to be validated
`static void`	`assertXMLValid(org.xml.sax.InputSource xml, java.lang.String systemId)` Assert that an InputSource containing XML contains valid XML: the document must contain a DOCTYPE to be validated, but the validation will use the systemId to obtain the DTD
`static void`	`assertXMLValid(org.xml.sax.InputSource xml, java.lang.String systemId, java.lang.String doctype)` Assert that a piece of XML contains valid XML: the document 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(java.lang.String xmlString)` Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE declaration to be validated
`static void`	`assertXMLValid(java.lang.String xmlString, java.lang.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(java.lang.String xmlString, java.lang.String systemId, java.lang.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(QualifiedName expectedValue, java.lang.String xpathExpression, org.w3c.dom.Document inDocument)` Assert the value of an Xpath expression in an DOM Document
`static void`	`assertXpathEvaluatesTo(QualifiedName expectedValue, java.lang.String xpathExpression, org.xml.sax.InputSource control)` Assert the value of an Xpath expression in an XML document.
`static void`	`assertXpathEvaluatesTo(QualifiedName expectedValue, java.lang.String xpathExpression, java.lang.String inXMLString)` Assert the value of an Xpath expression in an XML String
`static void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, org.w3c.dom.Document inDocument)` Assert the value of an Xpath expression in an DOM Document
`static void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, org.xml.sax.InputSource control)` Assert the value of an Xpath expression in an XML document.
`static void`	`assertXpathEvaluatesTo(java.lang.String expectedValue, java.lang.String xpathExpression, java.lang.String inXMLString)` Assert the value of an Xpath expression in an XML String
`static void`	`assertXpathExists(java.lang.String xPathExpression, org.w3c.dom.Document inDocument)` Assert that a specific XPath exists in some given XML
`static void`	`assertXpathExists(java.lang.String xPathExpression, org.xml.sax.InputSource control)` Assert that a specific XPath exists in some given XML
`static void`	`assertXpathExists(java.lang.String xPathExpression, java.lang.String inXMLString)` Assert that a specific XPath exists in some given XML
`static void`	`assertXpathNotExists(java.lang.String xPathExpression, org.w3c.dom.Document inDocument)` Assert that a specific XPath does NOT exist in some given XML
`static void`	`assertXpathNotExists(java.lang.String xPathExpression, org.xml.sax.InputSource control)` Assert that a specific XPath does NOT exist in some given XML
`static void`	`assertXpathNotExists(java.lang.String xPathExpression, java.lang.String inXMLString)` Assert that a specific XPath does NOT exist in some given XML
`static void`	`assertXpathsEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the node lists of two Xpaths in two documents are equal
`static void`	`assertXpathsEqual(java.lang.String controlXpath, org.xml.sax.InputSource controlDocument, java.lang.String testXpath, org.xml.sax.InputSource testDocument)` Assert that the node lists of two Xpaths in two documents are equal
`static void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the node lists of two Xpaths in the same document are equal
`static void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource document)` Assert that the node lists of two Xpaths in the same document are equal
`static void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the node lists of two Xpaths in the same XML string are equal
`static void`	`assertXpathsEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the node lists of two Xpaths in two XML strings are equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the node lists of two Xpaths in two documents are NOT equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, org.xml.sax.InputSource controlDocument, java.lang.String testXpath, org.xml.sax.InputSource testDocument)` Assert that the node lists of two Xpaths in two XML strings are NOT equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the node lists of two Xpaths in the same document are NOT equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource document)` Assert that the node lists of two Xpaths in the same document are NOT equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the node lists of two Xpaths in the same XML string are NOT equal
`static void`	`assertXpathsNotEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the node lists of two Xpaths in two XML strings are NOT equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the evaluation of two Xpaths in two documents are equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the evaluation of two Xpaths in two XML strings are equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the evaluation of two Xpaths in the same document are equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource document)` Assert that the evaluation of two Xpaths in the same XML string are equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the evaluation of two Xpaths in the same XML string are equal
`static void`	`assertXpathValuesEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the evaluation of two Xpaths in two XML strings are equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, org.w3c.dom.Document controlDocument, java.lang.String testXpath, org.w3c.dom.Document testDocument)` Assert that the evaluation of two Xpaths in two documents are NOT equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, org.xml.sax.InputSource control, java.lang.String testXpath, org.xml.sax.InputSource test)` Assert that the evaluation of two Xpaths in two XML strings are NOT equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.w3c.dom.Document document)` Assert that the evaluation of two Xpaths in the same document are NOT equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, org.xml.sax.InputSource control)` Assert that the evaluation of two Xpaths in the same XML string are NOT equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String testXpath, java.lang.String inXMLString)` Assert that the evaluation of two Xpaths in the same XML string are NOT equal
`static void`	`assertXpathValuesNotEqual(java.lang.String controlXpath, java.lang.String inControlXMLString, java.lang.String testXpath, java.lang.String inTestXMLString)` Assert that the evaluation of two Xpaths in two XML strings are NOT equal

Methods inherited from class junit.framework.Assert
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- XMLAssert
```
protected XMLAssert()
```

Method Detail

assertXMLEqual
```
public static void assertXMLEqual(Diff diff,
                  boolean assertion)
```
Assert that the result of an XML comparison is or is not similar.

Parameters:
diff - the result of an XML comparison
assertion - true if asserting that result is similar

assertXMLEqual
```
public static void assertXMLEqual(java.lang.String msg,
                  Diff diff,
                  boolean assertion)
```
Assert that the result of an XML comparison is or is not similar.

Parameters:
msg - additional message to display if assertion fails
diff - the result of an XML comparison
assertion - true if asserting that result is similar

assertXMLIdentical
```
public static void assertXMLIdentical(Diff diff,
                      boolean assertion)
```
Assert that the result of an XML comparison is or is not identical

Parameters:
diff - the result of an XML comparison
assertion - true if asserting that result is identical

assertXMLIdentical
```
public static void assertXMLIdentical(java.lang.String msg,
                      Diff diff,
                      boolean assertion)
```
Assert that the result of an XML comparison is or is not identical

Parameters:
msg - Message to display if assertion fails
diff - the result of an XML comparison
assertion - true if asserting that result is identical