Author: veithen
Date: Sat Apr 4 11:57:53 2009
New Revision: 761908
URL: http://svn.apache.org/viewvc?rev=761908&view=rev
Log:
Added some more documentation.
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/stax/XMLStreamReaderComparator.java
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/stax/XMLStreamReaderComparator.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/stax/XMLStreamReaderComparator.java?rev=761908&r1=761907&r2=761908&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/stax/XMLStreamReaderComparator.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/test/java/org/apache/axiom/stax/XMLStreamReaderComparator.java
Sat Apr 4 11:57:53 2009
@@ -34,6 +34,11 @@
/**
* Helper class that compares the events produced by two {...@link
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 {...@link 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.
*/
public class XMLStreamReaderComparator extends Assert {
private final XMLStreamReader expected;
