svn commit: r1631840 - /opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java

[jo...@apache.org]

Author: joern
Date: Tue Oct 14 19:03:59 2014
New Revision: 1631840

URL: http://svn.apache.org/r1631840
Log:
OPENNLP-720 Fixed javadoc error

Modified:
    opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java

Modified: opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java
URL: http://svn.apache.org/viewvc/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java?rev=1631840&r1=1631839&r2=1631840&view=diff
==============================================================================
--- opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java (original)
+++ opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/util/ObjectStream.java Tue Oct 14 19:03:59 2014
@@ -50,6 +50,8 @@ public interface ObjectStream<T> {
    * null will return each object from the underlying source exactly once.
    *
    * @return the next object or null to signal that the stream is exhausted
+   * 
+   * @throws IOException if there is an error during reading
    */
   T read() throws IOException;
 
@@ -59,6 +61,8 @@ public interface ObjectStream<T> {
    * the stream if multiple passes over the objects are required.
    *
    * The implementation of this method is optional.
+   * 
+   * @throws IOException if there is an error during reseting the stream
    */
   void reset() throws IOException, UnsupportedOperationException;
 
@@ -67,7 +71,7 @@ public interface ObjectStream<T> {
    * resources. After close was called its not allowed to call
    * read or reset.
    *
-   * @throws IOException
+   * @throws IOException if there is an error during closing the stream
    */
   void close() throws IOException;
 }