You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2014/11/01 23:01:19 UTC

svn commit: r1636064 - /commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java

Author: ggregory
Date: Sat Nov  1 22:01:19 2014
New Revision: 1636064

URL: http://svn.apache.org/r1636064
Log:
Add missing Javadoc tags.

Modified:
    commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java

Modified: commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java?rev=1636064&r1=1636063&r2=1636064&view=diff
==============================================================================
--- commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java (original)
+++ commons/proper/exec/trunk/src/main/java/org/apache/commons/exec/ExecuteStreamHandler.java Sat Nov  1 22:01:19 2014
@@ -34,8 +34,9 @@ public interface ExecuteStreamHandler {
      * Install a handler for the input stream of the subprocess.
      * 
      * @param os
-     *            output stream to write to the standard input stream of the
-     *            subprocess
+     *            output stream to write to the standard input stream of the subprocess
+     * @throws IOException
+     *             thrown when an I/O exception occurs.
      */
     void setProcessInputStream(OutputStream os) throws IOException;
 
@@ -44,6 +45,8 @@ public interface ExecuteStreamHandler {
      * 
      * @param is
      *            input stream to read from the error stream from the subprocess
+     * @throws IOException
+     *             thrown when an I/O exception occurs.
      */
     void setProcessErrorStream(InputStream is) throws IOException;
 
@@ -52,17 +55,24 @@ public interface ExecuteStreamHandler {
      * 
      * @param is
      *            input stream to read from the error stream from the subprocess
+     * @throws IOException
+     *             thrown when an I/O exception occurs.
      */
     void setProcessOutputStream(InputStream is) throws IOException;
 
     /**
      * Start handling of the streams.
+     * 
+     * @throws IOException
+     *             thrown when an I/O exception occurs.
      */
     void start() throws IOException;
 
     /**
-     * Stop handling of the streams - will not be restarted.
-     * Will wait for pump threads to complete.
+     * Stop handling of the streams - will not be restarted. Will wait for pump threads to complete.
+     * 
+     * @throws IOException
+     *             thrown when an I/O exception occurs.
      */
     void stop() throws IOException;
 }