XMLStreamReaderComparator (Axiom Test Utilities API)

java.lang.Object
- org.apache.axiom.testutils.stax.XMLStreamReaderComparator

```
public class XMLStreamReaderComparator
extends Object
```
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.

Constructor Summary

Constructors
Constructor Description

XMLStreamReaderComparator(XMLStreamReader expected, XMLStreamReader actual)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addPrefix(String prefix)`	Add a prefix that should be used in testing the `XMLStreamReader.getNamespaceURI(String)` method.
`void`	`compare()`
`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.
`void`	`setCompareInternalSubset(boolean compareInternalSubset)`
`void`	`setSortAttributes(boolean sortAttributes)`
`void`	`setTreatSpaceAsCharacters(boolean treatSpaceAsCharacters)`

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

- Constructor Detail
  - XMLStreamReaderComparator
```
public XMLStreamReaderComparator(XMLStreamReader expected,
                                 XMLStreamReader actual)
```
- Method Detail
  - addPrefix
```
public void addPrefix(String prefix)
```
    Add a prefix that should be used in testing the XMLStreamReader.getNamespaceURI(String) method.
    
    Parameters:
    
    prefix - the prefix to add
  - setCompareInternalSubset
```
public void setCompareInternalSubset(boolean compareInternalSubset)
```
  - 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)
```
  - setSortAttributes
```
public void setSortAttributes(boolean sortAttributes)
```
  - setTreatSpaceAsCharacters
```
public void setTreatSpaceAsCharacters(boolean treatSpaceAsCharacters)
```
  - compare
```
public void compare()
             throws Exception
```
    Throws:
    
    Exception