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
The following commit(s) were added to refs/heads/master by this push:
new 90762e08c Javadoc: Empty Javadoc line before the 1st tag.
90762e08c is described below
commit 90762e08cfb35f236adbe4cda28af19e54872890
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 17:29:30 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
.../org/apache/commons/lang3/AnnotationUtils.java | 1 +
.../java/org/apache/commons/lang3/ArraySorter.java | 1 +
.../java/org/apache/commons/lang3/ArrayUtils.java | 1 +
.../org/apache/commons/lang3/BooleanUtils.java | 3 ++
.../java/org/apache/commons/lang3/CharRange.java | 2 +
.../java/org/apache/commons/lang3/CharSet.java | 7 ++++
.../org/apache/commons/lang3/CharSetUtils.java | 1 +
.../java/org/apache/commons/lang3/CharUtils.java | 1 +
.../java/org/apache/commons/lang3/Functions.java | 1 +
.../commons/lang3/SerializationException.java | 1 +
.../apache/commons/lang3/SerializationUtils.java | 3 ++
.../java/org/apache/commons/lang3/Streams.java | 44 +++++++++++++++-------
.../apache/commons/lang3/StringEscapeUtils.java | 1 +
.../java/org/apache/commons/lang3/StringUtils.java | 3 ++
.../java/org/apache/commons/lang3/ThreadUtils.java | 2 +
.../java/org/apache/commons/lang3/Validate.java | 1 +
.../apache/commons/lang3/arch/package-info.java | 1 +
.../apache/commons/lang3/builder/DiffResult.java | 1 +
.../commons/lang3/builder/EqualsBuilder.java | 1 +
.../builder/MultilineRecursiveToStringStyle.java | 1 +
.../lang3/builder/StandardToStringStyle.java | 1 +
.../commons/lang3/concurrent/ConcurrentUtils.java | 1 +
.../lang3/concurrent/EventCountCircuitBreaker.java | 1 +
.../lang3/concurrent/ThresholdCircuitBreaker.java | 1 +
.../commons/lang3/event/EventListenerSupport.java | 1 +
.../commons/lang3/exception/ExceptionUtils.java | 1 +
.../apache/commons/lang3/reflect/FieldUtils.java | 3 ++
.../apache/commons/lang3/text/CompositeFormat.java | 1 +
.../commons/lang3/text/ExtendedMessageFormat.java | 1 +
.../org/apache/commons/lang3/text/StrBuilder.java | 12 +++++-
.../org/apache/commons/lang3/text/StrLookup.java | 1 +
.../apache/commons/lang3/text/StrSubstitutor.java | 1 +
.../apache/commons/lang3/text/StrTokenizer.java | 2 +
.../org/apache/commons/lang3/text/WordUtils.java | 1 +
.../commons/lang3/text/translate/EntityArrays.java | 4 +-
.../lang3/text/translate/OctalUnescaper.java | 1 +
.../apache/commons/lang3/time/CalendarUtils.java | 3 ++
.../org/apache/commons/lang3/time/DateParser.java | 1 +
.../apache/commons/lang3/time/FastDatePrinter.java | 4 ++
.../apache/commons/lang3/time/FastTimeZone.java | 1 +
.../apache/commons/lang3/util/FluentBitSet.java | 1 +
41 files changed, 105 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
index f2417bde0..022f94064 100644
--- a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
@@ -349,6 +349,7 @@ public static String toString(final Annotation a) {
*
* <p>This constructor is public to permit tools that require a JavaBean
* instance to operate.</p>
+ *
* @deprecated TODO Make private in 4.0.
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/lang3/ArraySorter.java
b/src/main/java/org/apache/commons/lang3/ArraySorter.java
index 78a2101b2..17ecc0610 100644
--- a/src/main/java/org/apache/commons/lang3/ArraySorter.java
+++ b/src/main/java/org/apache/commons/lang3/ArraySorter.java
@@ -23,6 +23,7 @@
* Sorts and returns arrays in the fluent style.
*
* TODO For 4.0, rename to ArraySort, since we cover the sort() method here,
see also ArrayFill.
+ *
* @since 3.12.0
*/
public class ArraySorter {
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index abcb0373d..cbd3fe2f6 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -55,6 +55,7 @@
* <p>
* #ThreadSafe#
* </p>
+ *
* @since 2.0
*/
public class ArrayUtils {
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index cfbb36d13..84da341ad 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -31,6 +31,7 @@
* Each method documents its behavior in more detail.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @since 2.0
*/
public class BooleanUtils {
@@ -274,6 +275,7 @@ public static Boolean negate(final Boolean bool) {
* <p>
* See also <a href="https://en.wikipedia.org/wiki/One-hot";>One-hot</a>.
* </p>
+ *
* @param array an array of {@code boolean}s
* @return the result of the one-hot operations
* @throws NullPointerException if {@code array} is {@code null}
@@ -372,6 +374,7 @@ public static Boolean or(final Boolean... array) {
/**
* Returns a new array of possible values (like an enum would).
+ *
* @return a new array of possible values (like an enum would).
* @since 3.12.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/CharRange.java
b/src/main/java/org/apache/commons/lang3/CharRange.java
index d7a793db5..9b5822571 100644
--- a/src/main/java/org/apache/commons/lang3/CharRange.java
+++ b/src/main/java/org/apache/commons/lang3/CharRange.java
@@ -27,6 +27,7 @@
* <p>Instances are immutable.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @since 1.0
* @since 3.20.1 {@code serialVersionUID} changed from {@code
8270183163158333422L} to {@code 2L}.
*/
@@ -335,6 +336,7 @@ public boolean isNegated() {
* Returns an iterator which can be used to walk through the characters
described by this range.
*
* <p>#NotThreadSafe# the iterator is not thread-safe</p>
+ *
* @return an iterator to the chars represented by this range
* @since 2.5
*/
diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java
b/src/main/java/org/apache/commons/lang3/CharSet.java
index 5853f8452..4ee56bc48 100644
--- a/src/main/java/org/apache/commons/lang3/CharSet.java
+++ b/src/main/java/org/apache/commons/lang3/CharSet.java
@@ -30,6 +30,7 @@
* <p>Instances are immutable, but instances of subclasses may not be.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @since 1.0
*/
public class CharSet implements Serializable {
@@ -43,30 +44,35 @@ public class CharSet implements Serializable {
/**
* A CharSet defining no characters.
+ *
* @since 2.0
*/
public static final CharSet EMPTY = new CharSet((String) null);
/**
* A CharSet defining ASCII alphabetic characters "a-zA-Z".
+ *
* @since 2.0
*/
public static final CharSet ASCII_ALPHA = new CharSet("a-zA-Z");
/**
* A CharSet defining ASCII alphabetic characters "a-z".
+ *
* @since 2.0
*/
public static final CharSet ASCII_ALPHA_LOWER = new CharSet("a-z");
/**
* A CharSet defining ASCII alphabetic characters "A-Z".
+ *
* @since 2.0
*/
public static final CharSet ASCII_ALPHA_UPPER = new CharSet("A-Z");
/**
* A CharSet defining ASCII alphabetic characters "0-9".
+ *
* @since 2.0
*/
public static final CharSet ASCII_NUMERIC = new CharSet("0-9");
@@ -74,6 +80,7 @@ public class CharSet implements Serializable {
/**
* A Map of the common cases used in the factory.
* Subclasses can add more common patterns if desired
+ *
* @since 2.0
*/
protected static final Map<String, CharSet> COMMON =
Collections.synchronizedMap(new HashMap<>());
diff --git a/src/main/java/org/apache/commons/lang3/CharSetUtils.java
b/src/main/java/org/apache/commons/lang3/CharSetUtils.java
index 4b2ed54ef..d8dd4aa21 100644
--- a/src/main/java/org/apache/commons/lang3/CharSetUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharSetUtils.java
@@ -26,6 +26,7 @@
* Each method documents its behavior in more detail.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @see CharSet
* @since 1.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/CharUtils.java
b/src/main/java/org/apache/commons/lang3/CharUtils.java
index 0b189c152..b9dfadaa6 100644
--- a/src/main/java/org/apache/commons/lang3/CharUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharUtils.java
@@ -26,6 +26,7 @@
* Each method documents its behavior in more detail.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @since 2.1
*/
public class CharUtils {
diff --git a/src/main/java/org/apache/commons/lang3/Functions.java
b/src/main/java/org/apache/commons/lang3/Functions.java
index e59c8434c..70f0aaf39 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -68,6 +68,7 @@
* Obviously, the second version is much more concise and the spirit of Lambda
expressions is met better than the second
* version.
* </p>
+ *
* @since 3.9
* @deprecated Use {@link org.apache.commons.lang3.function.Failable}.
*/
diff --git a/src/main/java/org/apache/commons/lang3/SerializationException.java
b/src/main/java/org/apache/commons/lang3/SerializationException.java
index f63536aa7..05c4e1fa8 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationException.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationException.java
@@ -22,6 +22,7 @@
* <p>The original error is wrapped within this one.</p>
*
* <p>#NotThreadSafe# because Throwable is not thread-safe</p>
+ *
* @since 1.0
*/
public class SerializationException extends RuntimeException {
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index 7c333a8ab..124fcb0fc 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -71,6 +71,7 @@ static final class ClassLoaderAwareObjectInputStream extends
ObjectInputStream {
/**
* Constructs a new instance.
+ *
* @param in The {@link InputStream}.
* @param classLoader classloader to use
* @throws IOException if an I/O error occurs while reading stream
header.
@@ -84,6 +85,7 @@ static final class ClassLoaderAwareObjectInputStream extends
ObjectInputStream {
/**
* Overridden version that uses the parameterized {@link ClassLoader}
or the {@link ClassLoader}
* of the current {@link Thread} to resolve the class.
+ *
* @param desc An instance of class {@link ObjectStreamClass}.
* @return A {@link Class} object corresponding to {@code desc}.
* @throws IOException Any of the usual Input/Output exceptions.
@@ -269,6 +271,7 @@ public static void serialize(final Serializable obj, final
OutputStream outputSt
*
* <p>This constructor is public to permit tools that require a JavaBean
instance
* to operate.</p>
+ *
* @since 2.0
* @deprecated TODO Make private in 4.0.
*/
diff --git a/src/main/java/org/apache/commons/lang3/Streams.java
b/src/main/java/org/apache/commons/lang3/Streams.java
index a9b7f73c9..c58797639 100644
--- a/src/main/java/org/apache/commons/lang3/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/Streams.java
@@ -40,7 +40,8 @@
* {@code java.util.stream} package, or more generally, with Java 8 lambdas.
More
* specifically, it attempts to address the fact that lambdas are supposed
* not to throw Exceptions, at least not checked Exceptions, AKA instances
- * of {@link Exception}. This enforces the use of constructs like
+ * of {@link Exception}. This enforces the use of constructs like:
+ *
* <pre>{@code
* Consumer<java.lang.reflect.Method> consumer = m -> {
* try {
@@ -51,12 +52,16 @@
* };
* stream.forEach(consumer);
* }</pre>
+ * <p>
* Using a {@link FailableStream}, this can be rewritten as follows:
+ * </p>
* <pre>{@code
* Streams.failable(stream).forEach(m -> m.invoke(o, args));
* }</pre>
+ * <p>
* Obviously, the second version is much more concise and the spirit of
* Lambda expressions is met better than in the first version.
+ * </p>
*
* @see Stream
* @see Functions
@@ -118,6 +123,7 @@ public Supplier<List<O>> supplier() {
/**
* A reduced, and simplified version of a {@link Stream} with
* failable method signatures.
+ *
* @param <O> The streams element type.
* @deprecated Use {@link
org.apache.commons.lang3.stream.Streams.FailableStream}.
*/
@@ -129,6 +135,7 @@ public static class FailableStream<O> {
/**
* Constructs a new instance with the given {@code stream}.
+ *
* @param stream The stream.
*/
public FailableStream(final Stream<O> stream) {
@@ -445,6 +452,7 @@ public O reduce(final O identity, final BinaryOperator<O>
accumulator) {
/**
* Converts the FailableStream into an equivalent stream.
+ *
* @return A stream, which will return the same elements, which this
FailableStream would return.
*/
public Stream<O> stream() {
@@ -473,18 +481,23 @@ public Stream<O> stream() {
* final List<String> strList = list.stream()
* .map(mapper).collect(Collectors.toList());
* }</pre>
- * as follows:
+ * <p>
+ * as follows:
+ * </p>
* <pre>{@code
* final List<O> list;
* final Method m;
* final List<String> strList = Functions.stream(list.stream())
* .map((o) -> (String) m.invoke(o)).collect(Collectors.toList());
* }</pre>
- * While the second version may not be <em>quite</em> as
- * efficient (because it depends on the creation of additional,
- * intermediate objects, of type FailableStream), it is much more
- * concise, and readable, and meets the spirit of Lambdas better
- * than the first version.
+ * <p>
+ * While the second version may not be <em>quite</em> as
+ * efficient (because it depends on the creation of additional,
+ * intermediate objects, of type FailableStream), it is much more
+ * concise, and readable, and meets the spirit of Lambdas better
+ * than the first version.
+ * </p>
+ *
* @param <O> The streams element type.
* @param stream The stream, which is being converted.
* @return The {@link FailableStream}, which has been created by
@@ -515,18 +528,23 @@ public static <O> FailableStream<O> stream(final
Collection<O> stream) {
* final List<String> strList = list.stream()
* .map(mapper).collect(Collectors.toList());
* }</pre>
- * as follows:
+ * <p>
+ * as follows:
+ * </p>
* <pre>{@code
* final List<O> list;
* final Method m;
* final List<String> strList = Functions.stream(list.stream())
* .map((o) -> (String) m.invoke(o)).collect(Collectors.toList());
* }</pre>
- * While the second version may not be <em>quite</em> as
- * efficient (because it depends on the creation of additional,
- * intermediate objects, of type FailableStream), it is much more
- * concise, and readable, and meets the spirit of Lambdas better
- * than the first version.
+ * <p>
+ * While the second version may not be <em>quite</em> as
+ * efficient (because it depends on the creation of additional,
+ * intermediate objects, of type FailableStream), it is much more
+ * concise, and readable, and meets the spirit of Lambdas better
+ * than the first version.
+ * </p>
+ *
* @param <O> The streams element type.
* @param stream The stream, which is being converted.
* @return The {@link FailableStream}, which has been created by
diff --git a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
index 605d9a0b5..4e0f46f77 100644
--- a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
@@ -35,6 +35,7 @@
* Java, Java Script, HTML and XML.
*
* <p>#ThreadSafe#</p>
+ *
* @since 2.0
* @deprecated As of 3.6, use Apache Commons Text
* <a
href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringEscapeUtils.html";>
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java
b/src/main/java/org/apache/commons/lang3/StringUtils.java
index 8fa447204..58f557621 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -118,6 +118,7 @@
* The symbol {@code *} is used to indicate any input including {@code
null}.</p>
*
* <p>#ThreadSafe#</p>
+ *
* @see String
* @since 1.0
*/
@@ -154,6 +155,7 @@ public class StringUtils {
/**
* The empty String {@code ""}.
+ *
* @since 2.0
*/
public static final String EMPTY = "";
@@ -183,6 +185,7 @@ public class StringUtils {
/**
* Represents a failed index search.
+ *
* @since 2.1
*/
public static final int INDEX_NOT_FOUND = -1;
diff --git a/src/main/java/org/apache/commons/lang3/ThreadUtils.java
b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
index f425b251a..83b7fa83b 100644
--- a/src/main/java/org/apache/commons/lang3/ThreadUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
@@ -110,6 +110,7 @@ public interface ThreadGroupPredicate {
/**
* Evaluates this predicate on the given thread group.
+ *
* @param threadGroup the thread group
* @return {@code true} if the threadGroup matches the predicate,
otherwise {@code false}
*/
@@ -157,6 +158,7 @@ public interface ThreadPredicate {
/**
* Evaluates this predicate on the given thread.
+ *
* @param thread the thread
* @return {@code true} if the thread matches the predicate, otherwise
{@code false}
*/
diff --git a/src/main/java/org/apache/commons/lang3/Validate.java
b/src/main/java/org/apache/commons/lang3/Validate.java
index ddd651a2d..7239384b9 100644
--- a/src/main/java/org/apache/commons/lang3/Validate.java
+++ b/src/main/java/org/apache/commons/lang3/Validate.java
@@ -42,6 +42,7 @@
* </pre>
*
* <p>#ThreadSafe#</p>
+ *
* @see String#format(String, Object...)
* @since 2.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/arch/package-info.java
b/src/main/java/org/apache/commons/lang3/arch/package-info.java
index 149e8b37b..6c155d249 100644
--- a/src/main/java/org/apache/commons/lang3/arch/package-info.java
+++ b/src/main/java/org/apache/commons/lang3/arch/package-info.java
@@ -17,6 +17,7 @@
/**
* Provides classes to work with the values of the os.arch system property.
+ *
* @since 3.6
*/
package org.apache.commons.lang3.arch;
diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
index 5525d7b6a..eb4f18564 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
@@ -32,6 +32,7 @@
* <p>
* Use a {@link DiffBuilder} to build a {@link DiffResult} comparing two
objects.
* </p>
+ *
* @param <T> type of the left and right object.
* @since 3.3
*/
diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
index 22dc1fe1e..d4bbdf558 100644
--- a/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/EqualsBuilder.java
@@ -367,6 +367,7 @@ private static void unregister(final Object lhs, final
Object rhs) {
* Constructor for EqualsBuilder.
*
* <p>Starts off assuming that equals is {@code true}.</p>
+ *
* @see Object#equals(Object)
*/
public EqualsBuilder() {
diff --git
a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
index adc362284..aef8cc2a1 100644
---
a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
+++
b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java
@@ -66,6 +66,7 @@ public class MultilineRecursiveToStringStyle extends
RecursiveToStringStyle {
/**
* Required for serialization support.
+ *
* @see java.io.Serializable
*/
private static final long serialVersionUID = 1L;
diff --git
a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
index b1d3d8358..6ebdb9ba1 100644
--- a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
@@ -245,6 +245,7 @@ public boolean isUseFieldNames() {
/**
* Gets whether to use the identity hash code.
+ *
* @return the current useIdentityHashCode flag
*/
@Override
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
index 30d47960a..18cdf1e84 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -34,6 +34,7 @@ public class ConcurrentUtils {
/**
* A specialized {@link Future} implementation which wraps a constant
value.
+ *
* @param <T> the type of the value wrapped by this class
*/
static final class ConstantFuture<T> implements Future<T> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
index 27cee74bc..685110026 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
@@ -133,6 +133,7 @@
* guarantee that the circuit breaker is triggered at a specific point in
time; there may
* be some delay (less than a check interval).</li>
* </ul>
+ *
* @since 3.5
*/
public class EventCountCircuitBreaker extends AbstractCircuitBreaker<Integer> {
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
index 75385dcaf..81c44ba0e 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
@@ -47,6 +47,7 @@
* </pre>
*
* <p>#Thread safe#</p>
+ *
* @since 3.5
*/
public class ThresholdCircuitBreaker extends AbstractCircuitBreaker<Long> {
diff --git
a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
index 6d67bfc8c..eb7977236 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -290,6 +290,7 @@ int getListenerCount() {
* Gets an array containing the currently registered listeners.
* Modification to this array's elements will have no effect on the
* {@link EventListenerSupport} instance.
+ *
* @return L[]
*/
public L[] getListeners() {
diff --git
a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
index 1d9b527f1..405b57e90 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
@@ -170,6 +170,7 @@ private static <R, T extends Throwable> R eraseType(final
Throwable throwable) t
* This method handles recursive cause structures that might otherwise
cause infinite loops. The cause chain is
* processed until the end is reached, or until the next item in the chain
is already in the result set.
* </p>
+ *
* @param throwable The Throwable to traverse.
* @param consumer a non-interfering action to perform on the elements.
* @since 3.13.0
diff --git a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
index f108ff1c6..42b04777b 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
@@ -40,6 +40,7 @@
* The ability is provided to break the scoping restrictions coded by the
programmer. This can allow fields to be
* changed that shouldn't be. This facility should be used with care.
* </p>
+ *
* @since 2.5
*/
public class FieldUtils {
@@ -228,6 +229,7 @@ public static Field getField(final Class<?> cls, final
String fieldName, final b
/**
* Gets all fields of the given class and its parents (if any) that are
annotated with the given annotation.
+ *
* @param cls
* the {@link Class} to query.
* @param annotationCls
@@ -244,6 +246,7 @@ public static List<Field> getFieldsListWithAnnotation(final
Class<?> cls, final
/**
* Gets all fields of the given class and its parents (if any) that are
annotated with the given annotation.
+ *
* @param cls
* the {@link Class} to query.
* @param annotationCls
diff --git a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
index 60719536b..7e1f6d2a9 100644
--- a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
@@ -25,6 +25,7 @@
* Formats using one formatter and parses using a different formatter. An
* example of use for this would be a webapp where data is taken in one way and
* stored in a database another way.
+ *
* @deprecated As of <a
href="https://commons.apache.org/proper/commons-lang/changes-report.html#a3.6";>3.6</a>,
use Apache Commons Text
* <a
href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/CompositeFormat.html";>
* CompositeFormat</a>.
diff --git
a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
index 8d1f4063d..72b13c019 100644
--- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java
@@ -244,6 +244,7 @@ public final void applyPattern(final String pattern) {
/**
* Learn whether the specified Collection contains non-null elements.
+ *
* @param coll to check
* @return {@code true} if some Object was found, {@code false} otherwise.
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
index d3c2839b1..7f09968e9 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
@@ -1209,8 +1209,10 @@ public StrBuilder appendPadding(final int length, final
char padChar) {
* append(it.next());
* }
* </pre>
+ * <p>
* Note that for this simple example, you should use
* {@link #appendWithSeparators(Iterable, String)}.
+ * </p>
*
* @param separator the separator to use
* @return {@code this} instance.
@@ -1229,6 +1231,7 @@ public StrBuilder appendSeparator(final char separator) {
* Otherwise it will append the standard-separator
*
* The separator is appended using {@link #append(char)}.
+ *
* @param standard the separator if builder is not empty
* @param defaultIfEmpty the separator if builder is empty
* @return {@code this} instance.
@@ -1257,8 +1260,10 @@ public StrBuilder appendSeparator(final char standard,
final char defaultIfEmpty
* }
* }
* </pre>
+ * <p>
* Note that for this simple example, you should use
* {@link #appendWithSeparators(Iterable, String)}.
+ * </p>
*
* @param separator the separator to use
* @param loopIndex the loop index
@@ -1313,8 +1318,10 @@ public StrBuilder appendSeparator(final String
separator) {
* append(list.get(i));
* }
* }</pre>
+ * <p>
* Note that for this simple example, you should use
* {@link #appendWithSeparators(Iterable, String)}.
+ * </p>
*
* @param separator the separator to use, null means no separator
* @param loopIndex the loop index
@@ -1332,9 +1339,10 @@ public StrBuilder appendSeparator(final String
separator, final int loopIndex) {
* Appends one of both separators to the StrBuilder.
* If the builder is currently empty it will append the
defaultIfEmpty-separator
* Otherwise it will append the standard-separator
- *
+ * <p>
* Appending a null separator will have no effect.
* The separator is appended using {@link #append(String)}.
+ * </p>
* <p>
* This method is for example useful for constructing queries
* </p>
@@ -1557,6 +1565,7 @@ public Writer asWriter() {
/**
* Implement the {@link Builder} interface.
+ *
* @return the builder as a String
* @since 3.2
* @see #toString()
@@ -2882,6 +2891,7 @@ public boolean startsWith(final String str) {
/**
* {@inheritDoc}
+ *
* @since 3.0
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/text/StrLookup.java
b/src/main/java/org/apache/commons/lang3/text/StrLookup.java
index 5031af542..d29c13d17 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrLookup.java
@@ -177,6 +177,7 @@ protected StrLookup() {
* map.put("number", Integer.valueOf(2));
* assertEquals("2", StrLookup.mapLookup(map).lookup("number"));
* }</pre>
+ *
* @param key the key to be looked up, may be null.
* @return the matching value, null if no match.
*/
diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
index 104755c91..654462b45 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
@@ -162,6 +162,7 @@ public class StrSubstitutor {
public static final StrMatcher DEFAULT_SUFFIX =
StrMatcher.stringMatcher("}");
/**
* Constant for the default value delimiter of a variable.
+ *
* @since 3.2
*/
public static final StrMatcher DEFAULT_VALUE_DELIMITER =
StrMatcher.stringMatcher(":-");
diff --git a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
index 005bae42b..6e4f39dc3 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java
@@ -132,6 +132,7 @@ private static StrTokenizer getCSVClone() {
* <p>
* You must call a "reset" method to set the string which you want to
parse.
* </p>
+ *
* @return a new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StrTokenizer getCSVInstance() {
@@ -182,6 +183,7 @@ private static StrTokenizer getTSVClone() {
* <p>
* You must call a "reset" method to set the string which you want to
parse.
* </p>
+ *
* @return a new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StrTokenizer getTSVInstance() {
diff --git a/src/main/java/org/apache/commons/lang3/text/WordUtils.java
b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
index 60142767c..ea6c2ad54 100644
--- a/src/main/java/org/apache/commons/lang3/text/WordUtils.java
+++ b/src/main/java/org/apache/commons/lang3/text/WordUtils.java
@@ -618,6 +618,7 @@ public static String wrap(final String str, final int
wrapLength, final String n
* <td>"flammable\ninflammable"</td>
* </tr>
* </table>
+ *
* @param str the String to be word wrapped, may be null.
* @param wrapLength the column to wrap the words at, less than 1 is
treated as 1.
* @param newLineStr the string to insert for a new line,
diff --git
a/src/main/java/org/apache/commons/lang3/text/translate/EntityArrays.java
b/src/main/java/org/apache/commons/lang3/text/translate/EntityArrays.java
index 3d4912426..364283ff3 100644
--- a/src/main/java/org/apache/commons/lang3/text/translate/EntityArrays.java
+++ b/src/main/java/org/apache/commons/lang3/text/translate/EntityArrays.java
@@ -448,8 +448,10 @@ public static String[][] ISO8859_1_UNESCAPE() {
/**
* Mapping to escape the Java control characters.
- *
+ * <p>
* Namely: {@code \b \n \t \f \r}
+ * </p>
+ *
* @return the mapping table.
*/
public static String[][] JAVA_CTRL_CHARS_ESCAPE() {
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 e952c737a..8526deab5 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
@@ -46,6 +46,7 @@ public OctalUnescaper() {
/**
* Checks if the given char is the character representation of one of the
digit from 0 to 3.
+ *
* @param ch the char to check.
* @return true if the given char is the character representation of one
of the digits from 0 to 3.
*/
diff --git a/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java
b/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java
index 7215d26a6..761397de7 100644
--- a/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java
@@ -154,6 +154,7 @@ public int getMonth() {
/**
* Gets month names in the requested style.
+ *
* @param style Must be a valid {@link Calendar#getDisplayNames(int, int,
Locale)} month style.
* @return Styled names of months
*/
@@ -171,6 +172,7 @@ String[] getMonthDisplayNames(final int style) {
/**
* Gets full standalone month names as used in "LLLL" date formatting.
+ *
* @return Long names of months
*/
String[] getStandaloneLongMonthNames() {
@@ -179,6 +181,7 @@ String[] getStandaloneLongMonthNames() {
/**
* Gets short standalone month names as used in "LLLL" date formatting.
+ *
* @return Short names of months
*/
String[] getStandaloneShortMonthNames() {
diff --git a/src/main/java/org/apache/commons/lang3/time/DateParser.java
b/src/main/java/org/apache/commons/lang3/time/DateParser.java
index 1399c9324..e3ec6e05d 100644
--- a/src/main/java/org/apache/commons/lang3/time/DateParser.java
+++ b/src/main/java/org/apache/commons/lang3/time/DateParser.java
@@ -66,6 +66,7 @@ public interface DateParser {
* Equivalent to DateFormat.parse(String).
*
* See {@link java.text.DateFormat#parse(String)} for more information.
+ *
* @param source A {@link String} whose beginning should be parsed.
* @return A {@link Date} parsed from the string.
* @throws ParseException if the beginning of the specified string cannot
be parsed.
diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
index 9a24831c7..f4b855fe6 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java
@@ -1090,6 +1090,7 @@ protected StringBuffer applyRules(final Calendar
calendar, final StringBuffer bu
/**
* Creates a String representation of the given Calendar by applying the
rules of this printer to it.
+ *
* @param c the Calendar to apply the rules to.
* @return a String representation of the given Calendar.
*/
@@ -1209,6 +1210,7 @@ public StringBuffer format(final long millis, final
StringBuffer buf) {
/**
* Formats a {@link Date}, {@link Calendar} or
* {@link Long} (milliseconds) object.
+ *
* @param obj the object to format.
* @return The formatted value.
* @since 3.5
@@ -1229,6 +1231,7 @@ String format(final Object obj) {
/**
* Formats a {@link Date}, {@link Calendar} or
* {@link Long} (milliseconds) object.
+ *
* @deprecated Use {{@link #format(Date)}, {{@link #format(Calendar)},
{{@link #format(long)}.
* @param obj the object to format.
* @param toAppendTo the buffer to append to.
@@ -1314,6 +1317,7 @@ private void init() {
/**
* Creates a new Calendar instance.
+ *
* @return a new Calendar instance.
*/
private Calendar newCalendar() {
diff --git a/src/main/java/org/apache/commons/lang3/time/FastTimeZone.java
b/src/main/java/org/apache/commons/lang3/time/FastTimeZone.java
index 7c252fec8..63e85c3fb 100644
--- a/src/main/java/org/apache/commons/lang3/time/FastTimeZone.java
+++ b/src/main/java/org/apache/commons/lang3/time/FastTimeZone.java
@@ -33,6 +33,7 @@ public class FastTimeZone {
/**
* Gets the GMT TimeZone.
+ *
* @return A TimeZone with a raw offset of zero.
*/
public static TimeZone getGmtTimeZone() {
diff --git a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
index 204e0b763..314cf0a6e 100644
--- a/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
+++ b/src/main/java/org/apache/commons/lang3/util/FluentBitSet.java
@@ -26,6 +26,7 @@
* <p>
* Originally from Apache Commons VFS with more added to act as a fluent
replacement for {@link java.util.BitSet}.
* </p>
+ *
* @since 3.13.0
*/
public final class FluentBitSet implements Cloneable, Serializable {
