net.sf.practicalxml.junit

Class DomAsserts

java.lang.Object

net.sf.practicalxml.junit.DomAsserts

public class DomAsserts
extends Object

JUnit assertions for DOM documents. These are defined as static methods, so may be statically imported (although in some cases this will clash with the standard assertions in junit.framework.Assert).

As with the standard JUnit assertions, there are two forms for each method: one that takes an explanatory message, and one that doesn't.

Constructor Summary

Constructors

Constructor and Description
DomAsserts()

Method Summary

Methods

Modifier and Type	Method and Description
static void	assertCount(int expected, Node node, String xpath) Asserts that the specified XPath selects a specified number of nodes.
static void	assertCount(int expected, Node node, XPathWrapper xpath) Asserts that the specified XPath selects a specified number of nodes.
static void	assertCount(String message, int expected, Node node, String xpath) Asserts that the specified XPath selects a specified number of nodes.
static void	assertCount(String message, int expected, Node node, XPathWrapper xpath) Asserts that the specified XPath selects a specified number of nodes.
static void	assertEquals(String expected, Node node, String xpath) Asserts that the specified XPath selects a particular String value.
static void	assertEquals(String expected, Node node, XPathWrapper xpath) Asserts that the specified XPath selects a particular String value.
static void	assertEquals(String message, String expected, Node node, String xpath) Asserts that the specified XPath selects a particular String value.
static void	assertEquals(String message, String expected, Node node, XPathWrapper xpath) Asserts that the specified XPath selects a particular String value.
static void	assertExists(Node node, String xpath) Asserts that the specified XPath selects at least one node.
static void	assertExists(Node node, XPathWrapper xpath) Asserts that the specified XPath selects at least one node.
static void	assertExists(String message, Node node, String xpath) Asserts that the specified XPath selects at least one node, using the specified message if the assertion fails.
static void	assertExists(String message, Node node, XPathWrapper xpath) Asserts that the specified XPath selects at least one node.
static void	assertName(String expected, Element elem) Asserts that an element has the given localname.
static void	assertName(String message, String expected, Element elem) Asserts that an element has the given localname.
static void	assertNamespaceAndName(String expectedNSUri, String expectedName, Element elem) Asserts that an element has the given local name and namespace URI.
static void	assertNamespaceAndName(String message, String expectedNSUri, String expectedName, Element elem) Asserts that an element has the given local name and namespace URI.
static void	assertNotExists(Node node, String xpath) Asserts that the specified XPath does not select any nodes.
static void	assertNotExists(Node node, XPathWrapper xpath) Asserts that the specified XPath does not select any nodes.
static void	assertNotExists(String message, Node node, String xpath) Asserts that the specified XPath does not select any nodes, using the specified message if the assertion fails.
static void	assertNotExists(String message, Node node, XPathWrapper xpath) Asserts that the specified XPath does not select any nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomAsserts

public DomAsserts()

Method Detail

assertName

public static void assertName(String expected,
              Element elem)

Asserts that an element has the given localname.

Parameters:

expected - The expected name, sans prefix.

elem - The element on which to assert this name.

assertName

public static void assertName(String message,
              String expected,
              Element elem)

Asserts that an element has the given localname.

Parameters:

message - Message to display if assertion fails.

expected - The expected name, sans prefix.

elem - The element on which to assert this name.

assertNamespaceAndName

public static void assertNamespaceAndName(String expectedNSUri,
                          String expectedName,
                          Element elem)

Asserts that an element has the given local name and namespace URI.

If assertion fails, will display message indicating whether name or namespace was invalid.

Parameters:

expectedNSUri - The expected namespace URI. May be null to assert that the element does not have a namespace.

expectedName - The expected name.

elem - The element on which to assert this name.

assertNamespaceAndName

public static void assertNamespaceAndName(String message,
                          String expectedNSUri,
                          String expectedName,
                          Element elem)

Asserts that an element has the given local name and namespace URI.

Parameters:

message - Message to display if assertion fails.

expectedNSUri - The expected namespace URI. May be null to assert that the element does not have a namespace.

expectedName - The expected name.

elem - The element on which to assert this name.

assertExists

public static void assertExists(Node node,
                String xpath)

Asserts that the specified XPath selects at least one node. Uses the path as a failed-assertion message.

Parameters:

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertExists

public static void assertExists(String message,
                Node node,
                String xpath)

Asserts that the specified XPath selects at least one node, using the specified message if the assertion fails.

Parameters:

message - Message to display if assertion fails.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertExists

public static void assertExists(Node node,
                XPathWrapper xpath)

Asserts that the specified XPath selects at least one node. Uses XPathWrapper to allow complex paths, including namespace bindings. Uses the path as a failed- assertion message.

Parameters:

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertExists

public static void assertExists(String message,
                Node node,
                XPathWrapper xpath)

Asserts that the specified XPath selects at least one node. Uses XPathWrapper to allow complex paths, including namespace bindings.

Parameters:

message - Message to display if assertion fails.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertNotExists

public static void assertNotExists(Node node,
                   String xpath)

Asserts that the specified XPath does not select any nodes. Uses the path as a failed-assertion message.

Parameters:

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertNotExists

public static void assertNotExists(String message,
                   Node node,
                   String xpath)

Asserts that the specified XPath does not select any nodes, using the specified message if the assertion fails.

Parameters:

message - Message to display if assertion fails.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertNotExists

public static void assertNotExists(Node node,
                   XPathWrapper xpath)

Asserts that the specified XPath does not select any nodes. Uses XPathWrapper to allow complex paths, including namespace bindings. Uses the path as a failed- assertion message.

Parameters:

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertNotExists

public static void assertNotExists(String message,
                   Node node,
                   XPathWrapper xpath)

Asserts that the specified XPath does not select any nodes. Uses XPathWrapper to allow complex paths, including namespace bindings.

Parameters:

message - Message to display if assertion fails.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertCount

public static void assertCount(int expected,
               Node node,
               String xpath)

Asserts that the specified XPath selects a specified number of nodes. Uses the path as a failed-assertion message.

Parameters:

expected - The expected number of nodes selected.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertCount

public static void assertCount(String message,
               int expected,
               Node node,
               String xpath)

Asserts that the specified XPath selects a specified number of nodes.

Parameters:

message - Message to display if assertion fails.

expected - The expected number of nodes selected.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertCount

public static void assertCount(int expected,
               Node node,
               XPathWrapper xpath)

Asserts that the specified XPath selects a specified number of nodes. Uses XPathWrapper to allow complex paths, including namespace bindings. Uses the path as a failed-assertion message.

Parameters:

expected - The expected number of nodes selected.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertCount

public static void assertCount(String message,
               int expected,
               Node node,
               XPathWrapper xpath)

Asserts that the specified XPath selects a specified number of nodes. Uses XPathWrapper to allow complex paths, including namespace bindings.

Parameters:

message - Message to display if assertion fails.

expected - The expected number of nodes selected.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertEquals

public static void assertEquals(String expected,
                Node node,
                String xpath)

Asserts that the specified XPath selects a particular String value. Uses the path as a failed-assertion message.

Parameters:

expected - The expected value.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertEquals

public static void assertEquals(String message,
                String expected,
                Node node,
                String xpath)

Asserts that the specified XPath selects a particular String value.

Parameters:

message - Message to display if assertion fails.

expected - The expected value.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertEquals

public static void assertEquals(String expected,
                Node node,
                XPathWrapper xpath)

Asserts that the specified XPath selects a particular String value. This variant uses XPathWrapper to allow complex paths, including namespace bindings. Uses the path as a failed-assertion message.

Parameters:

expected - The expected value.

node - Initial context for expression evaluation.

xpath - Path expression to assert.

assertEquals

public static void assertEquals(String message,
                String expected,
                Node node,
                XPathWrapper xpath)

Asserts that the specified XPath selects a particular String value. This variant uses XPathWrapper to allow complex paths, including namespace bindings.

Parameters:

message - Message to display if assertion fails.

expected - The expected value.

node - Initial context for expression evaluation.

xpath - Path expression to assert.