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 2020/11/21 18:56:23 UTC

[commons-exec] branch master updated: Add missing '@Override' annotations.

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 15ba0e8  Add missing '@Override' annotations.
15ba0e8 is described below

commit 15ba0e88661a466e8fc8555549a12096e9093f42
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Nov 21 13:56:19 2020 -0500

    Add missing '@Override' annotations.
---
 .../apache/commons/exec/DefaultExecuteResultHandler.java |  2 ++
 .../java/org/apache/commons/exec/DefaultExecutor.java    | 16 ++++++++++++++++
 .../java/org/apache/commons/exec/ExecuteWatchdog.java    |  1 +
 .../java/org/apache/commons/exec/InputStreamPumper.java  |  1 +
 .../java/org/apache/commons/exec/PumpStreamHandler.java  |  5 +++++
 .../commons/exec/ShutdownHookProcessDestroyer.java       |  8 ++++++--
 src/main/java/org/apache/commons/exec/StreamPumper.java  |  1 +
 src/main/java/org/apache/commons/exec/Watchdog.java      |  1 +
 .../exec/environment/DefaultProcessingEnvironment.java   |  1 +
 .../commons/exec/launcher/CommandLauncherImpl.java       |  3 +++
 10 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
index a90adf0..9df5043 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecuteResultHandler.java
@@ -48,6 +48,7 @@ public class DefaultExecuteResultHandler implements ExecuteResultHandler {
     /**
      * @see org.apache.commons.exec.ExecuteResultHandler#onProcessComplete(int)
      */
+    @Override
     public void onProcessComplete(final int exitValue) {
         this.exitValue = exitValue;
         this.exception = null;
@@ -57,6 +58,7 @@ public class DefaultExecuteResultHandler implements ExecuteResultHandler {
     /**
      * @see org.apache.commons.exec.ExecuteResultHandler#onProcessFailed(org.apache.commons.exec.ExecuteException)
      */
+    @Override
     public void onProcessFailed(final ExecuteException e) {
         this.exitValue = e.getExitValue();            
         this.exception = e;
diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
index 2cc7264..d1cb07d 100644
--- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java
+++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java
@@ -91,6 +91,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#getStreamHandler()
      */
+    @Override
     public ExecuteStreamHandler getStreamHandler() {
         return streamHandler;
     }
@@ -98,6 +99,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#setStreamHandler(org.apache.commons.exec.ExecuteStreamHandler)
      */
+    @Override
     public void setStreamHandler(final ExecuteStreamHandler streamHandler) {
         this.streamHandler = streamHandler;
     }
@@ -105,6 +107,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#getWatchdog()
      */
+    @Override
     public ExecuteWatchdog getWatchdog() {
         return watchdog;
     }
@@ -112,6 +115,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#setWatchdog(org.apache.commons.exec.ExecuteWatchdog)
      */
+    @Override
     public void setWatchdog(final ExecuteWatchdog watchDog) {
         this.watchdog = watchDog;
     }
@@ -119,6 +123,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#getProcessDestroyer()
      */
+    @Override
     public ProcessDestroyer getProcessDestroyer() {
       return this.processDestroyer;
     }
@@ -126,6 +131,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#setProcessDestroyer(ProcessDestroyer)
      */
+    @Override
     public void setProcessDestroyer(final ProcessDestroyer processDestroyer) {
       this.processDestroyer = processDestroyer;
     }
@@ -133,6 +139,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#getWorkingDirectory()
      */
+    @Override
     public File getWorkingDirectory() {
         return workingDirectory;
     }
@@ -140,6 +147,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#setWorkingDirectory(java.io.File)
      */
+    @Override
     public void setWorkingDirectory(final File dir) {
         this.workingDirectory = dir;
     }
@@ -147,6 +155,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#execute(CommandLine)
      */
+    @Override
     public int execute(final CommandLine command) throws ExecuteException,
             IOException {
         return execute(command, (Map<String, String>) null);
@@ -155,6 +164,7 @@ public class DefaultExecutor implements Executor {
     /**
      * @see org.apache.commons.exec.Executor#execute(CommandLine, java.util.Map)
      */
+    @Override
     public int execute(final CommandLine command, final Map<String, String> environment)
             throws ExecuteException, IOException {
 
@@ -170,6 +180,7 @@ public class DefaultExecutor implements Executor {
      * @see org.apache.commons.exec.Executor#execute(CommandLine,
      *      org.apache.commons.exec.ExecuteResultHandler)
      */
+    @Override
     public void execute(final CommandLine command, final ExecuteResultHandler handler)
             throws ExecuteException, IOException {
         execute(command, null, handler);
@@ -179,6 +190,7 @@ public class DefaultExecutor implements Executor {
      * @see org.apache.commons.exec.Executor#execute(CommandLine,
      *      java.util.Map, org.apache.commons.exec.ExecuteResultHandler)
      */
+    @Override
     public void execute(final CommandLine command, final Map<String, String> environment,
             final ExecuteResultHandler handler) throws ExecuteException, IOException {
 
@@ -192,6 +204,7 @@ public class DefaultExecutor implements Executor {
 
         final Runnable runnable = new Runnable()
         {
+            @Override
             public void run()
             {
                 int exitValue = Executor.INVALID_EXITVALUE;
@@ -211,17 +224,20 @@ public class DefaultExecutor implements Executor {
     }
 
     /** @see org.apache.commons.exec.Executor#setExitValue(int) */
+    @Override
     public void setExitValue(final int value) {
         this.setExitValues(new int[] {value});
     }
 
 
     /** @see org.apache.commons.exec.Executor#setExitValues(int[]) */
+    @Override
     public void setExitValues(final int[] values) {
         this.exitValues = values == null ? null : (int[]) values.clone();
     }
 
     /** @see org.apache.commons.exec.Executor#isFailure(int) */
+    @Override
     public boolean isFailure(final int exitValue) {
 
         if (this.exitValues == null) {
diff --git a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
index 6958189..862149f 100644
--- a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
+++ b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java
@@ -157,6 +157,7 @@ public class ExecuteWatchdog implements TimeoutObserver {
     /**
      * Called after watchdog has finished.
      */
+    @Override
     public synchronized void timeoutOccured(final Watchdog w) {
         try {
             try {
diff --git a/src/main/java/org/apache/commons/exec/InputStreamPumper.java b/src/main/java/org/apache/commons/exec/InputStreamPumper.java
index 173fb37..d84a775 100644
--- a/src/main/java/org/apache/commons/exec/InputStreamPumper.java
+++ b/src/main/java/org/apache/commons/exec/InputStreamPumper.java
@@ -58,6 +58,7 @@ public class InputStreamPumper implements Runnable {
      * Copies data from the input stream to the output stream. Terminates as
      * soon as the input stream is closed or an error occurs.
      */
+    @Override
     public void run() {
         try {
             while (!stop) {
diff --git a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
index 660ed47..efe5f43 100644
--- a/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
+++ b/src/main/java/org/apache/commons/exec/PumpStreamHandler.java
@@ -110,6 +110,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
      *
      * @param is the <CODE>InputStream</CODE>.
      */
+    @Override
     public void setProcessOutputStream(final InputStream is) {
         if (out != null) {
             createProcessOutputPump(is, out);
@@ -122,6 +123,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
      *
      * @param is the <CODE>InputStream</CODE>.
      */
+    @Override
     public void setProcessErrorStream(final InputStream is) {
         if (err != null) {
             createProcessErrorPump(is, err);
@@ -134,6 +136,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
      *
      * @param os the <CODE>OutputStream</CODE>.
      */
+    @Override
     public void setProcessInputStream(final OutputStream os) {
         if (input != null) {
             if (input == System.in) {
@@ -154,6 +157,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
     /**
      * Start the <CODE>Thread</CODE>s.
      */
+    @Override
     public void start() {
         if (outputThread != null) {
             outputThread.start();
@@ -170,6 +174,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler {
      * Stop pumping the streams. When a timeout is specified it it is not guaranteed that the
      * pumper threads are cleanly terminated.
      */
+    @Override
     public void stop() throws IOException {
 
         if (inputStreamPumper != null) {
diff --git a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
index 3a5d715..13d94a7 100644
--- a/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
+++ b/src/main/java/org/apache/commons/exec/ShutdownHookProcessDestroyer.java
@@ -136,6 +136,7 @@ public class ShutdownHookProcessDestroyer implements ProcessDestroyer, Runnable
      * @return {@code true} if the specified {@code Process} was
      *         successfully added
      */
+    @Override
     public boolean add(final Process process) {
         synchronized (processes) {
             // if this list is empty, register the shutdown hook
@@ -156,6 +157,7 @@ public class ShutdownHookProcessDestroyer implements ProcessDestroyer, Runnable
      * @return {@code true} if the specified {@code Process} was
      *         successfully removed
      */
+    @Override
     public boolean remove(final Process process) {
         synchronized (processes) {
             final boolean processRemoved = processes.removeElement(process);
@@ -171,14 +173,16 @@ public class ShutdownHookProcessDestroyer implements ProcessDestroyer, Runnable
    *
    * @return the number of register process
    */
-  public int size() {
+  @Override
+public int size() {
     return processes.size();
   }
 
   /**
      * Invoked by the VM when it is exiting.
      */
-  public void run() {
+  @Override
+public void run() {
       synchronized (processes) {
           running = true;
           final Enumeration<Process> e = processes.elements();
diff --git a/src/main/java/org/apache/commons/exec/StreamPumper.java b/src/main/java/org/apache/commons/exec/StreamPumper.java
index cb44101..68aa7ea 100644
--- a/src/main/java/org/apache/commons/exec/StreamPumper.java
+++ b/src/main/java/org/apache/commons/exec/StreamPumper.java
@@ -93,6 +93,7 @@ public class StreamPumper implements Runnable {
      * Copies data from the input stream to the output stream. Terminates as
      * soon as the input stream is closed or an error occurs.
      */
+    @Override
     public void run() {
         synchronized (this) {
             // Just in case this object is reused in the future
diff --git a/src/main/java/org/apache/commons/exec/Watchdog.java b/src/main/java/org/apache/commons/exec/Watchdog.java
index e405709..b6e9ddc 100644
--- a/src/main/java/org/apache/commons/exec/Watchdog.java
+++ b/src/main/java/org/apache/commons/exec/Watchdog.java
@@ -69,6 +69,7 @@ public class Watchdog implements Runnable {
         notifyAll();
     }
 
+    @Override
     public void run() {
         final long startTime = System.currentTimeMillis();
         boolean isWaiting;
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 f1018c1..f673112 100644
--- a/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
+++ b/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java
@@ -217,6 +217,7 @@ public class DefaultProcessingEnvironment {
     private Map<String, String> createEnvironmentMap() {
         if (OS.isFamilyWindows()) {
             return new TreeMap<>(new Comparator<String>() {
+                @Override
                 public int compare(final String key0, final String key1) {
                     return key0.compareToIgnoreCase(key1);
                 }
diff --git a/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java b/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java
index fd60c8a..47d9074 100644
--- a/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java
+++ b/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java
@@ -33,16 +33,19 @@ import org.apache.commons.exec.environment.EnvironmentUtils;
  */
 public abstract class CommandLauncherImpl implements CommandLauncher {
 
+    @Override
     public Process exec(final CommandLine cmd, final Map<String, String> env)
             throws IOException {
         final String[] envVar = EnvironmentUtils.toStrings(env);
         return Runtime.getRuntime().exec(cmd.toStrings(), envVar);
     }
 
+    @Override
     public abstract Process exec(final CommandLine cmd, final Map<String, String> env,
             final File workingDir) throws IOException;
 
     /** @see org.apache.commons.exec.launcher.CommandLauncher#isFailure(int) */    
+    @Override
     public boolean isFailure(final int exitValue)
     {
         // non zero exit value signals failure