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 48d6e758f79255da5a1e307a2bbcfa60726ad8a0 Author: Gary Gregory <[email protected]> AuthorDate: Sun Jan 4 15:06:13 2026 -0500 Use a code comment, not Javadoc inside a method --- .../org/apache/commons/lang3/AnnotationUtils.java | 1 + .../org/apache/commons/lang3/BooleanUtils.java | 1 + .../org/apache/commons/lang3/CachedRandomBits.java | 2 ++ .../java/org/apache/commons/lang3/CharRange.java | 1 + .../java/org/apache/commons/lang3/ObjectUtils.java | 1 + .../commons/lang3/builder/HashCodeBuilder.java | 1 + .../commons/lang3/builder/ToStringBuilder.java | 2 ++ .../commons/lang3/builder/ToStringStyle.java | 27 ++++++++++++++++++++++ .../lang3/concurrent/AbstractCircuitBreaker.java | 2 ++ .../lang3/concurrent/BackgroundInitializer.java | 1 + .../concurrent/CallableBackgroundInitializer.java | 1 + .../lang3/concurrent/CircuitBreakingException.java | 1 + .../lang3/concurrent/ConcurrentException.java | 1 + .../concurrent/ConcurrentRuntimeException.java | 1 + .../commons/lang3/concurrent/ConcurrentUtils.java | 1 + .../lang3/concurrent/EventCountCircuitBreaker.java | 3 +++ .../concurrent/MultiBackgroundInitializer.java | 1 + .../lang3/concurrent/ThresholdCircuitBreaker.java | 1 + .../commons/lang3/event/EventListenerSupport.java | 1 + .../lang3/exception/ContextedException.java | 1 + .../lang3/exception/ContextedRuntimeException.java | 1 + .../apache/commons/lang3/function/Failable.java | 1 + .../org/apache/commons/lang3/math/NumberUtils.java | 18 +++++++++++++++ .../apache/commons/lang3/text/CompositeFormat.java | 1 + .../org/apache/commons/lang3/text/StrBuilder.java | 3 +++ .../org/apache/commons/lang3/text/StrLookup.java | 1 + .../org/apache/commons/lang3/text/StrMatcher.java | 11 +++++++++ .../apache/commons/lang3/text/StrSubstitutor.java | 9 ++++++++ .../apache/commons/lang3/text/StrTokenizer.java | 4 ++++ .../lang3/text/translate/NumericEntityEscaper.java | 2 ++ .../lang3/text/translate/UnicodeEscaper.java | 2 ++ .../apache/commons/lang3/time/CalendarUtils.java | 1 + .../org/apache/commons/lang3/time/DateUtils.java | 3 +++ .../apache/commons/lang3/time/FastDateFormat.java | 1 + .../apache/commons/lang3/time/FastDateParser.java | 6 +++++ .../apache/commons/lang3/time/FastDatePrinter.java | 6 +++++ .../commons/lang3/tuple/ImmutableTriple.java | 1 + .../apache/commons/lang3/tuple/MutableTriple.java | 1 + .../org/apache/commons/lang3/ArrayUtilsTest.java | 1 + .../commons/lang3/RandomStringUtilsTest.java | 1 + .../lang3/builder/JsonToStringStyleTest.java | 2 ++ .../lang3/builder/RecursiveToStringStyleTest.java | 2 ++ .../commons/lang3/builder/ToStringStyleTest.java | 1 + .../concurrent/AtomicInitializerSupplierTest.java | 1 + .../concurrent/BackgroundInitializerTest.java | 3 +++ .../lang3/concurrent/BasicThreadFactoryTest.java | 1 + .../CallableBackgroundInitializerTest.java | 2 ++ .../lang3/concurrent/ConcurrentUtilsTest.java | 1 + .../lang3/concurrent/ConstantInitializerTest.java | 1 + .../concurrent/EventCountCircuitBreakerTest.java | 3 +++ .../concurrent/MultiBackgroundInitializerTest.java | 2 ++ .../lang3/text/ExtendedMessageFormatTest.java | 4 ++++ 52 files changed, 148 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java index 022f94064..2a995e3fc 100644 --- a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java +++ b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java @@ -48,6 +48,7 @@ public class AnnotationUtils { * A style that prints annotations as recommended. */ private static final ToStringStyle TO_STRING_STYLE = new ToStringStyle() { + /** Serialization version */ private static final long serialVersionUID = 1L; diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java index 84da341ad..7cb0c3e92 100644 --- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java +++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java @@ -243,6 +243,7 @@ public static boolean isNotTrue(final Boolean bool) { public static boolean isTrue(final Boolean bool) { return Boolean.TRUE.equals(bool); } + /** * Negates the specified boolean. * diff --git a/src/main/java/org/apache/commons/lang3/CachedRandomBits.java b/src/main/java/org/apache/commons/lang3/CachedRandomBits.java index 8fb610664..62904c346 100644 --- a/src/main/java/org/apache/commons/lang3/CachedRandomBits.java +++ b/src/main/java/org/apache/commons/lang3/CachedRandomBits.java @@ -56,6 +56,7 @@ final class CachedRandomBits { private static final int BITS_PER_BYTE = 8; private final Random random; private final byte[] cache; + /** * Index of the next bit in the cache to be used. * @@ -66,6 +67,7 @@ final class CachedRandomBits { * </ul> */ private int bitIndex; + /** * Creates a new instance. * diff --git a/src/main/java/org/apache/commons/lang3/CharRange.java b/src/main/java/org/apache/commons/lang3/CharRange.java index da46451cc..a43ade931 100644 --- a/src/main/java/org/apache/commons/lang3/CharRange.java +++ b/src/main/java/org/apache/commons/lang3/CharRange.java @@ -40,6 +40,7 @@ final class CharRange implements Iterable<Character>, Serializable { * <p>#NotThreadSafe#</p> */ private static final class CharacterIterator implements Iterator<Character> { + /** The current character */ private char current; diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index b07f55fad..3b7ec158d 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -75,6 +75,7 @@ public class ObjectUtils { * </p> */ public static class Null implements Serializable { + /** * Required for serialization support. Declare serialization compatibility with Commons Lang 1.0 * diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java index 4bb6d45a2..8e0007da6 100644 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java @@ -103,6 +103,7 @@ * @since 1.0 */ public class HashCodeBuilder implements Builder<Integer> { + /** * The default initial value to use in reflection hash code building. */ diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java index 62bdd5c94..379fef134 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java @@ -199,10 +199,12 @@ public static void setDefaultStyle(final ToStringStyle style) { * Current toString buffer, not null. */ private final StringBuffer buffer; + /** * The object being output, may be null. */ private final Object object; + /** * The style of output to use, not null. */ diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java index 8c0ac8a65..2db828980 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java @@ -496,6 +496,7 @@ private Object readResolve() { * Serialization version ID. */ private static final long serialVersionUID = -2587890625525655916L; + /** * The default toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -504,6 +505,7 @@ private Object readResolve() { * </pre> */ public static final ToStringStyle DEFAULT_STYLE = new DefaultToStringStyle(); + /** * The multi line toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -516,6 +518,7 @@ private Object readResolve() { * </pre> */ public static final ToStringStyle MULTI_LINE_STYLE = new MultiLineToStringStyle(); + /** * The no field names toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -524,6 +527,7 @@ private Object readResolve() { * </pre> */ public static final ToStringStyle NO_FIELD_NAMES_STYLE = new NoFieldNameToStringStyle(); + /** * The short prefix toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -534,6 +538,7 @@ private Object readResolve() { * @since 2.1 */ public static final ToStringStyle SHORT_PREFIX_STYLE = new ShortPrefixToStringStyle(); + /** * The simple toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -542,6 +547,7 @@ private Object readResolve() { * </pre> */ public static final ToStringStyle SIMPLE_STYLE = new SimpleToStringStyle(); + /** * The no class name toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -552,6 +558,7 @@ private Object readResolve() { * @since 3.4 */ public static final ToStringStyle NO_CLASS_NAME_STYLE = new NoClassNameToStringStyle(); + /** * The JSON toString style. Using the {@code Person} example from {@link ToStringBuilder}, the output would look like this: * @@ -567,6 +574,7 @@ private Object readResolve() { * @see <a href="https://www.json.org/";>json.org</a> */ public static final ToStringStyle JSON_STYLE = new JsonToStringStyle(); + /** * A registry of objects used by {@code reflectionToString} methods to detect cyclical object references and avoid infinite loops. */ @@ -632,78 +640,97 @@ static void unregister(final Object value) { * Whether to use the field names, the default is {@code true}. */ private boolean useFieldNames = true; + /** * Whether to use the class name, the default is {@code true}. */ private boolean useClassName = true; + /** * Whether to use short class names, the default is {@code false}. */ private boolean useShortClassName; + /** * Whether to use the identity hash code, the default is {@code true}. */ private boolean useIdentityHashCode = true; + /** * The content start {@code '['}. */ private String contentStart = "["; + /** * The content end {@code ']'}. */ private String contentEnd = "]"; + /** * The field name value separator {@code '='}. */ private String fieldNameValueSeparator = "="; + /** * Whether the field separator should be added before any other fields. */ private boolean fieldSeparatorAtStart; + /** * Whether the field separator should be added after any other fields. */ private boolean fieldSeparatorAtEnd; + /** * The field separator {@code ','}. */ private String fieldSeparator = ","; + /** * The array start <code>'{'</code>. */ private String arrayStart = "{"; + /** * The array separator {@code ','}. */ private String arraySeparator = ","; + /** * The detail for array content. */ private boolean arrayContentDetail = true; + /** * The array end {@code '}'}. */ private String arrayEnd = "}"; + /** * The value to use when fullDetail is {@code null}, the default value is {@code true}. */ private boolean defaultFullDetail = true; + /** * The {@code null} text {@code "<null>"}. */ private String nullText = "<null>"; + /** * The summary size text start {@code "<size="}. */ private String sizeStartText = "<size="; + /** * The summary size text start {@code ">"}. */ private String sizeEndText = ">"; + /** * The summary object text start {@code "<"}. */ private String summaryObjectStartText = "<"; + /** * The summary object text start {@code ">"}. */ diff --git a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java index b6840340c..506c989ed 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java @@ -38,6 +38,7 @@ protected enum State { /** The closed state. */ CLOSED { + /** * {@inheritDoc} */ @@ -49,6 +50,7 @@ public State oppositeState() { /** The open state. */ OPEN { + /** * {@inheritDoc} */ 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 b8fb1f57c..2be935ad0 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java @@ -129,6 +129,7 @@ public Builder<I, T> setExternalExecutor(final ExecutorService externalExecutor) } private final class InitializationTask implements Callable<T> { + /** Stores the executor service to be destroyed at the end. */ private final ExecutorService execFinally; diff --git a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java index 20fa6b03a..7d7d07777 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java @@ -65,6 +65,7 @@ * @since 3.0 */ public class CallableBackgroundInitializer<T> extends BackgroundInitializer<T> { + /** The Callable to be executed. */ private final Callable<T> callable; diff --git a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java index 4fc49e0fc..da3a1e331 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreakingException.java @@ -23,6 +23,7 @@ * @since 3.5 */ public class CircuitBreakingException extends RuntimeException { + /** * The serial version UID. */ diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentException.java b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentException.java index 8b25a92fd..21442963f 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentException.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentException.java @@ -30,6 +30,7 @@ * @since 3.0 */ public class ConcurrentException extends Exception { + /** * The serial version UID. */ diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentRuntimeException.java b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentRuntimeException.java index 3f8385f56..4b98cfb35 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentRuntimeException.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentRuntimeException.java @@ -32,6 +32,7 @@ * @since 3.0 */ public class ConcurrentRuntimeException extends RuntimeException { + /** * The serial version UID. */ 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 18cdf1e84..eb71d3262 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java @@ -38,6 +38,7 @@ public class ConcurrentUtils { * @param <T> the type of the value wrapped by this class */ static final class ConstantFuture<T> implements Future<T> { + /** The constant value. */ private final T value; 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 685110026..c40f919a5 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java @@ -144,6 +144,7 @@ public class EventCountCircuitBreaker extends AbstractCircuitBreaker<Integer> { * if-then-else cascades. */ private abstract static class AbstractStateStrategy { + /** * Obtains the check interval to applied for the represented state from the given * {@link CircuitBreaker}. @@ -186,6 +187,7 @@ public abstract boolean isStateTransition(EventCountCircuitBreaker breaker, * current check interval are stored. */ private static final class CheckIntervalData { + /** The counter for events. */ private final int eventCount; @@ -261,6 +263,7 @@ public boolean isStateTransition(final EventCountCircuitBreaker breaker, * A specialized {@link AbstractStateStrategy} implementation for the state open. */ private static final class StateStrategyOpen extends AbstractStateStrategy { + /** * {@inheritDoc} */ diff --git a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java index 631078394..813155b25 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java @@ -106,6 +106,7 @@ public class MultiBackgroundInitializer extends BackgroundInitializer<MultiBackg * caused an exception. */ public static class MultiBackgroundInitializerResults { + /** A map with the child initializers. */ private final Map<String, BackgroundInitializer<?>> initializers; 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 81c44ba0e..6b7d8719c 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java @@ -51,6 +51,7 @@ * @since 3.5 */ public class ThresholdCircuitBreaker extends AbstractCircuitBreaker<Long> { + /** * The initial value of the internal counter. */ 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 eb7977236..8eee97144 100644 --- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java +++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java @@ -163,6 +163,7 @@ public static <T> EventListenerSupport<T> create(final Class<T> listenerInterfac * The proxy representing the collection of listeners. Calls to this proxy object will be sent to all registered listeners. */ private transient L proxy; + /** * Empty typed array for #getListeners(). */ diff --git a/src/main/java/org/apache/commons/lang3/exception/ContextedException.java b/src/main/java/org/apache/commons/lang3/exception/ContextedException.java index 764fc079e..ad6b6dcfa 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ContextedException.java +++ b/src/main/java/org/apache/commons/lang3/exception/ContextedException.java @@ -87,6 +87,7 @@ public class ContextedException extends Exception implements ExceptionContext { /** The serialization version. */ private static final long serialVersionUID = 20110706L; + /** The context where the data is stored. */ private final ExceptionContext exceptionContext; diff --git a/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java b/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java index 8729aaed8..550276268 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java +++ b/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java @@ -87,6 +87,7 @@ public class ContextedRuntimeException extends RuntimeException implements Excep /** The serialization version. */ private static final long serialVersionUID = 20110706L; + /** The context where the data is stored. */ private final ExceptionContext exceptionContext; diff --git a/src/main/java/org/apache/commons/lang3/function/Failable.java b/src/main/java/org/apache/commons/lang3/function/Failable.java index 2fee999da..cd906cc64 100644 --- a/src/main/java/org/apache/commons/lang3/function/Failable.java +++ b/src/main/java/org/apache/commons/lang3/function/Failable.java @@ -109,6 +109,7 @@ public static <T, E extends Throwable> void accept(final FailableConsumer<T, E> public static <E extends Throwable> void accept(final FailableDoubleConsumer<E> consumer, final double value) { run(consumer, () -> consumer.accept(value)); } + /** * Consumes a consumer and rethrows any exception as a {@link RuntimeException}. * diff --git a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java index 77682188b..2ef56f4d9 100644 --- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java +++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java @@ -35,40 +35,58 @@ public class NumberUtils { /** Reusable Long constant for zero. */ public static final Long LONG_ZERO = Long.valueOf(0L); + /** Reusable Long constant for one. */ public static final Long LONG_ONE = Long.valueOf(1L); + /** Reusable Long constant for minus one. */ public static final Long LONG_MINUS_ONE = Long.valueOf(-1L); + /** Reusable Integer constant for zero. */ public static final Integer INTEGER_ZERO = Integer.valueOf(0); + /** Reusable Integer constant for one. */ public static final Integer INTEGER_ONE = Integer.valueOf(1); + /** Reusable Integer constant for two */ public static final Integer INTEGER_TWO = Integer.valueOf(2); + /** Reusable Integer constant for minus one. */ public static final Integer INTEGER_MINUS_ONE = Integer.valueOf(-1); + /** Reusable Short constant for zero. */ public static final Short SHORT_ZERO = Short.valueOf((short) 0); + /** Reusable Short constant for one. */ public static final Short SHORT_ONE = Short.valueOf((short) 1); + /** Reusable Short constant for minus one. */ public static final Short SHORT_MINUS_ONE = Short.valueOf((short) -1); + /** Reusable Byte constant for zero. */ public static final Byte BYTE_ZERO = Byte.valueOf((byte) 0); + /** Reusable Byte constant for one. */ public static final Byte BYTE_ONE = Byte.valueOf((byte) 1); + /** Reusable Byte constant for minus one. */ public static final Byte BYTE_MINUS_ONE = Byte.valueOf((byte) -1); + /** Reusable Double constant for zero. */ public static final Double DOUBLE_ZERO = Double.valueOf(0.0d); + /** Reusable Double constant for one. */ public static final Double DOUBLE_ONE = Double.valueOf(1.0d); + /** Reusable Double constant for minus one. */ public static final Double DOUBLE_MINUS_ONE = Double.valueOf(-1.0d); + /** Reusable Float constant for zero. */ public static final Float FLOAT_ZERO = Float.valueOf(0.0f); + /** Reusable Float constant for one. */ public static final Float FLOAT_ONE = Float.valueOf(1.0f); + /** Reusable Float constant for minus one. */ public static final Float FLOAT_MINUS_ONE = Float.valueOf(-1.0f); 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 7e1f6d2a9..fdfe382f6 100644 --- a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java +++ b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java @@ -42,6 +42,7 @@ public class CompositeFormat extends Format { /** The parser to use. */ private final Format parser; + /** The formatter to use. */ private final Format formatter; 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 7f09968e9..3baa80105 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java +++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java @@ -89,8 +89,10 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Inner class to allow StrBuilder to operate as a reader. */ final class StrBuilderReader extends Reader { + /** The current stream position. */ private int pos; + /** The last mark position. */ private int mark; @@ -1660,6 +1662,7 @@ public boolean contains(final String str) { public boolean contains(final StrMatcher matcher) { return indexOf(matcher, 0) >= 0; } + /** * Deletes the characters between the two specified indices. * 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 d29c13d17..885707c4e 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrLookup.java +++ b/src/main/java/org/apache/commons/lang3/text/StrLookup.java @@ -88,6 +88,7 @@ public String lookup(final String key) { * Lookup implementation based on system properties. */ private static final class SystemPropertiesStrLookup extends StrLookup<String> { + /** * {@inheritDoc} This implementation directly accesses system properties. */ diff --git a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java index fd34d337d..f455e079f 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java +++ b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java @@ -42,6 +42,7 @@ public abstract class StrMatcher { * Class used to define a character for matching purposes. */ static final class CharMatcher extends StrMatcher { + /** The character to match. */ private final char ch; @@ -68,10 +69,12 @@ public int isMatch(final char[] buffer, final int pos, final int bufferStart, fi return ch == buffer[pos] ? 1 : 0; } } + /** * Class used to define a set of characters for matching purposes. */ static final class CharSetMatcher extends StrMatcher { + /** The set of characters to match. */ private final char[] chars; @@ -98,6 +101,7 @@ public int isMatch(final char[] buffer, final int pos, final int bufferStart, fi return Arrays.binarySearch(chars, buffer[pos]) >= 0 ? 1 : 0; } } + /** * Class used to match no characters. */ @@ -123,10 +127,12 @@ public int isMatch(final char[] buffer, final int pos, final int bufferStart, fi return 0; } } + /** * Class used to define a set of characters for matching purposes. */ static final class StringMatcher extends StrMatcher { + /** The string to match, as a character array. */ private final char[] chars; @@ -168,6 +174,7 @@ public String toString() { } } + /** * Class used to match whitespace as per trim(). */ @@ -193,18 +200,22 @@ public int isMatch(final char[] buffer, final int pos, final int bufferStart, fi return buffer[pos] <= 32 ? 1 : 0; } } + /** * Matches the comma character. */ private static final StrMatcher COMMA_MATCHER = new CharMatcher(','); + /** * Matches the tab character. */ private static final StrMatcher TAB_MATCHER = new CharMatcher('\t'); + /** * Matches the space character. */ private static final StrMatcher SPACE_MATCHER = new CharMatcher(' '); + /** * Matches the same characters as StringTokenizer, * namely space, tab, newline, formfeed. 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 654462b45..24da18a5c 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java +++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java @@ -152,14 +152,17 @@ public class StrSubstitutor { * Constant for the default escape character. */ public static final char DEFAULT_ESCAPE = '$'; + /** * Constant for the default variable prefix. */ public static final StrMatcher DEFAULT_PREFIX = StrMatcher.stringMatcher("${"); + /** * Constant for the default variable suffix. */ public static final StrMatcher DEFAULT_SUFFIX = StrMatcher.stringMatcher("}"); + /** * Constant for the default value delimiter of a variable. * @@ -179,6 +182,7 @@ public class StrSubstitutor { public static <V> String replace(final Object source, final Map<String, V> valueMap) { return new StrSubstitutor(valueMap).replace(source); } + /** * Replaces all the occurrences of variables in the given source object with * their matching values from the map. This method allows to specify a @@ -195,6 +199,7 @@ public static <V> String replace(final Object source, final Map<String, V> value public static <V> String replace(final Object source, final Map<String, V> valueMap, final String prefix, final String suffix) { return new StrSubstitutor(valueMap, prefix, suffix).replace(source); } + /** * Replaces all the occurrences of variables in the given source object with their matching * values from the properties. @@ -216,6 +221,7 @@ public static String replace(final Object source, final Properties valueProperti } return replace(source, valueMap); } + /** * Replaces all the occurrences of variables in the given source object with * their matching values from the system properties. @@ -226,14 +232,17 @@ public static String replace(final Object source, final Properties valueProperti public static String replaceSystemProperties(final Object source) { return new StrSubstitutor(StrLookup.systemPropertiesLookup()).replace(source); } + /** * Stores the escape character. */ private char escapeChar; + /** * Stores the variable prefix. */ private StrMatcher prefixMatcher; + /** * Stores the variable suffix. */ 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 66063b417..73e3e3a7e 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java +++ b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java @@ -124,6 +124,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { private static StrTokenizer getCSVClone() { return (StrTokenizer) CSV_TOKENIZER_PROTOTYPE.clone(); } + /** * Gets a new tokenizer instance which parses Comma Separated Value strings * initializing it with the given input. The default for CSV processing @@ -138,6 +139,7 @@ private static StrTokenizer getCSVClone() { public static StrTokenizer getCSVInstance() { return getCSVClone(); } + /** * Gets a new tokenizer instance which parses Comma Separated Value strings * initializing it with the given input. The default for CSV processing @@ -167,6 +169,7 @@ public static StrTokenizer getCSVInstance(final String input) { tok.reset(input); return tok; } + /** * Gets a clone of {@code TSV_TOKENIZER_PROTOTYPE}. * @@ -217,6 +220,7 @@ public static StrTokenizer getTSVInstance(final String input) { tok.reset(input); return tok; } + /** The text to work on. */ private char[] chars; diff --git a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java index 1e2ee9157..7034d6ffe 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java @@ -39,6 +39,7 @@ public class NumericEntityEscaper extends CodePointTranslator { public static NumericEntityEscaper above(final int codePoint) { return outsideOf(0, codePoint); } + /** * Constructs a {@link NumericEntityEscaper} below the specified value (exclusive). * @@ -48,6 +49,7 @@ public static NumericEntityEscaper above(final int codePoint) { public static NumericEntityEscaper below(final int codePoint) { return outsideOf(codePoint, Integer.MAX_VALUE); } + /** * Constructs a {@link NumericEntityEscaper} between the specified values (inclusive). * diff --git a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java index 64ccb60b3..9113d5707 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java @@ -39,6 +39,7 @@ public class UnicodeEscaper extends CodePointTranslator { public static UnicodeEscaper above(final int codePoint) { return outsideOf(0, codePoint); } + /** * Constructs a {@link UnicodeEscaper} below the specified value (exclusive). * @@ -48,6 +49,7 @@ public static UnicodeEscaper above(final int codePoint) { public static UnicodeEscaper below(final int codePoint) { return outsideOf(codePoint, Integer.MAX_VALUE); } + /** * Constructs a {@link UnicodeEscaper} between the specified values (inclusive). * 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 761397de7..fe535479f 100644 --- a/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/CalendarUtils.java @@ -113,6 +113,7 @@ private static ZoneId toZoneId(final Calendar calendar) { public CalendarUtils(final Calendar calendar) { this(calendar, Locale.getDefault()); } + /** * Creates an instance for the given Calendar. * diff --git a/src/main/java/org/apache/commons/lang3/time/DateUtils.java b/src/main/java/org/apache/commons/lang3/time/DateUtils.java index df4553dc0..f8abf1429 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java @@ -117,6 +117,7 @@ public void remove() { * Calendar modification types. */ private enum ModifyType { + /** * Truncation. */ @@ -177,6 +178,7 @@ private enum ModifyType { {Calendar.MONTH, SEMI_MONTH}, {Calendar.YEAR}, {Calendar.ERA}}; + /** * A week range, starting on Sunday. */ @@ -1587,6 +1589,7 @@ public static Date setMonths(final Date date, final int amount) { public static Date setSeconds(final Date date, final int amount) { return set(date, Calendar.SECOND, amount); } + /** * Sets the years field to a date returning a new object. * The original {@link Date} is unchanged. diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java index 1e8d3b263..5a1434e90 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDateFormat.java @@ -336,6 +336,7 @@ public static FastDateFormat getTimeInstance(final int style, final TimeZone tim /** Our fast printer. */ private final FastDatePrinter printer; + /** Our fast parser. */ private final FastDateParser parser; diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java index 4b1957552..a9e6344a3 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java @@ -202,6 +202,7 @@ private static final class ISO8601TimeZoneStrategy extends PatternStrategy { private static final Strategy ISO_8601_2_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}\\d{2}))"); private static final Strategy ISO_8601_3_STRATEGY = new ISO8601TimeZoneStrategy("(Z|(?:[+-]\\d{2}(?::)\\d{2}))"); + /** * Factory method for ISO8601TimeZoneStrategies. * @@ -221,6 +222,7 @@ static Strategy getStrategy(final int tokenLen) { throw new IllegalArgumentException("invalid number of X"); } } + /** * Constructs a Strategy that parses a TimeZone * @@ -653,6 +655,7 @@ public String toString() { private static final ConcurrentMap<Locale, Strategy>[] CACHES = new ConcurrentMap[Calendar.FIELD_COUNT]; private static final Strategy ABBREVIATED_YEAR_STRATEGY = new NumberStrategy(Calendar.YEAR) { + /** * {@inheritDoc} */ @@ -912,6 +915,7 @@ private Strategy getLocaleSpecificStrategy(final int field, final Calendar defin public String getPattern() { return pattern; } + /** * Gets a Strategy given a field from a SimpleDateFormat pattern * @@ -1031,6 +1035,7 @@ public Date parse(final String source) throws ParseException { } return date; } + /** * This implementation updates the ParsePosition if the parse succeeds. However, it sets the error index to the position before the failed field unlike the * method {@link java.text.SimpleDateFormat#parse(String, ParsePosition)} which sets the error index to after the failed field. @@ -1048,6 +1053,7 @@ public Date parse(final String source, final ParsePosition pos) { cal.clear(); return parse(source, pos, cal) ? cal.getTime() : null; } + /** * Parses a formatted date string according to the format. Updates the Calendar with parsed fields. Upon success, the ParsePosition index is updated to * indicate how much of the source text was consumed. Not all source text needs to be consumed. Upon parse failure, ParsePosition error index is updated to 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 82743cc18..6063e8aaf 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java @@ -244,6 +244,7 @@ public int estimateLength() { * Inner class defining a numeric rule. */ private interface NumberRule extends Rule { + /** * Appends the specified value to the output buffer based on the rule implementation. * @@ -307,6 +308,7 @@ public int estimateLength() { * Inner class defining a rule. */ private interface Rule { + /** * Appends the value of the specified calendar to the output buffer based on the rule implementation. * @@ -356,6 +358,7 @@ public int estimateLength() { return value.length(); } } + /** * Inner class to output one of a set of values. */ @@ -398,6 +401,7 @@ public int estimateLength() { return max; } } + /** * Inner class that acts as a compound key for time zone names. */ @@ -451,6 +455,7 @@ public int hashCode() { return (style * 31 + locale.hashCode()) * 31 + timeZone.hashCode(); } } + /** * Inner class to output a time zone name. */ @@ -495,6 +500,7 @@ public int estimateLength() { return Math.max(standard.length(), daylight.length()); } } + /** * Inner class to output a time zone as a number {@code +/-HHMM} * or {@code +/-HH:MM}. diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java index dda7be15c..6cdbef0f3 100644 --- a/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java +++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutableTriple.java @@ -117,6 +117,7 @@ public static <L, M, R> ImmutableTriple<L, M, R> ofNonNull(final L left, final M /** Left object. */ public final L left; + /** Middle object. */ public final M middle; diff --git a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java index 37ad00a34..b960931dc 100644 --- a/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java +++ b/src/main/java/org/apache/commons/lang3/tuple/MutableTriple.java @@ -91,6 +91,7 @@ public static <L, M, R> MutableTriple<L, M, R> ofNonNull(final L left, final M m /** Left object. */ public L left; + /** Middle object. */ public M middle; diff --git a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java index edd4af9b1..355ccbee0 100644 --- a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java @@ -97,6 +97,7 @@ void testArraycopySupplier() { assertNullPointerException(() -> ArrayUtils.arraycopy(arr, 0, 0, 1, Suppliers.nul())); assertNullPointerException(() -> ArrayUtils.arraycopy(arr, 0, 0, 1, (Supplier<String[]>) null)); } + /** * Tests generic array creation with parameters of same type. */ diff --git a/src/test/java/org/apache/commons/lang3/RandomStringUtilsTest.java b/src/test/java/org/apache/commons/lang3/RandomStringUtilsTest.java index 3602fbc64..e6759c465 100644 --- a/src/test/java/org/apache/commons/lang3/RandomStringUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/RandomStringUtilsTest.java @@ -40,6 +40,7 @@ class RandomStringUtilsTest extends AbstractLangTest { private static final int LOOP_COUNT = 1_000; + /** Maximum safe value for count to avoid overflow: (21x + 3) / 5 + 10 < 0x0FFF_FFFF */ private static final int MAX_SAFE_COUNT = 63_913_201; diff --git a/src/test/java/org/apache/commons/lang3/builder/JsonToStringStyleTest.java b/src/test/java/org/apache/commons/lang3/builder/JsonToStringStyleTest.java index 10036ea83..dbdb92e17 100644 --- a/src/test/java/org/apache/commons/lang3/builder/JsonToStringStyleTest.java +++ b/src/test/java/org/apache/commons/lang3/builder/JsonToStringStyleTest.java @@ -78,6 +78,7 @@ enum Hobby { * An object with a Map field used to test {@code ToStringStyle.JsonToStringStyle}. */ static class InnerMapObject { + /** * Test String field. */ @@ -93,6 +94,7 @@ static class InnerMapObject { * An object with nested object structures used to test {@code ToStringStyle.JsonToStringStyle}. */ static class NestingPerson { + /** * Test String field. */ diff --git a/src/test/java/org/apache/commons/lang3/builder/RecursiveToStringStyleTest.java b/src/test/java/org/apache/commons/lang3/builder/RecursiveToStringStyleTest.java index cbb1407e3..3267d8fc5 100644 --- a/src/test/java/org/apache/commons/lang3/builder/RecursiveToStringStyleTest.java +++ b/src/test/java/org/apache/commons/lang3/builder/RecursiveToStringStyleTest.java @@ -32,12 +32,14 @@ class RecursiveToStringStyleTest extends AbstractLangTest { static class Job { + /** * Test String field. */ String title; } static class Person { + /** * Test String field. */ diff --git a/src/test/java/org/apache/commons/lang3/builder/ToStringStyleTest.java b/src/test/java/org/apache/commons/lang3/builder/ToStringStyleTest.java index 8764c2662..90870fce7 100644 --- a/src/test/java/org/apache/commons/lang3/builder/ToStringStyleTest.java +++ b/src/test/java/org/apache/commons/lang3/builder/ToStringStyleTest.java @@ -30,6 +30,7 @@ class ToStringStyleTest extends AbstractLangTest { * An object used to test {@link ToStringStyle}. */ static class Person { + /** * Test String field. */ diff --git a/src/test/java/org/apache/commons/lang3/concurrent/AtomicInitializerSupplierTest.java b/src/test/java/org/apache/commons/lang3/concurrent/AtomicInitializerSupplierTest.java index 65ccd3b09..9896ab6fe 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/AtomicInitializerSupplierTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/AtomicInitializerSupplierTest.java @@ -23,6 +23,7 @@ * Test class for {@code AtomicInitializer}. */ class AtomicInitializerSupplierTest extends AbstractConcurrentInitializerCloseAndExceptionsTest<Object> { + /** * Returns the initializer to be tested. * diff --git a/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java index f167cacb3..a9e5c9cd6 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/BackgroundInitializerTest.java @@ -38,12 +38,14 @@ import org.junit.jupiter.api.Test; class BackgroundInitializerTest extends AbstractLangTest { + /** * A concrete implementation of BackgroundInitializer. It also overloads * some methods that simplify testing. */ protected static class AbstractBackgroundInitializerTestImpl extends BackgroundInitializer<CloseableCounter> { + /** An exception to be thrown by initialize(). */ Exception ex; @@ -97,6 +99,7 @@ public void releaseLatch() { } protected static class CloseableCounter { + /** The number of invocations of initialize(). */ AtomicInteger initializeCalls = new AtomicInteger(); diff --git a/src/test/java/org/apache/commons/lang3/concurrent/BasicThreadFactoryTest.java b/src/test/java/org/apache/commons/lang3/concurrent/BasicThreadFactoryTest.java index 2a8d317b6..aeedcac09 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/BasicThreadFactoryTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/BasicThreadFactoryTest.java @@ -36,6 +36,7 @@ * Test class for {@code BasicThreadFactory}. */ class BasicThreadFactoryTest extends AbstractLangTest { + /** Constant for the test naming pattern. */ private static final String PATTERN = "testThread-%d"; diff --git a/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java index 1ec90325a..d55bed61e 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializerTest.java @@ -31,11 +31,13 @@ * Test class for {@code CallableBackgroundInitializer} */ class CallableBackgroundInitializerTest extends AbstractLangTest { + /** * A test Callable implementation for checking the initializer's * implementation of the initialize() method. */ private static final class TestCallable implements Callable<Integer> { + /** A counter for the number of call() invocations. */ int callCount; diff --git a/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java b/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java index dc925aada..8046c91aa 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/ConcurrentUtilsTest.java @@ -39,6 +39,7 @@ * Test class for {@link ConcurrentUtils}. */ class ConcurrentUtilsTest extends AbstractLangTest { + /** * Tests constant future. * diff --git a/src/test/java/org/apache/commons/lang3/concurrent/ConstantInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/ConstantInitializerTest.java index 447b229dc..84f418bd8 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/ConstantInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/ConstantInitializerTest.java @@ -29,6 +29,7 @@ * Test class for {@code ConstantInitializer}. */ class ConstantInitializerTest extends AbstractLangTest { + /** Constant for the object managed by the initializer. */ private static final Integer VALUE = 42; diff --git a/src/test/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreakerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreakerTest.java index a0b0f66af..2cd51ba50 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreakerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreakerTest.java @@ -37,10 +37,12 @@ * Test class for {@code EventCountCircuitBreaker}. */ class EventCountCircuitBreakerTest extends AbstractLangTest { + /** * A test change listener for checking whether correct change events are generated. */ private static final class ChangeListener implements PropertyChangeListener { + /** The expected event source. */ private final Object expectedSource; @@ -84,6 +86,7 @@ public void verify(final Boolean... values) { * breaker's state. */ private static final class EventCountCircuitBreakerTestImpl extends EventCountCircuitBreaker { + /** The current time in nanoseconds. */ private long currentTime; diff --git a/src/test/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializerTest.java index e7dff5762..301f5a86e 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializerTest.java @@ -39,6 +39,7 @@ * Test class for {@link MultiBackgroundInitializer}. */ class MultiBackgroundInitializerTest extends AbstractLangTest { + /** * A mostly complete implementation of {@code BackgroundInitializer} used for * defining background tasks for {@code MultiBackgroundInitializer}. @@ -47,6 +48,7 @@ class MultiBackgroundInitializerTest extends AbstractLangTest { * or by using a supplier. */ protected static class AbstractChildBackgroundInitializer extends BackgroundInitializer<CloseableCounter> { + /** Stores the current executor service. */ volatile ExecutorService currentExecutor; diff --git a/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java b/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java index 81b770b20..6736614a0 100644 --- a/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java +++ b/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java @@ -58,6 +58,7 @@ public Object parseObject(final String source, final ParsePosition pos) { throw new UnsupportedOperationException(); } } + /** * {@link FormatFactory} implementation for lower case format. */ @@ -390,6 +391,7 @@ void testEscapedQuote_LANG_477() { final ExtendedMessageFormat emf = new ExtendedMessageFormat(pattern, registry); assertEquals("it's a dummy test!", emf.format(new Object[] {"DUMMY"})); } + /** * Test extended and built-in formats with available locales. */ @@ -424,6 +426,7 @@ void testExtendedAndBuiltInFormatsWithAvailableLocales() { assertEquals(expected.toString(), emf.format(args), String.valueOf(locale)); } } + /** * Test extended and built-in formats with the default locale. */ @@ -452,6 +455,7 @@ void testExtendedAndBuiltInFormatsWithDefaultLocale() { expected.append(nf.format(args[2])); assertEquals(expected.toString(), emf.format(args)); } + /** * Test extended formats. */
