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:14:44 UTC
(commons-exec) 12/12: Javadoc
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 bccdbfac7806945815bef6d23848683c19546132
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Dec 29 11:14:27 2023 -0500
Javadoc
---
src/changes/changes.xml | 2 +-
src/main/java/org/apache/commons/exec/Executor.java | 16 ++++++++--------
2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 1398d7de..2c742142 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -42,7 +42,7 @@
<action dev="ggregory" type="fix" due-to="ArdenL-Liu, Gary Gregory">[Javadoc] CommandLine.toCleanExecutable(final String dirtyExecutable) IllegalArgumentException #61.</action>
<action dev="ggregory" type="fix" due-to="Gary Gregory">ExecuteException propagates its cause to its IOException superclass.</action>
<action dev="ggregory" type="fix" due-to="Gary Gregory">Propagate exception in DebugUtils.handleException(String, Exception).</action>
- <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate StringUtils.toString(String[], String) in favor of String#join(CharSequence, CharSequence...).</action>
+ <action dev="ggregory" type="fix" due-to="Gary Gregory">Deprecate StringUtils.toString(String[], String) in favor of String.join(CharSequence, CharSequence...).</action>
<!-- REMOVE -->
<action dev="ggregory" type="remove" due-to="Gary Gregory">Deprecate DefaultExecuteResultHandler.waitFor(long).</action>
<action dev="ggregory" type="remove" due-to="Gary Gregory">Deprecate ExecuteWatchdog.ExecuteWatchdog(long).</action>
diff --git a/src/main/java/org/apache/commons/exec/Executor.java b/src/main/java/org/apache/commons/exec/Executor.java
index 16bef12c..42cdaa00 100644
--- a/src/main/java/org/apache/commons/exec/Executor.java
+++ b/src/main/java/org/apache/commons/exec/Executor.java
@@ -49,7 +49,7 @@ public interface Executor {
int INVALID_EXITVALUE = 0xdeadbeef;
/**
- * Methods for starting synchronous execution. The child process inherits all environment variables of the parent process.
+ * Executes a command synchronously. The child process inherits all environment variables of the parent process.
*
* @param command the command to execute
* @return process exit value
@@ -59,7 +59,7 @@ public interface Executor {
int execute(CommandLine command) throws ExecuteException, IOException;
/**
- * Methods for starting asynchronous execution. The child process inherits all environment variables of the parent process. Result provided to callback
+ * Executes a command asynchronously. The child process inherits all environment variables of the parent process. Result provided to callback
* handler.
*
* @param command the command to execute
@@ -70,7 +70,7 @@ public interface Executor {
void execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, IOException;
/**
- * Methods for starting synchronous execution.
+ * Executes a command synchronously.
*
* @param command the command to execute
* @param environment The environment for the new process. If null, the environment of the current process is used.
@@ -81,7 +81,7 @@ public interface Executor {
int execute(CommandLine command, Map<String, String> environment) throws ExecuteException, IOException;
/**
- * Methods for starting asynchronous execution. The child process inherits all environment variables of the parent process. Result provided to callback
+ * Executes a command asynchronously. The child process inherits all environment variables of the parent process. Result provided to callback
* handler.
*
* @param command the command to execute
@@ -121,7 +121,7 @@ public interface Executor {
File getWorkingDirectory();
/**
- * Checks whether {@code exitValue} signals a failure. If no exit values are set than the default conventions of the OS is used. e.g. most OS regard an exit
+ * Tests whether {@code exitValue} signals a failure. If no exit values are set than the default conventions of the OS is used. e.g. most OS regard an exit
* code of '0' as successful execution and everything else as failure.
*
* @param exitValue the exit value (return code) to be checked
@@ -130,7 +130,7 @@ public interface Executor {
boolean isFailure(final int exitValue);
/**
- * Define the {@code exitValue} of the process to be considered successful. If a different exit value is returned by the process then
+ * Sets the {@code exitValue} of the process to be considered successful. If a different exit value is returned by the process then
* {@link org.apache.commons.exec.Executor#execute(CommandLine)} will throw an {@link org.apache.commons.exec.ExecuteException}
*
* @param value the exit code representing successful execution
@@ -138,7 +138,7 @@ public interface Executor {
void setExitValue(final int value);
/**
- * Define a list of {@code exitValue} of the process to be considered successful. The caller can pass one of the following values
+ * Sets a list of {@code exitValue} of the process to be considered successful. The caller can pass one of the following values
* <ul>
* <li>an array of exit values to be considered successful</li>
* <li>an empty array for auto-detect of successful exit codes relying on {@link org.apache.commons.exec.Executor#isFailure(int)}</li>
@@ -153,7 +153,7 @@ public interface Executor {
void setExitValues(final int[] values);
/**
- * Gets the handler for cleanup of started processes if the main process is going to terminate.
+ * Sets the handler for cleanup of started processes if the main process is going to terminate.
*
* @param processDestroyer the ProcessDestroyer
*/