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 cf7b16954da511eae705b379f239ec910513d8f0 Author: Gary D. Gregory <garydgreg...@gmail.com> AuthorDate: Wed Feb 19 08:49:21 2025 -0500 Fix Javadoc warnings --- src/changes/changes.xml | 1 + src/main/java/org/apache/commons/exec/DaemonExecutor.java | 7 +++++++ src/main/java/org/apache/commons/exec/DefaultExecutor.java | 9 ++++++++- src/main/java/org/apache/commons/exec/ExecuteWatchdog.java | 7 +++++++ src/main/java/org/apache/commons/exec/Watchdog.java | 7 +++++++ .../commons/exec/environment/DefaultProcessingEnvironment.java | 7 +++++++ .../commons/exec/environment/OpenVmsProcessingEnvironment.java | 7 +++++++ .../org/apache/commons/exec/launcher/CommandLauncherImpl.java | 7 +++++++ .../org/apache/commons/exec/launcher/VmsCommandLauncher.java | 7 +++++++ 9 files changed, 58 insertions(+), 1 deletion(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 1e382ded..7ae6f1a9 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -37,6 +37,7 @@ <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate DebugUtils.DebugUtils().</action> <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate MapUtils.MapUtils().</action> <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate StringUtils.StringUtils().</action> + <action type="fix" dev="ggregory" due-to="Gary Gregory">Fix Javadoc warnings.</action> <!-- UPDATE --> <action type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump org.apache.commons:commons-parent from 65 to 79 #174, #204, #212, #214, #219, #223, #226, #233.</action> </release> diff --git a/src/main/java/org/apache/commons/exec/DaemonExecutor.java b/src/main/java/org/apache/commons/exec/DaemonExecutor.java index 5a08e667..9697fa32 100644 --- a/src/main/java/org/apache/commons/exec/DaemonExecutor.java +++ b/src/main/java/org/apache/commons/exec/DaemonExecutor.java @@ -33,6 +33,13 @@ public class DaemonExecutor extends DefaultExecutor { */ public static class Builder extends DefaultExecutor.Builder<Builder> { + /** + * Constructs a new instance. + */ + public Builder() { + // empty + } + /** * Creates a new configured DaemonExecutor. * diff --git a/src/main/java/org/apache/commons/exec/DefaultExecutor.java b/src/main/java/org/apache/commons/exec/DefaultExecutor.java index 3537d5e8..19a8759a 100644 --- a/src/main/java/org/apache/commons/exec/DefaultExecutor.java +++ b/src/main/java/org/apache/commons/exec/DefaultExecutor.java @@ -49,7 +49,7 @@ import org.apache.commons.exec.launcher.CommandLauncherFactory; public class DefaultExecutor implements Executor { /** - * Constructs a new builder. + * Constructs a new {@link DefaultExecutor}. * * @param <T> The builder type. * @since 1.4.0 @@ -60,6 +60,13 @@ public class DefaultExecutor implements Executor { private ExecuteStreamHandler executeStreamHandler; private File workingDirectory; + /** + * Constructs a new instance. + */ + public Builder() { + // empty + } + /** * Returns this instance typed as the subclass type {@code T}. * <p> diff --git a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java index a037d32f..e8b8244d 100644 --- a/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java +++ b/src/main/java/org/apache/commons/exec/ExecuteWatchdog.java @@ -61,6 +61,13 @@ public class ExecuteWatchdog implements TimeoutObserver { private ThreadFactory threadFactory; private Duration timeout; + /** + * Constructs a new instance. + */ + public Builder() { + // empty + } + /** * Creates a new configured ExecuteWatchdog. * diff --git a/src/main/java/org/apache/commons/exec/Watchdog.java b/src/main/java/org/apache/commons/exec/Watchdog.java index 3be77fb5..e2cbca1e 100644 --- a/src/main/java/org/apache/commons/exec/Watchdog.java +++ b/src/main/java/org/apache/commons/exec/Watchdog.java @@ -39,6 +39,13 @@ public class Watchdog implements Runnable { private ThreadFactory threadFactory; private Duration timeout; + /** + * Constructs a new instance. + */ + public Builder() { + // empty + } + /** * Creates a new configured ExecuteWatchdog. * 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 fe2e2e15..e20a5330 100644 --- a/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java +++ b/src/main/java/org/apache/commons/exec/environment/DefaultProcessingEnvironment.java @@ -35,6 +35,13 @@ public class DefaultProcessingEnvironment { /** The environment variables of the process */ protected Map<String, String> procEnvironment; + /** + * Constructs a new instance. + */ + public DefaultProcessingEnvironment() { + // empty + } + /** * Creates a map that obeys the casing rules of the current platform for key lookup. E.g. on a Windows platform, the map keys will be case-insensitive. * 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 72e04bda..fad84377 100644 --- a/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java +++ b/src/main/java/org/apache/commons/exec/environment/OpenVmsProcessingEnvironment.java @@ -32,6 +32,13 @@ package org.apache.commons.exec.environment; @Deprecated public class OpenVmsProcessingEnvironment extends DefaultProcessingEnvironment { + /** + * Constructs a new instance. + */ + public OpenVmsProcessingEnvironment() { + // empty + } + /* * Hopefully removing super-class overrides won't cause Clirr error. If necessary can just delegate to super-class. */ 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 d3dfd9e5..a2ca1b3e 100644 --- a/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java +++ b/src/main/java/org/apache/commons/exec/launcher/CommandLauncherImpl.java @@ -30,6 +30,13 @@ import org.apache.commons.exec.environment.EnvironmentUtils; */ public abstract class CommandLauncherImpl implements CommandLauncher { + /** + * Constructs a new instance. + */ + public CommandLauncherImpl() { + // empty + } + @Override public Process exec(final CommandLine cmd, final Map<String, String> env) throws IOException { return Runtime.getRuntime().exec(cmd.toStrings(), EnvironmentUtils.toStrings(env)); diff --git a/src/main/java/org/apache/commons/exec/launcher/VmsCommandLauncher.java b/src/main/java/org/apache/commons/exec/launcher/VmsCommandLauncher.java index 7aa5322e..1eb86862 100644 --- a/src/main/java/org/apache/commons/exec/launcher/VmsCommandLauncher.java +++ b/src/main/java/org/apache/commons/exec/launcher/VmsCommandLauncher.java @@ -36,6 +36,13 @@ import org.apache.commons.exec.util.StringUtils; */ public class VmsCommandLauncher extends Java13CommandLauncher { + /** + * Constructs a new instance. + */ + public VmsCommandLauncher() { + // empty + } + /** * Writes the command into a temporary DCL script and returns the corresponding File object. The script will be deleted on exit. */