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-lang.git
commit 4bc3fb504e166aadd14db0dffd25eb631e78e79d
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jul 31 08:51:04 2024 -0400
Fix Javadoc warnings
---
src/changes/changes.xml | 1 +
.../java/org/apache/commons/lang3/ArraySorter.java | 20 ++++++++++----------
.../java/org/apache/commons/lang3/Functions.java | 7 +++++++
.../org/apache/commons/lang3/RuntimeEnvironment.java | 9 +++++++++
src/main/java/org/apache/commons/lang3/Streams.java | 7 +++++++
.../commons/lang3/builder/AbstractSupplier.java | 7 +++++++
.../apache/commons/lang3/builder/DiffBuilder.java | 7 +++++++
.../commons/lang3/builder/ReflectionDiffBuilder.java | 7 +++++++
.../concurrent/AbstractConcurrentInitializer.java | 7 +++++++
.../commons/lang3/concurrent/AtomicInitializer.java | 7 +++++++
.../lang3/concurrent/AtomicSafeInitializer.java | 7 +++++++
.../lang3/concurrent/BackgroundInitializer.java | 7 +++++++
.../commons/lang3/concurrent/BasicThreadFactory.java | 10 ++++++++--
.../commons/lang3/concurrent/LazyInitializer.java | 7 +++++++
.../lang3/exception/DefaultExceptionContext.java | 7 +++++++
.../org/apache/commons/lang3/stream/Streams.java | 10 +++++-----
.../lang3/text/translate/CharSequenceTranslator.java | 7 +++++++
.../lang3/text/translate/CodePointTranslator.java | 7 +++++++
.../commons/lang3/text/translate/OctalUnescaper.java | 7 +++++++
.../lang3/text/translate/UnicodeUnescaper.java | 7 +++++++
.../translate/UnicodeUnpairedSurrogateRemover.java | 7 +++++++
.../java/org/apache/commons/lang3/tuple/Pair.java | 7 +++++++
.../java/org/apache/commons/lang3/tuple/Triple.java | 7 +++++++
23 files changed, 159 insertions(+), 17 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index f246b12a8..304968215 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -58,6 +58,7 @@ The <action> type attribute can be add,update,fix,remove.
<action type="fix" dev="ggregory" due-to="Gary
Gregory">Deprecate Conversion constructor for removal.</action>
<action type="fix" dev="ggregory" due-to="Gary
Gregory">Deprecate EntityArrays constructor for removal.</action>
<action type="fix" dev="ggregory" due-to="Gary
Gregory">Deprecate ObjectToStringComparator constructor for removal.</action>
+ <action type="fix" dev="ggregory" due-to="Gary
Gregory">Deprecate RuntimeEnvironment constructor for removal.</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add StopWatch.getSplitDuration() and deprecate getSplitTime().</action>
<action type="add" dev="ggregory" due-to="Gary
Gregory">Add StopWatch.getStartInstant() and deprecate getStartTime().</action>
diff --git a/src/main/java/org/apache/commons/lang3/ArraySorter.java
b/src/main/java/org/apache/commons/lang3/ArraySorter.java
index be5f270ac..4449fed32 100644
--- a/src/main/java/org/apache/commons/lang3/ArraySorter.java
+++ b/src/main/java/org/apache/commons/lang3/ArraySorter.java
@@ -27,16 +27,6 @@ import java.util.Comparator;
*/
public class ArraySorter {
- /**
- * Constructs a new instance.
- *
- * @deprecated Will be removed in 4.0.0.
- */
- @Deprecated
- public ArraySorter() {
- // empty
- }
-
/**
* Sorts and returns the given array.
*
@@ -167,4 +157,14 @@ public class ArraySorter {
return array;
}
+ /**
+ * Constructs a new instance.
+ *
+ * @deprecated Will be removed in 4.0.0.
+ */
+ @Deprecated
+ public ArraySorter() {
+ // empty
+ }
+
}
diff --git a/src/main/java/org/apache/commons/lang3/Functions.java
b/src/main/java/org/apache/commons/lang3/Functions.java
index 7e0de8ba4..f4f721989 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -655,4 +655,11 @@ public class Functions {
final FailableRunnable<? extends Throwable>... resources) {
tryWithResources(action, null, resources);
}
+
+ /**
+ * Constructs a new instance.
+ */
+ public Functions() {
+ // empty
+ }
}
diff --git a/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java
b/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java
index 4c9fd8a07..66b93d86c 100644
--- a/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java
+++ b/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java
@@ -92,4 +92,13 @@ public class RuntimeEnvironment {
return containsLine("/proc/1/environ",
"container=wslcontainer_host_id");
}
+ /**
+ * Constructs a new instance.
+ *
+ * @deprecated Will be removed in 4.0.0.
+ */
+ @Deprecated
+ public RuntimeEnvironment() {
+ // empty
+ }
}
diff --git a/src/main/java/org/apache/commons/lang3/Streams.java
b/src/main/java/org/apache/commons/lang3/Streams.java
index bf3c86a1c..fdb1798cc 100644
--- a/src/main/java/org/apache/commons/lang3/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/Streams.java
@@ -548,4 +548,11 @@ public class Streams {
public static <O> Collector<O, ?, O[]> toArray(final Class<O>
pElementType) {
return new ArrayCollector<>(pElementType);
}
+
+ /**
+ * Constructs a new instance.
+ */
+ public Streams() {
+ // empty
+ }
}
diff --git
a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
index 29b94b7aa..cf21560c0 100644
--- a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
+++ b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java
@@ -29,6 +29,13 @@ import org.apache.commons.lang3.function.FailableSupplier;
*/
public abstract class AbstractSupplier<T, B extends AbstractSupplier<T, B, E>,
E extends Throwable> implements FailableSupplier<T, E> {
+ /**
+ * Constructs a new instance.
+ */
+ public AbstractSupplier() {
+ // empty
+ }
+
/**
* Returns this instance typed as the proper subclass type.
*
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
index d14d1b9d0..2424e6307 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -87,6 +87,13 @@ public class DiffBuilder<T> implements
Builder<DiffResult<T>> {
private boolean testObjectsEquals = true;
private String toStringFormat = TO_STRING_FORMAT;
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new configured {@link DiffBuilder}.
*
diff --git
a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
index 65f72adbb..cef3b2892 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
@@ -86,6 +86,13 @@ public class ReflectionDiffBuilder<T> implements
Builder<DiffResult<T>> {
private String[] excludeFieldNames = ArrayUtils.EMPTY_STRING_ARRAY;
private DiffBuilder<T> diffBuilder;
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Builds a new configured {@link ReflectionDiffBuilder}.
*
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
index 7769b38af..89004f306 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
@@ -54,6 +54,13 @@ public abstract class AbstractConcurrentInitializer<T, E
extends Exception> impl
*/
private FailableSupplier<T, ? extends Exception> initializer =
FailableSupplier.nul();
+ /**
+ * Constructs a new instance.
+ */
+ public AbstractBuilder() {
+ // empty
+ }
+
/**
* Gets the closer consumer called by {@link #close()}.
*
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
index fb06a52b9..b06fa8aff 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
@@ -76,6 +76,13 @@ public class AtomicInitializer<T> extends
AbstractConcurrentInitializer<T, Concu
*/
public static class Builder<I extends AtomicInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
@SuppressWarnings("unchecked")
@Override
public I get() {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
index 165d5d0da..b803432c1 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializer.java
@@ -65,6 +65,13 @@ public class AtomicSafeInitializer<T> extends
AbstractConcurrentInitializer<T, C
*/
public static class Builder<I extends AtomicSafeInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
@SuppressWarnings("unchecked")
@Override
public I get() {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
index 4c7a828ed..613c85fb1 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -101,6 +101,13 @@ public class BackgroundInitializer<T> extends
AbstractConcurrentInitializer<T, E
*/
private ExecutorService externalExecutor;
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
@SuppressWarnings("unchecked")
@Override
public I get() {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
b/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
index 8ea22f01b..1ba5d4f9a 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
@@ -100,8 +100,7 @@ public class BasicThreadFactory implements ThreadFactory {
* BasicThreadFactory} for a usage example.
* </p>
*/
- public static class Builder
- implements
org.apache.commons.lang3.builder.Builder<BasicThreadFactory> {
+ public static class Builder implements
org.apache.commons.lang3.builder.Builder<BasicThreadFactory> {
/** The wrapped factory. */
private ThreadFactory factory;
@@ -118,6 +117,13 @@ public class BasicThreadFactory implements ThreadFactory {
/** The daemon flag. */
private Boolean daemon;
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
/**
* Creates a new {@link BasicThreadFactory} with all configuration
* options that have been specified by calling methods on this builder.
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
index 1ea4b0f52..271a97afb 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
@@ -80,6 +80,13 @@ public class LazyInitializer<T> extends
AbstractConcurrentInitializer<T, Concurr
*/
public static class Builder<I extends LazyInitializer<T>, T> extends
AbstractBuilder<I, T, Builder<I, T>, ConcurrentException> {
+ /**
+ * Constructs a new instance.
+ */
+ public Builder() {
+ // empty
+ }
+
@SuppressWarnings("unchecked")
@Override
public I get() {
diff --git
a/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
b/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
index ee58156d6..c98d3d4b2 100644
---
a/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
+++
b/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
@@ -47,6 +47,13 @@ public class DefaultExceptionContext implements
ExceptionContext, Serializable {
/** The list storing the label-data pairs. */
private final List<Pair<String, Object>> contextValues = new ArrayList<>();
+ /**
+ * Constructs a new instance.
+ */
+ public DefaultExceptionContext() {
+ // empty
+ }
+
/**
* {@inheritDoc}
*/
diff --git a/src/main/java/org/apache/commons/lang3/stream/Streams.java
b/src/main/java/org/apache/commons/lang3/stream/Streams.java
index 831d7b648..857043dcb 100644
--- a/src/main/java/org/apache/commons/lang3/stream/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/stream/Streams.java
@@ -834,18 +834,18 @@ public class Streams {
/**
* Returns a {@link Collector} that accumulates the input elements into a
new array.
*
- * @param pElementType Type of an element in the array.
+ * @param elementType Type of an element in the array.
* @param <T> the type of the input elements
* @return a {@link Collector} which collects all the input elements into
an array, in encounter order
*/
- public static <T> Collector<T, ?, T[]> toArray(final Class<T>
pElementType) {
- return new ArrayCollector<>(pElementType);
+ public static <T> Collector<T, ?, T[]> toArray(final Class<T> elementType)
{
+ return new ArrayCollector<>(elementType);
}
/**
- * Make private in 4.0.
+ * Constructs a new instance.
*
- * @deprecated TODO Make private in 4.0.
+ * @deprecated Will be private in 4.0.0.
*/
@Deprecated
public Streams() {
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
index 8dbff38b5..813615e8a 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java
@@ -51,6 +51,13 @@ public abstract class CharSequenceTranslator {
return Integer.toHexString(codePoint).toUpperCase(Locale.ENGLISH);
}
+ /**
+ * Constructs a new instance.
+ */
+ public CharSequenceTranslator() {
+ // empty
+ }
+
/**
* Helper for non-Writer usage.
* @param input CharSequence to be translated
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
index ca8c743c2..84a15ff08 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java
@@ -31,6 +31,13 @@ import java.io.Writer;
@Deprecated
public abstract class CodePointTranslator extends CharSequenceTranslator {
+ /**
+ * Constructs a new instance.
+ */
+ public CodePointTranslator() {
+ // empty
+ }
+
/**
* Implements translate to map onto the abstract translate(int, Writer)
method.
* {@inheritDoc}
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java
b/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java
index 8ffee1ff0..2b4e848ce 100644
--- a/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java
+++ b/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java
@@ -35,6 +35,13 @@ import java.io.Writer;
@Deprecated
public class OctalUnescaper extends CharSequenceTranslator {
+ /**
+ * Constructs a new instance.
+ */
+ public OctalUnescaper() {
+ // empty
+ }
+
/**
* Checks if the given char is an octal digit. Octal digits are the
character representations of the digits 0 to 7.
* @param ch the char to check
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java
b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java
index cb19617e7..38a284ee0 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java
@@ -32,6 +32,13 @@ import java.io.Writer;
@Deprecated
public class UnicodeUnescaper extends CharSequenceTranslator {
+ /**
+ * Constructs a new instance.
+ */
+ public UnicodeUnescaper() {
+ // empty
+ }
+
/**
* {@inheritDoc}
*/
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java
b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java
index 132e075d1..eb291d145 100644
---
a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java
+++
b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java
@@ -29,6 +29,13 @@ import java.io.Writer;
@Deprecated
public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator {
+ /**
+ * Constructs a new instance.
+ */
+ public UnicodeUnpairedSurrogateRemover() {
+ // empty
+ }
+
/**
* Implements translate that throws out unpaired surrogates.
* {@inheritDoc}
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
index 17552f98c..36122803a 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Pair.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Pair.java
@@ -119,6 +119,13 @@ public abstract class Pair<L, R> implements Map.Entry<L,
R>, Comparable<Pair<L,
return ImmutablePair.ofNonNull(left, right);
}
+ /**
+ * Constructs a new instance.
+ */
+ public Pair() {
+ // empty
+ }
+
/**
* Accepts this key and value as arguments to the given consumer.
*
diff --git a/src/main/java/org/apache/commons/lang3/tuple/Triple.java
b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
index a7433ea60..978f8229d 100644
--- a/src/main/java/org/apache/commons/lang3/tuple/Triple.java
+++ b/src/main/java/org/apache/commons/lang3/tuple/Triple.java
@@ -105,6 +105,13 @@ public abstract class Triple<L, M, R> implements
Comparable<Triple<L, M, R>>, Se
return ImmutableTriple.ofNonNull(left, middle, right);
}
+ /**
+ * Constructs a new instance.
+ */
+ public Triple() {
+ // empty
+ }
+
/**
* Compares the triple based on the left element, followed by the middle
element,
* finally the right element.
