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 2023/12/29 16:21:06 UTC
(commons-exec) branch master updated (bccdbfac -> 30a07bc7)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
from bccdbfac Javadoc
new f4a914d6 Javadoc
new eeb2bdd5 Fix spelling in Javadoc
new 819ee2d7 Javadoc
new c04ac33b Javadoc
new f4471f26 Javadoc
new 48f48746 Javadoc
new 30a07bc7 Better name
The 7 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../org/apache/commons/exec/DefaultExecutor.java | 2 +-
.../org/apache/commons/exec/PumpStreamHandler.java | 54 +++++++++++-----------
.../commons/exec/ShutdownHookProcessDestroyer.java | 2 +-
.../java/org/apache/commons/exec/StreamPumper.java | 8 ++--
.../java/org/apache/commons/exec/Watchdog.java | 3 +-
5 files changed, 35 insertions(+), 34 deletions(-)
(commons-exec) 07/07: Better name
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit 30a07bc7ceb92e411f4ff4b2f83f80100cde8f1d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:21:02 2023 -0500
Better name
Comment empty block
---
src/main/java/org/apache/commons/exec/Watchdog.java | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/exec/Watchdog.java b/src/main/java/org/apache/commons/exec/Watchdog.java
index 95f4e289..92fb5988 100644
--- a/src/main/java/org/apache/commons/exec/Watchdog.java
+++ b/src/main/java/org/apache/commons/exec/Watchdog.java
@@ -86,7 +86,8 @@ public class Watchdog implements Runnable {
while (!stopped && isWaiting) {
try {
wait(timeLeftMillis);
- } catch (final InterruptedException e) {
+ } catch (final InterruptedException ignore) {
+ // ignore
}
timeLeftMillis = timeoutMillis - (System.currentTimeMillis() - startTimeMillis);
isWaiting = timeLeftMillis > 0;
(commons-exec) 05/07: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit f4471f2662f675cfa86faf57c74f696f15d2dd39
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:19:47 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
index 632b282a..05fb929a 100644
--- a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
+++ b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
@@ -98,7 +98,7 @@ public class ShutdownHookProcessDestroyer implements ProcessDestroyer, Runnable
}
/**
- * Returns whether or not the ProcessDestroyer is registered as shutdown hook
+ * Tests whether or not the ProcessDestroyer is registered as shutdown hook
*
* @return true if this is currently added as shutdown hook
*/
(commons-exec) 04/07: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit c04ac33bd7490f849db424f07e82acabbe25ff36
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:19:05 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/exec/PumpStreamHandler.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 408ce1a4..4e97d82c 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -46,7 +46,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
private InputStreamPumper inputStreamPumper;
- /** The timeout in ms the implementation waits when stopping the pumper threads */
+ /** The timeout in milliseconds the implementation waits when stopping the pumper threads */
private long stopTimeout;
/** The last exception being caught */
(commons-exec) 03/07: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit 819ee2d7275043b3c6910d2b0a89d263bd460523
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:18:47 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/exec/PumpStreamHandler.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index bb2cd09c..408ce1a4 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -226,7 +226,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Start the {@link Thread}s.
+ * Starts the {@link Thread}s.
*/
@Override
public void start() {
@@ -242,7 +242,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Stop pumping the streams. When a timeout is specified it is not guaranteed that the pumper threads are cleanly terminated.
+ * Stops pumping the streams. When a timeout is specified it is not guaranteed that the pumper threads are cleanly terminated.
*/
@Override
public void stop() throws IOException {
@@ -279,7 +279,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Stopping a pumper thread. The implementation actually waits longer than specified in 'timeout' to detect if the timeout was indeed exceeded. If the
+ * Stops a pumper thread. The implementation actually waits longer than specified in 'timeout' to detect if the timeout was indeed exceeded. If the
* timeout was exceeded an IOException is created to be thrown to the caller.
*
* @param thread the thread to be stopped
(commons-exec) 02/07: Fix spelling in Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit eeb2bdd5a98d207ba8e025bcb7b665481612c661
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:18:12 2023 -0500
Fix spelling in Javadoc
---
src/main/java/org/apache/commons/exec/PumpStreamHandler.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 8fe1608b..bb2cd09c 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -217,7 +217,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Sets maximum time to wait until output streams are exchausted when {@link #stop()} was called.
+ * Sets maximum time to wait until output streams are exhausted when {@link #stop()} was called.
*
* @param timeout timeout in milliseconds or zero to wait forever (default)
*/
(commons-exec) 01/07: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit f4a914d61537471acab335332f82141f5faf46a6
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:17:54 2023 -0500
Javadoc
---
.../org/apache/commons/exec/DefaultExecutor.java | 2 +-
.../org/apache/commons/exec/PumpStreamHandler.java | 46 +++++++++++-----------
2 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
index b19966ef..11353e4e 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
@@ -85,7 +85,7 @@ public class DefaultExecutor implements Executor {
/**
* Close the streams belonging to the given Process.
*
- * @param process the <CODE>Process</CODE>.
+ * @param process the {@link Process}.
*/
private void closeProcessStreams(final Process process) {
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index e0f9937e..8fe1608b 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -53,37 +53,37 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
private IOException caught;
/**
- * Constructs a new <CODE>PumpStreamHandler</CODE>.
+ * Constructs a new {@link PumpStreamHandler}.
*/
public PumpStreamHandler() {
this(System.out, System.err);
}
/**
- * Constructs a new <CODE>PumpStreamHandler</CODE>.
+ * Constructs a new {@link PumpStreamHandler}.
*
- * @param outAndErr the output/error <CODE>OutputStream</CODE>.
+ * @param outAndErr the output/error {@link OutputStream}.
*/
public PumpStreamHandler(final OutputStream outAndErr) {
this(outAndErr, outAndErr);
}
/**
- * Constructs a new <CODE>PumpStreamHandler</CODE>.
+ * Constructs a new {@link PumpStreamHandler}.
*
- * @param out the output <CODE>OutputStream</CODE>.
- * @param err the error <CODE>OutputStream</CODE>.
+ * @param out the output {@link OutputStream}.
+ * @param err the error {@link OutputStream}.
*/
public PumpStreamHandler(final OutputStream out, final OutputStream err) {
this(out, err, null);
}
/**
- * Constructs a new <CODE>PumpStreamHandler</CODE>.
+ * Constructs a new {@link PumpStreamHandler}.
*
- * @param out the output <CODE>OutputStream</CODE>.
- * @param err the error <CODE>OutputStream</CODE>.
- * @param input the input <CODE>InputStream</CODE>.
+ * @param out the output {@link OutputStream}.
+ * @param err the error {@link OutputStream}.
+ * @param input the input {@link InputStream}.
*/
public PumpStreamHandler(final OutputStream out, final OutputStream err, final InputStream input) {
this.out = out;
@@ -94,8 +94,8 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
/**
* Create the pump to handle error output.
*
- * @param is the <CODE>InputStream</CODE>.
- * @param os the <CODE>OutputStream</CODE>.
+ * @param is the {@link InputStream}.
+ * @param os the {@link OutputStream}.
*/
protected void createProcessErrorPump(final InputStream is, final OutputStream os) {
errorThread = createPump(is, os);
@@ -104,8 +104,8 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
/**
* Create the pump to handle process output.
*
- * @param is the <CODE>InputStream</CODE>.
- * @param os the <CODE>OutputStream</CODE>.
+ * @param is the {@link InputStream}.
+ * @param os the {@link OutputStream}.
*/
protected void createProcessOutputPump(final InputStream is, final OutputStream os) {
outputThread = createPump(is, os);
@@ -154,7 +154,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
/**
* Gets the error stream.
*
- * @return <CODE>OutputStream</CODE>.
+ * @return {@link OutputStream}.
*/
protected OutputStream getErr() {
return err;
@@ -163,16 +163,16 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
/**
* Gets the output stream.
*
- * @return <CODE>OutputStream</CODE>.
+ * @return {@link OutputStream}.
*/
protected OutputStream getOut() {
return out;
}
/**
- * Sets the <CODE>InputStream</CODE> from which to read the standard error of the process.
+ * Sets the {@link InputStream} from which to read the standard error of the process.
*
- * @param is the <CODE>InputStream</CODE>.
+ * @param is the {@link InputStream}.
*/
@Override
public void setProcessErrorStream(final InputStream is) {
@@ -182,9 +182,9 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Sets the <CODE>OutputStream</CODE> by means of which input can be sent to the process.
+ * Sets the {@link OutputStream} by means of which input can be sent to the process.
*
- * @param os the <CODE>OutputStream</CODE>.
+ * @param os the {@link OutputStream}.
*/
@Override
public void setProcessInputStream(final OutputStream os) {
@@ -205,9 +205,9 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Sets the <CODE>InputStream</CODE> from which to read the standard output of the process.
+ * Sets the {@link InputStream} from which to read the standard output of the process.
*
- * @param is the <CODE>InputStream</CODE>.
+ * @param is the {@link InputStream}.
*/
@Override
public void setProcessOutputStream(final InputStream is) {
@@ -226,7 +226,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Start the <CODE>Thread</CODE>s.
+ * Start the {@link Thread}s.
*/
@Override
public void start() {
(commons-exec) 06/07: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-exec.git
commit 48f487460ba89bf77bd2d5db7df4ecb59c1d3f5a
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:20:22 2023 -0500
Javadoc
---
src/main/java/org/apache/commons/exec/StreamPumper.java | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/exec/StreamPumper.java b/src/main/java/org/apache/commons/exec/StreamPumper.java
index 64aa2275..880794a3 100644
--- a/src/main/java/org/apache/commons/exec/StreamPumper.java
+++ b/src/main/java/org/apache/commons/exec/StreamPumper.java
@@ -47,7 +47,7 @@ public class StreamPumper implements Runnable {
private final boolean closeWhenExhausted;
/**
- * Create a new stream pumper.
+ * Constructs a new stream pumper.
*
* @param is input stream to read data from
* @param os output stream to write data to.
@@ -57,7 +57,7 @@ public class StreamPumper implements Runnable {
}
/**
- * Create a new stream pumper.
+ * Constructs a new stream pumper.
*
* @param is input stream to read data from
* @param os output stream to write data to.
@@ -71,7 +71,7 @@ public class StreamPumper implements Runnable {
}
/**
- * Create a new stream pumper.
+ * Constructs a new stream pumper.
*
* @param is input stream to read data from
* @param os output stream to write data to.
@@ -86,7 +86,7 @@ public class StreamPumper implements Runnable {
}
/**
- * Tells whether the end of the stream has been reached.
+ * Tests whether the end of the stream has been reached.
*
* @return true is the stream has been exhausted.
*/