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/10/31 10:46:19 UTC
(commons-exec) branch master updated: Normalize getter 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
The following commit(s) were added to refs/heads/master by this push:
new cc083fb Normalize getter Javadoc
cc083fb is described below
commit cc083fbe2500c3eabb7a1fad9e886553540e8c03
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Oct 31 06:46:15 2023 -0400
Normalize getter Javadoc
---
.../java/org/apache/commons/exec/DefaultExecuteResultHandler.java | 4 ++--
src/main/java/org/apache/commons/exec/DefaultExecutor.java | 4 ++--
src/main/java/org/apache/commons/exec/Executor.java | 8 ++++----
src/main/java/org/apache/commons/exec/PumpStreamHandler.java | 4 ++--
.../org/apache/commons/exec/environment/EnvironmentUtils.java | 2 +-
src/test/java/org/apache/commons/exec/AbstractExecTest.java | 2 +-
src/test/java/org/apache/commons/exec/TestUtil.java | 2 +-
7 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
index bcfe175..08294ef 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
@@ -64,7 +64,7 @@ public class DefaultExecuteResultHandler implements ExecuteResultHandler {
}
/**
- * Get the {@code exception} causing the process execution to fail.
+ * Gets the {@code exception} causing the process execution to fail.
*
* @return Returns the exception.
* @throws IllegalStateException if the process has not exited yet
@@ -79,7 +79,7 @@ public class DefaultExecuteResultHandler implements ExecuteResultHandler {
}
/**
- * Get the {@code exitValue} of the process.
+ * Gets the {@code exitValue} of the process.
*
* @return Returns the exitValue.
* @throws IllegalStateException if the process has not exited yet
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
index 251ddf3..e6ed99b 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
@@ -285,7 +285,7 @@ public class DefaultExecutor implements Executor {
}
/**
- * Get the worker thread being used for asynchronous execution.
+ * Gets the worker thread being used for asynchronous execution.
*
* @return the worker thread
*/
@@ -445,7 +445,7 @@ public class DefaultExecutor implements Executor {
}
/**
- * Get the first IOException being thrown.
+ * Gets the first IOException being thrown.
*
* @return the first IOException being caught
*/
diff --git a/src/main/java/org/apache/commons/exec/Executor.java b/src/main/java/org/apache/commons/exec/Executor.java
index c70e867..557d3f2 100644
--- a/src/main/java/org/apache/commons/exec/Executor.java
+++ b/src/main/java/org/apache/commons/exec/Executor.java
@@ -87,7 +87,7 @@ public interface Executor {
boolean isFailure(final int exitValue);
/**
- * Get the StreamHandler used for providing input and
+ * Gets the StreamHandler used for providing input and
* retrieving the output.
*
* @return the StreamHandler
@@ -106,7 +106,7 @@ public interface Executor {
void setStreamHandler(ExecuteStreamHandler streamHandler);
/**
- * Get the watchdog used to kill of processes running,
+ * Gets the watchdog used to kill of processes running,
* typically, too long time.
*
* @return the watchdog
@@ -130,7 +130,7 @@ public interface Executor {
ProcessDestroyer getProcessDestroyer();
/**
- * Get the handler for cleanup of started processes if the main process
+ * Gets the handler for cleanup of started processes if the main process
* is going to terminate.
*
* @param processDestroyer the ProcessDestroyer
@@ -138,7 +138,7 @@ public interface Executor {
void setProcessDestroyer(ProcessDestroyer processDestroyer);
/**
- * Get the working directory of the created process.
+ * Gets the working directory of the created process.
*
* @return the working directory
*/
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 4dd8276..5838934 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -207,7 +207,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Get the error stream.
+ * Gets the error stream.
*
* @return <CODE>OutputStream</CODE>.
*/
@@ -216,7 +216,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
}
/**
- * Get the output stream.
+ * Gets the output stream.
*
* @return <CODE>OutputStream</CODE>.
*/
diff --git a/src/main/java/org/apache/commons/exec/environment/EnvironmentUtils.java b/src/main/java/org/apache/commons/exec/environment/EnvironmentUtils.java
index 515b04e..edb2602 100644
--- a/src/main/java/org/apache/commons/exec/environment/EnvironmentUtils.java
+++ b/src/main/java/org/apache/commons/exec/environment/EnvironmentUtils.java
@@ -47,7 +47,7 @@ public class EnvironmentUtils
}
/**
- * Get the variable list as an array.
+ * Gets the variable list as an array.
*
* @param environment the environment to use, may be {@code null}
* @return array of key=value assignment strings or {@code null} if and only if
diff --git a/src/test/java/org/apache/commons/exec/AbstractExecTest.java b/src/test/java/org/apache/commons/exec/AbstractExecTest.java
index 902c02a..75aceac 100644
--- a/src/test/java/org/apache/commons/exec/AbstractExecTest.java
+++ b/src/test/java/org/apache/commons/exec/AbstractExecTest.java
@@ -56,7 +56,7 @@ public abstract class AbstractExecTest {
}
/**
- * Get the name of the currently executed test.
+ * Gets the name of the currently executed test.
*/
protected String getName() {
return name.getMethodName();
diff --git a/src/test/java/org/apache/commons/exec/TestUtil.java b/src/test/java/org/apache/commons/exec/TestUtil.java
index 58036fd..ec16856 100644
--- a/src/test/java/org/apache/commons/exec/TestUtil.java
+++ b/src/test/java/org/apache/commons/exec/TestUtil.java
@@ -42,7 +42,7 @@ public final class TestUtil {
}
/**
- * Get success and fail return codes used by the test scripts
+ * Gets success and fail return codes used by the test scripts
* @return int array[2] = {ok, success}
*/
public static int[] getTestScriptCodesForOS() {