You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@ws.apache.org by ve...@apache.org on 2016/05/30 22:55:22 UTC

svn commit: r1746208 - /webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java

Author: veithen
Date: Mon May 30 22:55:11 2016
New Revision: 1746208

URL: http://svn.apache.org/viewvc?rev=1746208&view=rev
Log:
Add Javadoc.

Modified:
    webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java

Modified: webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java
URL: http://svn.apache.org/viewvc/webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java?rev=1746208&r1=1746207&r2=1746208&view=diff
==============================================================================
--- webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java (original)
+++ webservices/axiom/trunk/aspects/core-aspects/src/main/java/org/apache/axiom/core/stream/XmlReader.java Mon May 30 22:55:11 2016
@@ -19,6 +19,15 @@
 package org.apache.axiom.core.stream;
 
 public interface XmlReader {
+    /**
+     * Output one or more events to the {@link XmlHandler} connected to this {@link XmlReader}.
+     * 
+     * @return {@code true} if the last event sent to the {@link XmlHandler} was
+     *         {@link XmlHandler#completed()} and there are no more events to produce; {@code false}
+     *         if {@link #proceed()} should be called again to produce more events
+     * @throws StreamException
+     */
     boolean proceed() throws StreamException;
+
     void dispose();
 }