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
The following commit(s) were added to refs/heads/master by this push:
new 6380a7aa Javadoc
6380a7aa is described below
commit 6380a7aad2c8ce93a53e4580ea5212c92d94b070
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 10:28:03 2023 -0500
Javadoc
---
.../java/org/apache/commons/exec/DefaultExecuteResultHandler.java | 2 +-
src/main/java/org/apache/commons/exec/DefaultExecutor.java | 6 +++---
src/main/java/org/apache/commons/exec/InputStreamPumper.java | 4 ++--
src/main/java/org/apache/commons/exec/LogOutputStream.java | 2 +-
src/main/java/org/apache/commons/exec/PumpStreamHandler.java | 4 ++--
.../org/apache/commons/exec/ShutdownHookProcessDestroyer.java | 2 +-
src/main/java/org/apache/commons/exec/StreamPumper.java | 8 ++++----
.../commons/exec/environment/DefaultProcessingEnvironment.java | 4 ++--
8 files changed, 16 insertions(+), 16 deletions(-)
diff --git
a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
index 331879ca..ccc3a7fc 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
@@ -25,7 +25,7 @@ import java.time.Instant;
*/
public class DefaultExecuteResultHandler implements ExecuteResultHandler {
- /** the interval polling the result */
+ /** The interval polling the result */
private static final int SLEEP_TIME_MS = 50;
/** Keep track if the process is still running */
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
index 92267e3e..f01cc8a9 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
@@ -47,13 +47,13 @@ public class DefaultExecutor implements Executor {
/** taking care of output and error stream */
private ExecuteStreamHandler streamHandler;
- /** the working directory of the process */
+ /** The working directory of the process */
private File workingDirectory;
/** monitoring of long running processes */
private ExecuteWatchdog watchdog;
- /** the exit values considered to be successful */
+ /** The exit values considered to be successful */
private int[] exitValues;
/** launches the command in a new process */
@@ -65,7 +65,7 @@ public class DefaultExecutor implements Executor {
/** worker thread for asynchronous execution */
private Thread executorThread;
- /** the first exception being caught to be thrown to the caller */
+ /** The first exception being caught to be thrown to the caller */
private IOException exceptionCaught;
/**
diff --git a/src/main/java/org/apache/commons/exec/InputStreamPumper.java
b/src/main/java/org/apache/commons/exec/InputStreamPumper.java
index fb1b637a..397442aa 100644
--- a/src/main/java/org/apache/commons/exec/InputStreamPumper.java
+++ b/src/main/java/org/apache/commons/exec/InputStreamPumper.java
@@ -29,10 +29,10 @@ public class InputStreamPumper implements Runnable {
public static final int SLEEPING_TIME = 100;
- /** the input stream to pump from */
+ /** The input stream to pump from */
private final InputStream is;
- /** the output stream to pmp into */
+ /** The output stream to pmp into */
private final OutputStream os;
/** flag to stop the stream pumping */
diff --git a/src/main/java/org/apache/commons/exec/LogOutputStream.java
b/src/main/java/org/apache/commons/exec/LogOutputStream.java
index 22758067..58c09724 100644
--- a/src/main/java/org/apache/commons/exec/LogOutputStream.java
+++ b/src/main/java/org/apache/commons/exec/LogOutputStream.java
@@ -47,7 +47,7 @@ public abstract class LogOutputStream extends OutputStream {
/** Linefeed */
private static final int LF = 0x0a;
- /** the internal buffer */
+ /** The internal buffer */
private final ByteArrayOutputStreamX buffer = new
ByteArrayOutputStreamX(INTIAL_SIZE);
private boolean skip;
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 90f75751..e0f9937e 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -46,10 +46,10 @@ public class PumpStreamHandler implements
ExecuteStreamHandler {
private InputStreamPumper inputStreamPumper;
- /** the timeout in ms the implementation waits when stopping the pumper
threads */
+ /** The timeout in ms the implementation waits when stopping the pumper
threads */
private long stopTimeout;
- /** the last exception being caught */
+ /** The last exception being caught */
private IOException caught;
/**
diff --git
a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
index ebfc03eb..632b282a 100644
--- a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
+++ b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
@@ -45,7 +45,7 @@ public class ShutdownHookProcessDestroyer implements
ProcessDestroyer, Runnable
}
}
- /** the list of currently running processes */
+ /** The list of currently running processes */
private final Vector<Process> processes = new Vector<>();
/** The thread registered at the JVM to execute the shutdown handler */
diff --git a/src/main/java/org/apache/commons/exec/StreamPumper.java
b/src/main/java/org/apache/commons/exec/StreamPumper.java
index 019e4088..bf29ed75 100644
--- a/src/main/java/org/apache/commons/exec/StreamPumper.java
+++ b/src/main/java/org/apache/commons/exec/StreamPumper.java
@@ -28,16 +28,16 @@ import org.apache.commons.exec.util.DebugUtils;
*/
public class StreamPumper implements Runnable {
- /** the default size of the internal buffer for copying the streams */
+ /** The default size of the internal buffer for copying the streams */
private static final int DEFAULT_SIZE = 1024;
- /** the input stream to pump from */
+ /** The input stream to pump from */
private final InputStream is;
- /** the output stream to pmp into */
+ /** The output stream to pmp into */
private final OutputStream os;
- /** the size of the internal buffer for copying the streams */
+ /** The size of the internal buffer for copying the streams */
private final int size;
/** was the end of the stream reached */
diff --git
a/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
b/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
index 35ce4050..c0110532 100644
---
a/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
+++
b/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
@@ -32,10 +32,10 @@ import org.apache.commons.exec.OS;
*/
public class DefaultProcessingEnvironment {
- /** the line separator of the system */
+ /** The line separator of the system */
// private static final String LINE_SEPARATOR =
System.getProperty("line.separator");
- /** the environment variables of the process */
+ /** The environment variables of the process */
protected Map<String, String> procEnvironment;
/**
