This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 60e05c88 Javadoc
60e05c88 is described below
commit 60e05c8811d3a35cdfe0b9da37a276cc565c4ca3
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:45:59 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/exec/CommandLine.java | 14 +++++++-------
src/main/java/org/apache/commons/exec/DaemonExecutor.java | 2 +-
.../apache/commons/exec/DefaultExecuteResultHandler.java | 4 ++--
src/main/java/org/apache/commons/exec/DefaultExecutor.java | 14 +++++++-------
src/main/java/org/apache/commons/exec/ExecuteWatchdog.java | 2 +-
src/main/java/org/apache/commons/exec/Executor.java | 10 +++++-----
src/main/java/org/apache/commons/exec/LogOutputStream.java | 2 +-
.../java/org/apache/commons/exec/ProcessDestroyer.java | 2 +-
.../java/org/apache/commons/exec/PumpStreamHandler.java | 6 +++---
.../apache/commons/exec/ShutdownHookProcessDestroyer.java | 2 +-
src/main/java/org/apache/commons/exec/Watchdog.java | 4 ++--
.../exec/environment/DefaultProcessingEnvironment.java | 2 +-
.../exec/environment/OpenVmsProcessingEnvironment.java | 4 ++--
.../org/apache/commons/exec/launcher/CommandLauncher.java | 6 +++---
.../commons/exec/launcher/CommandLauncherFactory.java | 2 +-
src/main/java/org/apache/commons/exec/util/MapUtils.java | 6 +++---
.../java/org/apache/commons/exec/util/StringUtils.java | 8 ++++----
17 files changed, 45 insertions(+), 45 deletions(-)
diff --git a/src/main/java/org/apache/commons/exec/CommandLine.java
b/src/main/java/org/apache/commons/exec/CommandLine.java
index c924a1fd..8d2207ad 100644
--- a/src/main/java/org/apache/commons/exec/CommandLine.java
+++ b/src/main/java/org/apache/commons/exec/CommandLine.java
@@ -68,7 +68,7 @@ public class CommandLine {
* Create a command line from a string.
*
* @param line the first element becomes the executable, the rest the
arguments.
- * @return the parsed command line.
+ * @return The parsed command line.
* @throws IllegalArgumentException If line is null or all whitespace.
*/
public static CommandLine parse(final String line) {
@@ -80,7 +80,7 @@ public class CommandLine {
*
* @param line the first element becomes the executable, the
rest the arguments.
* @param substitutionMap the name/value pairs used for substitution.
- * @return the parsed command line.
+ * @return The parsed command line.
* @throws IllegalArgumentException If line is null or all whitespace.
*/
public static CommandLine parse(final String line, final Map<String, ?>
substitutionMap) {
@@ -103,7 +103,7 @@ public class CommandLine {
* Crack a command line.
*
* @param toProcess the command line to process.
- * @return the command line broken into strings. An empty or null
toProcess parameter results in a zero sized array.
+ * @return The command line broken into strings. An empty or null
toProcess parameter results in a zero sized array.
*/
private static String[] translateCommandline(final String toProcess) {
if (toProcess == null || toProcess.trim().isEmpty()) {
@@ -325,7 +325,7 @@ public class CommandLine {
* Expand variables in a command line argument.
*
* @param argument the argument.
- * @return the expanded string.
+ * @return The expanded string.
*/
private String expandArgument(final String argument) {
final StringBuffer stringBuffer =
StringUtils.stringSubstitution(argument, getSubstitutionMap(), true);
@@ -364,7 +364,7 @@ public class CommandLine {
/**
* Gets the substitution map.
*
- * @return the substitution map.
+ * @return The substitution map.
*/
public Map<String, ?> getSubstitutionMap() {
return substitutionMap;
@@ -392,7 +392,7 @@ public class CommandLine {
* Cleans the executable string. The argument is trimmed and '/' and '\\'
are replaced with the platform specific file separator char
*
* @param dirtyExecutable the executable.
- * @return the platform-specific executable string.
+ * @return The platform-specific executable string.
* @throws NullPointerException on null input.
* @throws IllegalArgumentException on empty input.
*/
@@ -409,7 +409,7 @@ public class CommandLine {
* Parameters are correctly quoted when containing a space or left
untouched if they are already
* quoted.
*
- * @return the command line as single string.
+ * @return The command line as single string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/exec/DaemonExecutor.java
b/src/main/java/org/apache/commons/exec/DaemonExecutor.java
index 93dcfd01..176f95b3 100644
--- a/src/main/java/org/apache/commons/exec/DaemonExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DaemonExecutor.java
@@ -81,7 +81,7 @@ public class DaemonExecutor extends DefaultExecutor {
*
* @param runnable the runnable passed to the thread.
* @param name the name of the thread.
- * @return the thread.
+ * @return The thread.
*/
@Override
protected Thread createThread(final Runnable runnable, final String name) {
diff --git
a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
index bb077ded..826434fa 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
@@ -50,7 +50,7 @@ public class DefaultExecuteResultHandler implements
ExecuteResultHandler {
/**
* Gets the {@code exception} causing the process execution to fail.
*
- * @return the exception.
+ * @return The exception.
* @throws IllegalStateException if the process has not exited yet.
*/
public ExecuteException getException() {
@@ -63,7 +63,7 @@ public class DefaultExecuteResultHandler implements
ExecuteResultHandler {
/**
* Gets the {@code exitValue} of the process.
*
- * @return the exitValue.
+ * @return The exitValue.
* @throws IllegalStateException if the process has not exited yet.
*/
public int getExitValue() {
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
index bf7a090d..c4f755c9 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
@@ -275,7 +275,7 @@ public class DefaultExecutor implements Executor {
*
* @param runnable the runnable passed to the thread.
* @param name the name of the thread.
- * @return the thread
+ * @return The thread
*/
protected Thread createThread(final Runnable runnable, final String name) {
return ThreadUtil.newThread(threadFactory, runnable, name, false);
@@ -337,7 +337,7 @@ public class DefaultExecutor implements Executor {
* @param environment the execution environment.
* @param workingDirectory the working directory.
* @param streams process the streams (in, out, err) of the
process.
- * @return the exit code of the process.
+ * @return The exit code of the process.
* @throws IOException executing the process failed.
*/
private int executeInternal(final CommandLine command, final Map<String,
String> environment, final Path workingDirectory,
@@ -419,7 +419,7 @@ public class DefaultExecutor implements Executor {
/**
* Gets the first IOException being thrown.
*
- * @return the first IOException being caught.
+ * @return The first IOException being caught.
*/
private IOException getExceptionCaught() {
return exceptionCaught;
@@ -428,7 +428,7 @@ public class DefaultExecutor implements Executor {
/**
* Gets the worker thread being used for asynchronous execution.
*
- * @return the worker thread.
+ * @return The worker thread.
*/
protected Thread getExecutorThread() {
return executorThread;
@@ -453,7 +453,7 @@ public class DefaultExecutor implements Executor {
/**
* Gets the thread factory. Z
*
- * @return the thread factory.
+ * @return The thread factory.
*/
ThreadFactory getThreadFactory() {
return threadFactory;
@@ -498,7 +498,7 @@ public class DefaultExecutor implements Executor {
* @param command the command to run.
* @param env the environment for the command.
* @param workingDirectory the working directory for the command.
- * @return the process started.
+ * @return The process started.
* @throws IOException forwarded from the particular launcher used.
*/
protected Process launch(final CommandLine command, final Map<String,
String> env, final File workingDirectory) throws IOException {
@@ -515,7 +515,7 @@ public class DefaultExecutor implements Executor {
* @param command the command to run.
* @param env the environment for the command.
* @param workingDirectory the working directory for the command.
- * @return the process started.
+ * @return The process started.
* @throws IOException forwarded from the particular launcher used.
* @since 1.5.0
*/
diff --git a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
index 9bc89014..98c8c89b 100644
--- a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
+++ b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
@@ -237,7 +237,7 @@ public class ExecuteWatchdog implements TimeoutObserver {
/**
* Gets the watchdog.
*
- * @return the watchdog.
+ * @return The watchdog.
*/
Watchdog getWatchdog() {
return watchdog;
diff --git a/src/main/java/org/apache/commons/exec/Executor.java
b/src/main/java/org/apache/commons/exec/Executor.java
index 7fd9cfc5..5afd9817 100644
--- a/src/main/java/org/apache/commons/exec/Executor.java
+++ b/src/main/java/org/apache/commons/exec/Executor.java
@@ -97,35 +97,35 @@ public interface Executor {
/**
* Sets the handler for cleanup of started processes if the main process
is going to terminate.
*
- * @return the ProcessDestroyer.
+ * @return The ProcessDestroyer.
*/
ProcessDestroyer getProcessDestroyer();
/**
* Gets the StreamHandler used for providing input and retrieving the
output.
*
- * @return the StreamHandler.
+ * @return The StreamHandler.
*/
ExecuteStreamHandler getStreamHandler();
/**
* Gets the watchdog used to kill of processes running, typically, too
long time.
*
- * @return the watchdog.
+ * @return The watchdog.
*/
ExecuteWatchdog getWatchdog();
/**
* Gets the working directory of the created process.
*
- * @return the working directory.
+ * @return The working directory.
*/
File getWorkingDirectory();
/**
* Gets the working directory of the created process.
*
- * @return the working directory.
+ * @return The working directory.
* @since 1.5.0
*/
default Path getWorkingDirectoryPath() {
diff --git a/src/main/java/org/apache/commons/exec/LogOutputStream.java
b/src/main/java/org/apache/commons/exec/LogOutputStream.java
index faa8c939..54cd1fa2 100644
--- a/src/main/java/org/apache/commons/exec/LogOutputStream.java
+++ b/src/main/java/org/apache/commons/exec/LogOutputStream.java
@@ -122,7 +122,7 @@ public abstract class LogOutputStream extends OutputStream {
/**
* Gets the trace level of the log system.
*
- * @return the trace level of the log system.
+ * @return The trace level of the log system.
*/
public int getMessageLevel() {
return level;
diff --git a/src/main/java/org/apache/commons/exec/ProcessDestroyer.java
b/src/main/java/org/apache/commons/exec/ProcessDestroyer.java
index ed92e8f0..d803bb2a 100644
--- a/src/main/java/org/apache/commons/exec/ProcessDestroyer.java
+++ b/src/main/java/org/apache/commons/exec/ProcessDestroyer.java
@@ -45,7 +45,7 @@ public interface ProcessDestroyer {
/**
* Returns the number of registered processes.
*
- * @return the number of register process.
+ * @return The number of register process.
*/
int size();
}
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 93ce6f15..08d024a6 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -164,7 +164,7 @@ public class PumpStreamHandler implements
ExecuteStreamHandler {
*
* @param is the input stream to copy from.
* @param os the output stream to copy into.
- * @return the stream pumper thread.
+ * @return The stream pumper thread.
*/
protected Thread createPump(final InputStream is, final OutputStream os) {
return createPump(is, os, os instanceof PipedOutputStream);
@@ -176,7 +176,7 @@ public class PumpStreamHandler implements
ExecuteStreamHandler {
* @param is the input stream to copy from.
* @param os the output stream to copy into.
* @param closeWhenExhausted close the output stream when the input stream
is exhausted.
- * @return the stream pumper thread.
+ * @return The stream pumper thread.
*/
protected Thread createPump(final InputStream is, final OutputStream os,
final boolean closeWhenExhausted) {
return ThreadUtil.newThread(threadFactory, new StreamPumper(is, os,
closeWhenExhausted), "CommonsExecStreamPumper-", true);
@@ -187,7 +187,7 @@ public class PumpStreamHandler implements
ExecuteStreamHandler {
*
* @param is the System.in input stream to copy from.
* @param os the output stream to copy into.
- * @return the stream pumper thread.
+ * @return The stream pumper thread.
*/
private Thread createSystemInPump(final InputStream is, final OutputStream
os) {
inputStreamPumper = new InputStreamPumper(is, os);
diff --git
a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
index 1035bf5c..3475ca51 100644
--- a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
+++ b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
@@ -184,7 +184,7 @@ public class ShutdownHookProcessDestroyer implements
ProcessDestroyer, Runnable
/**
* Returns the number of registered processes.
*
- * @return the number of register process.
+ * @return The number of register process.
*/
@Override
public int size() {
diff --git a/src/main/java/org/apache/commons/exec/Watchdog.java
b/src/main/java/org/apache/commons/exec/Watchdog.java
index ee07af32..cce9d8c4 100644
--- a/src/main/java/org/apache/commons/exec/Watchdog.java
+++ b/src/main/java/org/apache/commons/exec/Watchdog.java
@@ -168,7 +168,7 @@ public class Watchdog implements Runnable {
/**
* Gets the thread factory.
*
- * @return the thread factory.
+ * @return The thread factory.
*/
ThreadFactory getThreadFactory() {
return threadFactory;
@@ -177,7 +177,7 @@ public class Watchdog implements Runnable {
/**
* Gets the timeout.
*
- * @return the timeout.
+ * @return The timeout.
* @since 1.6.0
*/
public Duration getTimeout() {
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 7cde6665..74bc0520 100644
---
a/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
+++
b/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
@@ -73,7 +73,7 @@ public class DefaultProcessingEnvironment {
/**
* Determine the OS specific command line to get a list of environment
variables.
*
- * @return the command line.
+ * @return The command line.
* @deprecated No longer needed.
*/
@Deprecated
diff --git
a/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java
b/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java
index a4c4964c..6ccd46b1 100644
---
a/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java
+++
b/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java
@@ -65,7 +65,7 @@ public class OpenVmsProcessingEnvironment extends
DefaultProcessingEnvironment {
// * Determine the OS specific command line to get a list of environment
// * variables.
// *
-// * @return the command line
+// * @return The command line
// */
// @Override
// protected CommandLine getProcEnvCommand() {
@@ -82,7 +82,7 @@ public class OpenVmsProcessingEnvironment extends
DefaultProcessingEnvironment {
// *
// * @param environment the current environment
// * @param in the reader from the process to determine VMS env variables
-// * @return the updated environment
+// * @return The updated environment
// * @throws IOException operation failed
// */
// private Map<String, String> addVMSenvironmentVariables(final Map<String,
String> environment,
diff --git
a/src/main/java/org/apache/commons/exec/launcher/CommandLauncher.java
b/src/main/java/org/apache/commons/exec/launcher/CommandLauncher.java
index 2a5ce867..a814b3c3 100644
--- a/src/main/java/org/apache/commons/exec/launcher/CommandLauncher.java
+++ b/src/main/java/org/apache/commons/exec/launcher/CommandLauncher.java
@@ -36,7 +36,7 @@ public interface CommandLauncher {
*
* @param commandLine The command to execute.
* @param env The environment for the new process. If null, the
environment of the current process is used.
- * @return the newly created process.
+ * @return The newly created process.
* @throws IOException if attempting to run a command in a specific
directory.
*/
Process exec(CommandLine commandLine, Map<String, String> env) throws
IOException;
@@ -47,7 +47,7 @@ public interface CommandLauncher {
* @param commandLine The command to execute.
* @param env The environment for the new process. If null,
the environment of the current process is used.
* @param workingDirectory The directory to start the command in. If null,
the current directory is used.
- * @return the newly created process.
+ * @return The newly created process.
* @throws IOException if trying to change directory.
*/
Process exec(CommandLine commandLine, Map<String, String> env, File
workingDirectory) throws IOException;
@@ -58,7 +58,7 @@ public interface CommandLauncher {
* @param commandLine The command to execute.
* @param env The environment for the new process. If null,
the environment of the current process is used.
* @param workingDirectory The directory to start the command in. If null,
the current directory is used.
- * @return the newly created process.
+ * @return The newly created process.
* @throws IOException if trying to change directory.
* @since 1.5.0
*/
diff --git
a/src/main/java/org/apache/commons/exec/launcher/CommandLauncherFactory.java
b/src/main/java/org/apache/commons/exec/launcher/CommandLauncherFactory.java
index d2942f04..1903cf20 100644
--- a/src/main/java/org/apache/commons/exec/launcher/CommandLauncherFactory.java
+++ b/src/main/java/org/apache/commons/exec/launcher/CommandLauncherFactory.java
@@ -29,7 +29,7 @@ public final class CommandLauncherFactory {
/**
* Factory method to create an appropriate launcher.
*
- * @return the command launcher.
+ * @return The command launcher.
*/
public static CommandLauncher createVMLauncher() {
// Try using a JDK 1.3 launcher
diff --git a/src/main/java/org/apache/commons/exec/util/MapUtils.java
b/src/main/java/org/apache/commons/exec/util/MapUtils.java
index a91abb9b..b82b9006 100644
--- a/src/main/java/org/apache/commons/exec/util/MapUtils.java
+++ b/src/main/java/org/apache/commons/exec/util/MapUtils.java
@@ -34,7 +34,7 @@ public class MapUtils {
* @param source the Map to clone.
* @param <K> the map key type.
* @param <V> the map value type.
- * @return the cloned map.
+ * @return The cloned map.
*/
public static <K, V> Map<K, V> copy(final Map<K, V> source) {
return source == null ? null : new HashMap<>(source);
@@ -47,7 +47,7 @@ public class MapUtils {
* @param rhs the second map.
* @param <K> The map key type.
* @param <V> The map value type.
- * @return the merged map.
+ * @return The merged map.
*/
public static <K, V> Map<K, V> merge(final Map<K, V> lhs, final Map<K, V>
rhs) {
Map<K, V> result = null;
@@ -69,7 +69,7 @@ public class MapUtils {
* @param prefix the prefix used for all names.
* @param <K> the map key type.
* @param <V> the map value type.
- * @return the clone of the source map.
+ * @return The clone of the source map.
*/
public static <K, V> Map<String, V> prefix(final Map<K, V> source, final
String prefix) {
if (source == null) {
diff --git a/src/main/java/org/apache/commons/exec/util/StringUtils.java
b/src/main/java/org/apache/commons/exec/util/StringUtils.java
index dbc87be2..dfef5e69 100644
--- a/src/main/java/org/apache/commons/exec/util/StringUtils.java
+++ b/src/main/java/org/apache/commons/exec/util/StringUtils.java
@@ -56,7 +56,7 @@ public class StringUtils {
* </ul>
*
* @param arg the argument to fix.
- * @return the transformed argument.
+ * @return The transformed argument.
*/
public static String fixFileSeparatorChar(final String arg) {
return arg.replace(SLASH_CHAR,
File.separatorChar).replace(BACKSLASH_CHAR, File.separatorChar);
@@ -80,7 +80,7 @@ public class StringUtils {
* </p>
*
* @param argument the argument to be quoted.
- * @return the quoted argument.
+ * @return The quoted argument.
* @throws IllegalArgumentException If argument contains both types of
quotes.
*/
public static String quoteArgument(final String argument) {
@@ -114,7 +114,7 @@ public class StringUtils {
*
* @param input what to split.
* @param splitChar what to split on.
- * @return the array of strings.
+ * @return The array of strings.
*/
public static String[] split(final String input, final String splitChar) {
final StringTokenizer tokens = new StringTokenizer(input, splitChar);
@@ -235,7 +235,7 @@ public class StringUtils {
*
* @param strings the strings to concatenate.
* @param separator the separator between two strings.
- * @return the concatenated strings.
+ * @return The concatenated strings.
* @deprecated Use {@link String#join(CharSequence, CharSequence...)}.
*/
@Deprecated
