org.custommonkey.xmlunit
Class XMLAssert

java.lang.Object
  extended by junit.framework.Assert
      extended by 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:

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 at
xmlunit.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, 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_NS_URI, XML_DECLARATION, 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
protected XMLAssert()
           
 
Method Summary
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(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

assertXMLEqual

public static void assertXMLEqual(org.xml.sax.InputSource control,
                                  org.xml.sax.InputSource test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLEqual

public static void assertXMLEqual(java.lang.String control,
                                  java.lang.String test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLEqual

public static void assertXMLEqual(org.w3c.dom.Document control,
                                  org.w3c.dom.Document test)
Assert that two XML documents are similar

Parameters:
control - XML to be compared against
test - XML to be tested

assertXMLEqual

public static void assertXMLEqual(java.io.Reader control,
                                  java.io.Reader test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLEqual

public static void assertXMLEqual(java.lang.String err,
                                  org.xml.sax.InputSource control,
                                  org.xml.sax.InputSource test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLEqual

public static void assertXMLEqual(java.lang.String err,
                                  java.lang.String control,
                                  java.lang.String test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLEqual

public static void assertXMLEqual(java.lang.String err,
                                  org.w3c.dom.Document control,
                                  org.w3c.dom.Document test)
Assert that two XML documents are similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested

assertXMLEqual

public static void assertXMLEqual(java.lang.String err,
                                  java.io.Reader control,
                                  java.io.Reader test)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException
Assert that two XML documents are similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public static void assertXMLNotEqual(org.xml.sax.InputSource control,
                                     org.xml.sax.InputSource test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public static void assertXMLNotEqual(java.lang.String control,
                                     java.lang.String test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public static void assertXMLNotEqual(org.w3c.dom.Document control,
                                     org.w3c.dom.Document test)
Assert that two XML documents are NOT similar

Parameters:
control - XML to be compared against
test - XML to be tested

assertXMLNotEqual

public static void assertXMLNotEqual(java.io.Reader control,
                                     java.io.Reader test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public static void assertXMLNotEqual(java.lang.String err,
                                     org.xml.sax.InputSource control,
                                     org.xml.sax.InputSource test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public static void assertXMLNotEqual(java.lang.String err,
                                     java.lang.String control,
                                     java.lang.String test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXMLNotEqual

public 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

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested

assertXMLNotEqual

public static void assertXMLNotEqual(java.lang.String err,
                                     java.io.Reader control,
                                     java.io.Reader test)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException
Assert that two XML documents are NOT similar

Parameters:
err - Message to be displayed on assertion failure
control - XML to be compared against
test - XML to be tested
Throws:
org.xml.sax.SAXException
java.io.IOException

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     java.lang.String testXpath,
                                     org.w3c.dom.Document document)
                              throws XpathException
Assert that the node lists of two Xpaths in the same document are equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException
See Also:
XpathEngine

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     java.lang.String testXpath,
                                     org.xml.sax.InputSource document)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     XpathException
Assert that the node lists of two Xpaths in the same document are equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException
See Also:
XpathEngine

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     java.lang.String testXpath,
                                     java.lang.String inXMLString)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     XpathException
Assert that the node lists of two Xpaths in the same XML string are equal

Parameters:
xpathOne -
xpathTwo -
inXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     org.xml.sax.InputSource controlDocument,
                                     java.lang.String testXpath,
                                     org.xml.sax.InputSource testDocument)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     XpathException
Assert that the node lists of two Xpaths in two documents are equal

Parameters:
xpathOne -
xpathTwo -
controlDocument -
testDocument -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException
See Also:
XpathEngine

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     java.lang.String inControlXMLString,
                                     java.lang.String testXpath,
                                     java.lang.String inTestXMLString)
                              throws org.xml.sax.SAXException,
                                     java.io.IOException,
                                     XpathException
Assert that the node lists of two Xpaths in two XML strings are equal

Parameters:
xpathOne -
inControlXMLString -
xpathTwo -
inTestXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathsEqual

public static void assertXpathsEqual(java.lang.String controlXpath,
                                     org.w3c.dom.Document controlDocument,
                                     java.lang.String testXpath,
                                     org.w3c.dom.Document testDocument)
                              throws XpathException
Assert that the node lists of two Xpaths in two documents are equal

Parameters:
xpathOne -
xpathTwo -
controlDocument -
testDocument -
Throws:
XpathException
See Also:
XpathEngine

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        java.lang.String testXpath,
                                        org.w3c.dom.Document document)
                                 throws XpathException
Assert that the node lists of two Xpaths in the same document are NOT equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException
See Also:
XpathEngine

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        java.lang.String testXpath,
                                        org.xml.sax.InputSource document)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException,
                                        XpathException
Assert that the node lists of two Xpaths in the same document are NOT equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException
See Also:
XpathEngine

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        java.lang.String testXpath,
                                        java.lang.String inXMLString)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException,
                                        XpathException
Assert that the node lists of two Xpaths in the same XML string are NOT equal

Parameters:
xpathOne -
xpathTwo -
inXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        java.lang.String inControlXMLString,
                                        java.lang.String testXpath,
                                        java.lang.String inTestXMLString)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException,
                                        XpathException
Assert that the node lists of two Xpaths in two XML strings are NOT equal

Parameters:
xpathOne -
inControlXMLString -
xpathTwo -
inTestXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        org.xml.sax.InputSource controlDocument,
                                        java.lang.String testXpath,
                                        org.xml.sax.InputSource testDocument)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException,
                                        XpathException
Assert that the node lists of two Xpaths in two XML strings are NOT equal

Parameters:
xpathOne -
controlDocument -
xpathTwo -
testDocument -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathsNotEqual

public static void assertXpathsNotEqual(java.lang.String controlXpath,
                                        org.w3c.dom.Document controlDocument,
                                        java.lang.String testXpath,
                                        org.w3c.dom.Document testDocument)
                                 throws XpathException
Assert that the node lists of two Xpaths in two documents are NOT equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException
See Also:
XpathEngine

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          java.lang.String testXpath,
                                          org.w3c.dom.Document document)
                                   throws XpathException
Assert that the evaluation of two Xpaths in the same document are equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException
See Also:
XpathEngine

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          java.lang.String testXpath,
                                          org.xml.sax.InputSource document)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert that the evaluation of two Xpaths in the same XML string are equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          java.lang.String testXpath,
                                          java.lang.String inXMLString)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert that the evaluation of two Xpaths in the same XML string are equal

Parameters:
xpathOne -
xpathTwo -
inXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          org.xml.sax.InputSource control,
                                          java.lang.String testXpath,
                                          org.xml.sax.InputSource test)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert that the evaluation of two Xpaths in two XML strings are equal

Parameters:
xpathOne -
control -
xpathTwo -
test -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          java.lang.String inControlXMLString,
                                          java.lang.String testXpath,
                                          java.lang.String inTestXMLString)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert that the evaluation of two Xpaths in two XML strings are equal

Parameters:
xpathOne -
inControlXMLString -
xpathTwo -
inTestXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesEqual

public static void assertXpathValuesEqual(java.lang.String controlXpath,
                                          org.w3c.dom.Document controlDocument,
                                          java.lang.String testXpath,
                                          org.w3c.dom.Document testDocument)
                                   throws XpathException
Assert that the evaluation of two Xpaths in two documents are equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException
See Also:
XpathEngine

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             java.lang.String testXpath,
                                             org.xml.sax.InputSource control)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             XpathException
Assert that the evaluation of two Xpaths in the same XML string are NOT equal

Parameters:
xpathOne -
xpathTwo -
control -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             java.lang.String testXpath,
                                             java.lang.String inXMLString)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             XpathException
Assert that the evaluation of two Xpaths in the same XML string are NOT equal

Parameters:
xpathOne -
xpathTwo -
inXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             java.lang.String testXpath,
                                             org.w3c.dom.Document document)
                                      throws XpathException
Assert that the evaluation of two Xpaths in the same document are NOT equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             org.xml.sax.InputSource control,
                                             java.lang.String testXpath,
                                             org.xml.sax.InputSource test)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             XpathException
Assert that the evaluation of two Xpaths in two XML strings are NOT equal

Parameters:
xpathOne -
control -
xpathTwo -
test -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             java.lang.String inControlXMLString,
                                             java.lang.String testXpath,
                                             java.lang.String inTestXMLString)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException,
                                             XpathException
Assert that the evaluation of two Xpaths in two XML strings are NOT equal

Parameters:
xpathOne -
inControlXMLString -
xpathTwo -
inTestXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException

assertXpathValuesNotEqual

public static void assertXpathValuesNotEqual(java.lang.String controlXpath,
                                             org.w3c.dom.Document controlDocument,
                                             java.lang.String testXpath,
                                             org.w3c.dom.Document testDocument)
                                      throws XpathException
Assert that the evaluation of two Xpaths in two documents are NOT equal

Parameters:
xpathOne -
xpathTwo -
document -
Throws:
XpathException

assertXpathEvaluatesTo

public static void assertXpathEvaluatesTo(java.lang.String expectedValue,
                                          java.lang.String xpathExpression,
                                          org.xml.sax.InputSource control)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert the value of an Xpath expression in an XML document.

Parameters:
expectedValue -
xpathExpression -
control -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathEvaluatesTo

public static void assertXpathEvaluatesTo(java.lang.String expectedValue,
                                          java.lang.String xpathExpression,
                                          java.lang.String inXMLString)
                                   throws org.xml.sax.SAXException,
                                          java.io.IOException,
                                          XpathException
Assert the value of an Xpath expression in an XML String

Parameters:
expectedValue -
xpathExpression -
inXMLString -
Throws:
org.xml.sax.SAXException
java.io.IOException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathEvaluatesTo

public static void assertXpathEvaluatesTo(java.lang.String expectedValue,
                                          java.lang.String xpathExpression,
                                          org.w3c.dom.Document inDocument)
                                   throws XpathException
Assert the value of an Xpath expression in an DOM Document

Parameters:
expectedValue -
xpathExpression -
inDocument -
Throws:
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathExists

public static void assertXpathExists(java.lang.String xPathExpression,
                                     org.xml.sax.InputSource control)
                              throws java.io.IOException,
                                     org.xml.sax.SAXException,
                                     XpathException
Assert that a specific XPath exists in some given XML

Parameters:
inXpathExpression -
control -
Throws:
java.io.IOException
org.xml.sax.SAXException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathExists

public static void assertXpathExists(java.lang.String xPathExpression,
                                     java.lang.String inXMLString)
                              throws java.io.IOException,
                                     org.xml.sax.SAXException,
                                     XpathException
Assert that a specific XPath exists in some given XML

Parameters:
inXpathExpression -
inXMLString -
Throws:
java.io.IOException
org.xml.sax.SAXException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathExists

public static void assertXpathExists(java.lang.String xPathExpression,
                                     org.w3c.dom.Document inDocument)
                              throws XpathException
Assert that a specific XPath exists in some given XML

Parameters:
inXpathExpression -
inDocument -
Throws:
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathNotExists

public static void assertXpathNotExists(java.lang.String xPathExpression,
                                        org.xml.sax.InputSource control)
                                 throws java.io.IOException,
                                        org.xml.sax.SAXException,
                                        XpathException
Assert that a specific XPath does NOT exist in some given XML

Parameters:
inXpathExpression -
control -
Throws:
java.io.IOException
org.xml.sax.SAXException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathNotExists

public static void assertXpathNotExists(java.lang.String xPathExpression,
                                        java.lang.String inXMLString)
                                 throws java.io.IOException,
                                        org.xml.sax.SAXException,
                                        XpathException
Assert that a specific XPath does NOT exist in some given XML

Parameters:
inXpathExpression -
inXMLString -
Throws:
java.io.IOException
org.xml.sax.SAXException
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXpathNotExists

public static void assertXpathNotExists(java.lang.String xPathExpression,
                                        org.w3c.dom.Document inDocument)
                                 throws XpathException
Assert that a specific XPath does NOT exist in some given XML

Parameters:
inXpathExpression -
inDocument -
Throws:
XpathException
See Also:
which provides the underlying evaluation mechanism

assertXMLValid

public static void assertXMLValid(org.xml.sax.InputSource xml)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
Assert that an InputSource containing XML contains valid XML: the document must contain a DOCTYPE declaration to be validated

Parameters:
xml -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(java.lang.String xmlString)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
Assert that a String containing XML contains valid XML: the String must contain a DOCTYPE declaration to be validated

Parameters:
xmlString -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(org.xml.sax.InputSource xml,
                                  java.lang.String systemId)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
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

Parameters:
xml -
systemId -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(java.lang.String xmlString,
                                  java.lang.String systemId)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
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

Parameters:
xmlString -
systemId -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(org.xml.sax.InputSource xml,
                                  java.lang.String systemId,
                                  java.lang.String doctype)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
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.

Parameters:
xml -
systemId -
doctype -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(java.lang.String xmlString,
                                  java.lang.String systemId,
                                  java.lang.String doctype)
                           throws org.xml.sax.SAXException,
                                  ConfigurationException
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.

Parameters:
xmlString -
systemId -
doctype -
Throws:
org.xml.sax.SAXException
ConfigurationException - if validation could not be turned on
See Also:
Validator

assertXMLValid

public static void assertXMLValid(Validator validator)
Assert that a Validator instance returns isValid() == true

Parameters:
validator -

assertNodeTestPasses

public static void assertNodeTestPasses(org.xml.sax.InputSource xml,
                                        NodeTester tester,
                                        short nodeType)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException
Execute a NodeTest for a single node type and assert that it passes

Parameters:
xml - XML to be tested
tester - The test strategy
nodeType - The node type to be tested: constants defined in org.w3c.dom.Node e.g. Node.ELEMENT_NODE
Throws:
org.xml.sax.SAXException
java.io.IOException
See Also:
AbstractNodeTester, CountingNodeTester

assertNodeTestPasses

public static void assertNodeTestPasses(java.lang.String xmlString,
                                        NodeTester tester,
                                        short nodeType)
                                 throws org.xml.sax.SAXException,
                                        java.io.IOException
Execute a NodeTest for a single node type and assert that it passes

Parameters:
xmlString - XML to be tested
tester - The test strategy
nodeType - The node type to be tested: constants defined in org.w3c.dom.Node e.g. Node.ELEMENT_NODE
Throws:
org.xml.sax.SAXException
java.io.IOException
See Also:
AbstractNodeTester, CountingNodeTester

assertNodeTestPasses

public 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

Parameters:
test - a NodeTest instance containing the XML source to be tested
tester - The test strategy
nodeTypes - The node types to be tested: constants defined in org.w3c.dom.Node e.g. Node.ELEMENT_NODE
assertion - true if the test is expected to pass, false otherwise
See Also:
AbstractNodeTester, CountingNodeTester

XMLUnit is hosted by sourceforge.net