org.apache.axiom.testutils.stax

Class XMLStreamReaderComparator

java.lang.Object

junit.framework.Assert

org.apache.axiom.testutils.stax.XMLStreamReaderComparator

public class XMLStreamReaderComparator
extends junit.framework.Assert

Helper class that compares the events produced by two XMLStreamReader objects. Note that this class is not meant to be used to compare two XML documents (the error reporting would not be clear enough for that purpose), but to validate implementations of the XMLStreamReader interface. It uses a brute force approach: for each event, all methods (that don't modify the reader state) are called on both readers and the results (return values or exceptions thrown) of these invocations are compared to each other.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.xml.stream.XMLStreamReader	actual
private boolean	compareCharacterEncodingScheme
private boolean	compareEncoding
private boolean	compareEntityReplacementValue
private javax.xml.stream.XMLStreamReader	expected
private java.util.Set	namespaceURIs Set collecting all namespace URIs seen in the document to be able to test NamespaceContext.getPrefix(String).
private java.util.LinkedList	path
private java.util.Set	prefixes Set collecting all prefixes seen in the document to be able to test XMLStreamReader.getNamespaceURI(String).

Constructor Summary

Constructors

Constructor and Description
XMLStreamReaderComparator(javax.xml.stream.XMLStreamReader expected, javax.xml.stream.XMLStreamReader actual)

Method Summary

Modifier and Type	Method and Description
void	addPrefix(java.lang.String prefix) Add a prefix that should be used in testing the XMLStreamReader.getNamespaceURI(String) method.
private java.lang.Object	assertSameResult(java.lang.String methodName)
private java.lang.Object	assertSameResult(java.lang.String methodName, java.lang.Class[] paramTypes, java.lang.Object[] args)
private java.lang.Object	assertSameResult(java.lang.String methodName, java.lang.Class[] paramTypes, java.lang.Object[] args, Normalizer normalizer)
private java.lang.Object	assertSameResult(java.lang.String methodName, Normalizer normalizer)
void	compare()
private void	compareNamespaceContexts(javax.xml.namespace.NamespaceContext expected, javax.xml.namespace.NamespaceContext actual)
private java.lang.String	getLocation()
private java.lang.Object[]	invoke(java.lang.String methodName)
private java.lang.Object[]	invoke(java.lang.String methodName, java.lang.Class[] paramTypes, java.lang.Object[] args)
void	setCompareCharacterEncodingScheme(boolean value)
void	setCompareEncoding(boolean value)
void	setCompareEntityReplacementValue(boolean value) Specify whether the replacement value for entity references (as reported by XMLStreamReader.getText()) should be compared.
private java.util.Set	toPrefixSet(java.util.Iterator it)

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, format

Methods inherited from class java.lang.Object

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

Field Detail

expected

private final javax.xml.stream.XMLStreamReader expected

actual

private final javax.xml.stream.XMLStreamReader actual

compareEntityReplacementValue

private boolean compareEntityReplacementValue

compareCharacterEncodingScheme

private boolean compareCharacterEncodingScheme

compareEncoding

private boolean compareEncoding

path

private final java.util.LinkedList path

prefixes

private final java.util.Set prefixes

Set collecting all prefixes seen in the document to be able to test XMLStreamReader.getNamespaceURI(String).

namespaceURIs

private final java.util.Set namespaceURIs

Set collecting all namespace URIs seen in the document to be able to test NamespaceContext.getPrefix(String).

Constructor Detail

XMLStreamReaderComparator

public XMLStreamReaderComparator(javax.xml.stream.XMLStreamReader expected,
                                 javax.xml.stream.XMLStreamReader actual)

Method Detail

getLocation

private java.lang.String getLocation()

invoke

private java.lang.Object[] invoke(java.lang.String methodName,
                                  java.lang.Class[] paramTypes,
                                  java.lang.Object[] args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

invoke

private java.lang.Object[] invoke(java.lang.String methodName)
                           throws java.lang.Exception

Throws:

java.lang.Exception

assertSameResult

private java.lang.Object assertSameResult(java.lang.String methodName,
                                          java.lang.Class[] paramTypes,
                                          java.lang.Object[] args,
                                          Normalizer normalizer)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

assertSameResult

private java.lang.Object assertSameResult(java.lang.String methodName,
                                          java.lang.Class[] paramTypes,
                                          java.lang.Object[] args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

assertSameResult

private java.lang.Object assertSameResult(java.lang.String methodName,
                                          Normalizer normalizer)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

assertSameResult

private java.lang.Object assertSameResult(java.lang.String methodName)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

toPrefixSet

private java.util.Set toPrefixSet(java.util.Iterator it)

compareNamespaceContexts

private void compareNamespaceContexts(javax.xml.namespace.NamespaceContext expected,
                                      javax.xml.namespace.NamespaceContext actual)

addPrefix

public void addPrefix(java.lang.String prefix)

Add a prefix that should be used in testing the XMLStreamReader.getNamespaceURI(String) method.

Parameters:

prefix - the prefix to add

setCompareEntityReplacementValue

public void setCompareEntityReplacementValue(boolean value)

Specify whether the replacement value for entity references (as reported by XMLStreamReader.getText()) should be compared. The default value for this option is true.

Parameters:

value - true if the replacement value should be compared; false if replacement values for entity references are ignored

setCompareCharacterEncodingScheme

public void setCompareCharacterEncodingScheme(boolean value)

setCompareEncoding

public void setCompareEncoding(boolean value)

compare

public void compare()
             throws java.lang.Exception

Throws:

java.lang.Exception