You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/07/11 12:36:33 UTC
(commons-lang) branch master updated (7c91ce989 -> 84966e01e)
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
from 7c91ce989 Match String case folding in StrBuilder.equalsIgnoreCase (#1745)
new 7515777a2 Match String case folding in StrBuilder.equalsIgnoreCase (#1745).
new 84966e01e Javadoc
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/changes/changes.xml | 1 +
.../org/apache/commons/lang3/AnnotationUtils.java | 4 +-
.../org/apache/commons/lang3/AppendableJoiner.java | 2 +-
.../java/org/apache/commons/lang3/ArrayFill.java | 28 +--
.../java/org/apache/commons/lang3/ArraySorter.java | 18 +-
.../java/org/apache/commons/lang3/ArrayUtils.java | 158 ++++++-------
.../java/org/apache/commons/lang3/BitField.java | 42 ++--
.../org/apache/commons/lang3/BooleanUtils.java | 30 +--
.../java/org/apache/commons/lang3/CharRange.java | 12 +-
.../apache/commons/lang3/CharSequenceUtils.java | 10 +-
.../java/org/apache/commons/lang3/CharSet.java | 2 +-
.../org/apache/commons/lang3/CharSetUtils.java | 10 +-
.../java/org/apache/commons/lang3/CharUtils.java | 24 +-
.../java/org/apache/commons/lang3/Charsets.java | 6 +-
.../org/apache/commons/lang3/ClassLoaderUtils.java | 8 +-
.../org/apache/commons/lang3/ClassPathUtils.java | 8 +-
.../java/org/apache/commons/lang3/ClassUtils.java | 76 +++---
.../java/org/apache/commons/lang3/DoubleRange.java | 6 +-
.../java/org/apache/commons/lang3/EnumUtils.java | 18 +-
.../java/org/apache/commons/lang3/Functions.java | 18 +-
.../org/apache/commons/lang3/IntegerRange.java | 6 +-
.../java/org/apache/commons/lang3/JavaVersion.java | 10 +-
.../java/org/apache/commons/lang3/LocaleUtils.java | 10 +-
.../java/org/apache/commons/lang3/LongRange.java | 6 +-
.../java/org/apache/commons/lang3/ObjectUtils.java | 46 ++--
.../apache/commons/lang3/RandomStringUtils.java | 84 +++----
.../java/org/apache/commons/lang3/RandomUtils.java | 46 ++--
src/main/java/org/apache/commons/lang3/Range.java | 24 +-
.../java/org/apache/commons/lang3/RegExUtils.java | 2 +-
.../apache/commons/lang3/SerializationUtils.java | 8 +-
.../java/org/apache/commons/lang3/Streams.java | 8 +-
.../apache/commons/lang3/StringEscapeUtils.java | 4 +-
.../java/org/apache/commons/lang3/StringUtils.java | 258 ++++++++++-----------
.../java/org/apache/commons/lang3/Strings.java | 20 +-
.../org/apache/commons/lang3/SystemProperties.java | 6 +-
.../java/org/apache/commons/lang3/SystemUtils.java | 4 +-
.../java/org/apache/commons/lang3/ThreadUtils.java | 4 +-
.../java/org/apache/commons/lang3/Validate.java | 44 ++--
.../org/apache/commons/lang3/arch/Processor.java | 4 +-
.../commons/lang3/builder/AbstractReflection.java | 2 +-
.../org/apache/commons/lang3/builder/Builder.java | 2 +-
.../org/apache/commons/lang3/builder/Diff.java | 6 +-
.../apache/commons/lang3/builder/DiffBuilder.java | 4 +-
.../apache/commons/lang3/builder/DiffResult.java | 10 +-
.../org/apache/commons/lang3/builder/IDKey.java | 2 +-
.../lang3/builder/ReflectionDiffBuilder.java | 4 +-
.../lang3/builder/ReflectionToStringBuilder.java | 18 +-
.../lang3/builder/StandardToStringStyle.java | 38 +--
.../commons/lang3/builder/ToStringBuilder.java | 18 +-
.../commons/lang3/builder/ToStringStyle.java | 54 ++---
.../commons/lang3/compare/ComparableUtils.java | 4 +-
.../lang3/concurrent/AbstractCircuitBreaker.java | 4 +-
.../concurrent/AbstractConcurrentInitializer.java | 6 +-
.../lang3/concurrent/AbstractFutureProxy.java | 2 +-
.../lang3/concurrent/AtomicInitializer.java | 2 +-
.../lang3/concurrent/BackgroundInitializer.java | 14 +-
.../lang3/concurrent/BasicThreadFactory.java | 16 +-
.../concurrent/CallableBackgroundInitializer.java | 2 +-
.../commons/lang3/concurrent/CircuitBreaker.java | 4 +-
.../commons/lang3/concurrent/Computable.java | 2 +-
.../commons/lang3/concurrent/ConcurrentUtils.java | 10 +-
.../lang3/concurrent/ConstantInitializer.java | 4 +-
.../lang3/concurrent/EventCountCircuitBreaker.java | 24 +-
.../commons/lang3/concurrent/LazyInitializer.java | 2 +-
.../apache/commons/lang3/concurrent/Memoizer.java | 2 +-
.../concurrent/MultiBackgroundInitializer.java | 12 +-
.../lang3/concurrent/ThresholdCircuitBreaker.java | 2 +-
.../commons/lang3/concurrent/TimedSemaphore.java | 16 +-
.../lang3/concurrent/locks/LockingVisitors.java | 4 +-
.../commons/lang3/event/EventListenerSupport.java | 4 +-
.../org/apache/commons/lang3/event/EventUtils.java | 2 +-
.../lang3/exception/ContextedException.java | 4 +-
.../lang3/exception/ContextedRuntimeException.java | 4 +-
.../lang3/exception/DefaultExceptionContext.java | 2 +-
.../commons/lang3/exception/ExceptionContext.java | 10 +-
.../commons/lang3/exception/ExceptionUtils.java | 40 ++--
.../apache/commons/lang3/function/Consumers.java | 2 +-
.../apache/commons/lang3/function/Failable.java | 12 +-
.../commons/lang3/function/FailableBiFunction.java | 2 +-
.../lang3/function/FailableBiPredicate.java | 2 +-
.../function/FailableDoubleBinaryOperator.java | 2 +-
.../lang3/function/FailableDoubleFunction.java | 2 +-
.../function/FailableDoubleToIntFunction.java | 2 +-
.../function/FailableDoubleToLongFunction.java | 2 +-
.../function/FailableDoubleUnaryOperator.java | 2 +-
.../commons/lang3/function/FailableFunction.java | 4 +-
.../lang3/function/FailableIntBinaryOperator.java | 2 +-
.../lang3/function/FailableIntFunction.java | 2 +-
.../function/FailableIntToDoubleFunction.java | 2 +-
.../lang3/function/FailableIntToFloatFunction.java | 2 +-
.../lang3/function/FailableIntToLongFunction.java | 2 +-
.../lang3/function/FailableIntUnaryOperator.java | 2 +-
.../lang3/function/FailableLongBinaryOperator.java | 2 +-
.../lang3/function/FailableLongFunction.java | 2 +-
.../function/FailableLongToDoubleFunction.java | 2 +-
.../lang3/function/FailableLongToIntFunction.java | 2 +-
.../lang3/function/FailableLongUnaryOperator.java | 2 +-
.../commons/lang3/function/FailablePredicate.java | 2 +-
.../lang3/function/FailableToBooleanFunction.java | 2 +-
.../lang3/function/FailableToDoubleBiFunction.java | 2 +-
.../lang3/function/FailableToDoubleFunction.java | 2 +-
.../lang3/function/FailableToIntBiFunction.java | 2 +-
.../lang3/function/FailableToIntFunction.java | 2 +-
.../lang3/function/FailableToLongBiFunction.java | 2 +-
.../lang3/function/FailableToLongFunction.java | 2 +-
.../apache/commons/lang3/function/Functions.java | 4 +-
.../commons/lang3/function/IntToCharFunction.java | 2 +-
.../apache/commons/lang3/function/Predicates.java | 4 +-
.../lang3/function/ToBooleanBiFunction.java | 2 +-
.../apache/commons/lang3/function/TriFunction.java | 2 +-
.../org/apache/commons/lang3/math/Fraction.java | 24 +-
.../apache/commons/lang3/math/IEEE754rUtils.java | 8 +-
.../org/apache/commons/lang3/math/NumberUtils.java | 100 ++++----
.../org/apache/commons/lang3/mutable/Mutable.java | 4 +-
.../commons/lang3/mutable/MutableBoolean.java | 8 +-
.../apache/commons/lang3/mutable/MutableByte.java | 30 +--
.../commons/lang3/mutable/MutableDouble.java | 28 +--
.../apache/commons/lang3/mutable/MutableFloat.java | 28 +--
.../apache/commons/lang3/mutable/MutableInt.java | 28 +--
.../apache/commons/lang3/mutable/MutableLong.java | 28 +--
.../commons/lang3/mutable/MutableObject.java | 6 +-
.../apache/commons/lang3/mutable/MutableShort.java | 30 +--
.../commons/lang3/reflect/ConstructorUtils.java | 6 +-
.../apache/commons/lang3/reflect/FieldUtils.java | 32 +--
.../commons/lang3/reflect/InheritanceUtils.java | 2 +-
.../apache/commons/lang3/reflect/MethodUtils.java | 10 +-
.../apache/commons/lang3/reflect/TypeUtils.java | 14 +-
.../apache/commons/lang3/stream/IntStreams.java | 2 +-
.../commons/lang3/stream/LangCollectors.java | 2 +-
.../org/apache/commons/lang3/stream/Streams.java | 16 +-
.../apache/commons/lang3/text/CompositeFormat.java | 2 +-
.../commons/lang3/text/FormattableUtils.java | 10 +-
.../org/apache/commons/lang3/text/StrBuilder.java | 60 ++---
.../org/apache/commons/lang3/text/StrLookup.java | 4 +-
.../org/apache/commons/lang3/text/StrMatcher.java | 32 +--
.../apache/commons/lang3/text/StrSubstitutor.java | 48 ++--
.../apache/commons/lang3/text/StrTokenizer.java | 36 +--
.../commons/lang3/text/translate/EntityArrays.java | 20 +-
.../lang3/text/translate/JavaUnicodeEscaper.java | 10 +-
.../lang3/text/translate/NumericEntityEscaper.java | 8 +-
.../lang3/text/translate/UnicodeEscaper.java | 10 +-
.../apache/commons/lang3/time/CalendarUtils.java | 8 +-
.../apache/commons/lang3/time/DateFormatUtils.java | 32 +--
.../org/apache/commons/lang3/time/DateParser.java | 6 +-
.../org/apache/commons/lang3/time/DatePrinter.java | 26 +--
.../org/apache/commons/lang3/time/DateUtils.java | 58 ++---
.../commons/lang3/time/DurationFormatUtils.java | 20 +-
.../apache/commons/lang3/time/FastDateFormat.java | 30 +--
.../apache/commons/lang3/time/FastDatePrinter.java | 12 +-
.../org/apache/commons/lang3/time/Instants.java | 4 +-
.../org/apache/commons/lang3/time/StopWatch.java | 34 +--
.../org/apache/commons/lang3/time/TimeZones.java | 2 +-
.../apache/commons/lang3/tuple/ImmutablePair.java | 2 +-
.../commons/lang3/tuple/ImmutableTriple.java | 2 +-
.../apache/commons/lang3/tuple/MutablePair.java | 4 +-
.../apache/commons/lang3/tuple/MutableTriple.java | 2 +-
.../java/org/apache/commons/lang3/tuple/Pair.java | 16 +-
.../org/apache/commons/lang3/tuple/Triple.java | 12 +-
.../apache/commons/lang3/util/FluentBitSet.java | 18 +-
.../commons/lang3/builder/ToStringBuilderTest.java | 2 +-
.../AbstractConcurrentInitializerTest.java | 2 +-
.../concurrent/AtomicInitializerNonObjectTest.java | 2 +-
.../concurrent/AtomicInitializerObjectTest.java | 2 +-
.../concurrent/AtomicInitializerSupplierTest.java | 2 +-
.../AtomicSafeInitializerSupplierTest.java | 2 +-
.../concurrent/AtomicSafeInitializerTest.java | 2 +-
.../concurrent/LazyInitializerAnonClassTest.java | 2 +-
.../concurrent/LazyInitializerCloserTest.java | 2 +-
.../LazyInitializerFailableCloserTest.java | 2 +-
.../concurrent/LazyInitializerSimpleTest.java | 2 +-
.../LazyInitializerSingleInstanceTest.java | 2 +-
.../concurrent/LazyInitializerSupplierTest.java | 2 +-
.../concurrent/MultiBackgroundInitializerTest.java | 2 +-
.../lang3/concurrent/TimedSemaphoreTest.java | 2 +-
.../lang3/time/FastDateParserReadObjectTest.java | 2 +-
.../commons/lang3/time/FastDateParserTest.java | 2 +-
.../commons/lang3/time/FastDatePrinterTest.java | 2 +-
177 files changed, 1243 insertions(+), 1242 deletions(-)
(commons-lang) 02/02: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
commit 84966e01e511a76a4851945b162fd0e01091c174
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jul 11 08:36:26 2026 -0400
Javadoc
---
.../org/apache/commons/lang3/AnnotationUtils.java | 4 +-
.../org/apache/commons/lang3/AppendableJoiner.java | 2 +-
.../java/org/apache/commons/lang3/ArrayFill.java | 28 +--
.../java/org/apache/commons/lang3/ArraySorter.java | 18 +-
.../java/org/apache/commons/lang3/ArrayUtils.java | 158 ++++++-------
.../java/org/apache/commons/lang3/BitField.java | 42 ++--
.../org/apache/commons/lang3/BooleanUtils.java | 30 +--
.../java/org/apache/commons/lang3/CharRange.java | 12 +-
.../apache/commons/lang3/CharSequenceUtils.java | 10 +-
.../java/org/apache/commons/lang3/CharSet.java | 2 +-
.../org/apache/commons/lang3/CharSetUtils.java | 10 +-
.../java/org/apache/commons/lang3/CharUtils.java | 24 +-
.../java/org/apache/commons/lang3/Charsets.java | 6 +-
.../org/apache/commons/lang3/ClassLoaderUtils.java | 8 +-
.../org/apache/commons/lang3/ClassPathUtils.java | 8 +-
.../java/org/apache/commons/lang3/ClassUtils.java | 76 +++---
.../java/org/apache/commons/lang3/DoubleRange.java | 6 +-
.../java/org/apache/commons/lang3/EnumUtils.java | 18 +-
.../java/org/apache/commons/lang3/Functions.java | 18 +-
.../org/apache/commons/lang3/IntegerRange.java | 6 +-
.../java/org/apache/commons/lang3/JavaVersion.java | 10 +-
.../java/org/apache/commons/lang3/LocaleUtils.java | 10 +-
.../java/org/apache/commons/lang3/LongRange.java | 6 +-
.../java/org/apache/commons/lang3/ObjectUtils.java | 46 ++--
.../apache/commons/lang3/RandomStringUtils.java | 84 +++----
.../java/org/apache/commons/lang3/RandomUtils.java | 46 ++--
src/main/java/org/apache/commons/lang3/Range.java | 24 +-
.../java/org/apache/commons/lang3/RegExUtils.java | 2 +-
.../apache/commons/lang3/SerializationUtils.java | 8 +-
.../java/org/apache/commons/lang3/Streams.java | 8 +-
.../apache/commons/lang3/StringEscapeUtils.java | 4 +-
.../java/org/apache/commons/lang3/StringUtils.java | 258 ++++++++++-----------
.../java/org/apache/commons/lang3/Strings.java | 20 +-
.../org/apache/commons/lang3/SystemProperties.java | 6 +-
.../java/org/apache/commons/lang3/SystemUtils.java | 4 +-
.../java/org/apache/commons/lang3/ThreadUtils.java | 4 +-
.../java/org/apache/commons/lang3/Validate.java | 44 ++--
.../org/apache/commons/lang3/arch/Processor.java | 4 +-
.../commons/lang3/builder/AbstractReflection.java | 2 +-
.../org/apache/commons/lang3/builder/Builder.java | 2 +-
.../org/apache/commons/lang3/builder/Diff.java | 6 +-
.../apache/commons/lang3/builder/DiffBuilder.java | 4 +-
.../apache/commons/lang3/builder/DiffResult.java | 10 +-
.../org/apache/commons/lang3/builder/IDKey.java | 2 +-
.../lang3/builder/ReflectionDiffBuilder.java | 4 +-
.../lang3/builder/ReflectionToStringBuilder.java | 18 +-
.../lang3/builder/StandardToStringStyle.java | 38 +--
.../commons/lang3/builder/ToStringBuilder.java | 18 +-
.../commons/lang3/builder/ToStringStyle.java | 54 ++---
.../commons/lang3/compare/ComparableUtils.java | 4 +-
.../lang3/concurrent/AbstractCircuitBreaker.java | 4 +-
.../concurrent/AbstractConcurrentInitializer.java | 6 +-
.../lang3/concurrent/AbstractFutureProxy.java | 2 +-
.../lang3/concurrent/AtomicInitializer.java | 2 +-
.../lang3/concurrent/BackgroundInitializer.java | 14 +-
.../lang3/concurrent/BasicThreadFactory.java | 16 +-
.../concurrent/CallableBackgroundInitializer.java | 2 +-
.../commons/lang3/concurrent/CircuitBreaker.java | 4 +-
.../commons/lang3/concurrent/Computable.java | 2 +-
.../commons/lang3/concurrent/ConcurrentUtils.java | 10 +-
.../lang3/concurrent/ConstantInitializer.java | 4 +-
.../lang3/concurrent/EventCountCircuitBreaker.java | 24 +-
.../commons/lang3/concurrent/LazyInitializer.java | 2 +-
.../apache/commons/lang3/concurrent/Memoizer.java | 2 +-
.../concurrent/MultiBackgroundInitializer.java | 12 +-
.../lang3/concurrent/ThresholdCircuitBreaker.java | 2 +-
.../commons/lang3/concurrent/TimedSemaphore.java | 16 +-
.../lang3/concurrent/locks/LockingVisitors.java | 4 +-
.../commons/lang3/event/EventListenerSupport.java | 4 +-
.../org/apache/commons/lang3/event/EventUtils.java | 2 +-
.../lang3/exception/ContextedException.java | 4 +-
.../lang3/exception/ContextedRuntimeException.java | 4 +-
.../lang3/exception/DefaultExceptionContext.java | 2 +-
.../commons/lang3/exception/ExceptionContext.java | 10 +-
.../commons/lang3/exception/ExceptionUtils.java | 40 ++--
.../apache/commons/lang3/function/Consumers.java | 2 +-
.../apache/commons/lang3/function/Failable.java | 12 +-
.../commons/lang3/function/FailableBiFunction.java | 2 +-
.../lang3/function/FailableBiPredicate.java | 2 +-
.../function/FailableDoubleBinaryOperator.java | 2 +-
.../lang3/function/FailableDoubleFunction.java | 2 +-
.../function/FailableDoubleToIntFunction.java | 2 +-
.../function/FailableDoubleToLongFunction.java | 2 +-
.../function/FailableDoubleUnaryOperator.java | 2 +-
.../commons/lang3/function/FailableFunction.java | 4 +-
.../lang3/function/FailableIntBinaryOperator.java | 2 +-
.../lang3/function/FailableIntFunction.java | 2 +-
.../function/FailableIntToDoubleFunction.java | 2 +-
.../lang3/function/FailableIntToFloatFunction.java | 2 +-
.../lang3/function/FailableIntToLongFunction.java | 2 +-
.../lang3/function/FailableIntUnaryOperator.java | 2 +-
.../lang3/function/FailableLongBinaryOperator.java | 2 +-
.../lang3/function/FailableLongFunction.java | 2 +-
.../function/FailableLongToDoubleFunction.java | 2 +-
.../lang3/function/FailableLongToIntFunction.java | 2 +-
.../lang3/function/FailableLongUnaryOperator.java | 2 +-
.../commons/lang3/function/FailablePredicate.java | 2 +-
.../lang3/function/FailableToBooleanFunction.java | 2 +-
.../lang3/function/FailableToDoubleBiFunction.java | 2 +-
.../lang3/function/FailableToDoubleFunction.java | 2 +-
.../lang3/function/FailableToIntBiFunction.java | 2 +-
.../lang3/function/FailableToIntFunction.java | 2 +-
.../lang3/function/FailableToLongBiFunction.java | 2 +-
.../lang3/function/FailableToLongFunction.java | 2 +-
.../apache/commons/lang3/function/Functions.java | 4 +-
.../commons/lang3/function/IntToCharFunction.java | 2 +-
.../apache/commons/lang3/function/Predicates.java | 4 +-
.../lang3/function/ToBooleanBiFunction.java | 2 +-
.../apache/commons/lang3/function/TriFunction.java | 2 +-
.../org/apache/commons/lang3/math/Fraction.java | 24 +-
.../apache/commons/lang3/math/IEEE754rUtils.java | 8 +-
.../org/apache/commons/lang3/math/NumberUtils.java | 100 ++++----
.../org/apache/commons/lang3/mutable/Mutable.java | 4 +-
.../commons/lang3/mutable/MutableBoolean.java | 8 +-
.../apache/commons/lang3/mutable/MutableByte.java | 30 +--
.../commons/lang3/mutable/MutableDouble.java | 28 +--
.../apache/commons/lang3/mutable/MutableFloat.java | 28 +--
.../apache/commons/lang3/mutable/MutableInt.java | 28 +--
.../apache/commons/lang3/mutable/MutableLong.java | 28 +--
.../commons/lang3/mutable/MutableObject.java | 6 +-
.../apache/commons/lang3/mutable/MutableShort.java | 30 +--
.../commons/lang3/reflect/ConstructorUtils.java | 6 +-
.../apache/commons/lang3/reflect/FieldUtils.java | 32 +--
.../commons/lang3/reflect/InheritanceUtils.java | 2 +-
.../apache/commons/lang3/reflect/MethodUtils.java | 10 +-
.../apache/commons/lang3/reflect/TypeUtils.java | 14 +-
.../apache/commons/lang3/stream/IntStreams.java | 2 +-
.../commons/lang3/stream/LangCollectors.java | 2 +-
.../org/apache/commons/lang3/stream/Streams.java | 16 +-
.../apache/commons/lang3/text/CompositeFormat.java | 2 +-
.../commons/lang3/text/FormattableUtils.java | 10 +-
.../org/apache/commons/lang3/text/StrBuilder.java | 60 ++---
.../org/apache/commons/lang3/text/StrLookup.java | 4 +-
.../org/apache/commons/lang3/text/StrMatcher.java | 32 +--
.../apache/commons/lang3/text/StrSubstitutor.java | 48 ++--
.../apache/commons/lang3/text/StrTokenizer.java | 36 +--
.../commons/lang3/text/translate/EntityArrays.java | 20 +-
.../lang3/text/translate/JavaUnicodeEscaper.java | 10 +-
.../lang3/text/translate/NumericEntityEscaper.java | 8 +-
.../lang3/text/translate/UnicodeEscaper.java | 10 +-
.../apache/commons/lang3/time/CalendarUtils.java | 8 +-
.../apache/commons/lang3/time/DateFormatUtils.java | 32 +--
.../org/apache/commons/lang3/time/DateParser.java | 6 +-
.../org/apache/commons/lang3/time/DatePrinter.java | 26 +--
.../org/apache/commons/lang3/time/DateUtils.java | 58 ++---
.../commons/lang3/time/DurationFormatUtils.java | 20 +-
.../apache/commons/lang3/time/FastDateFormat.java | 30 +--
.../apache/commons/lang3/time/FastDatePrinter.java | 12 +-
.../org/apache/commons/lang3/time/Instants.java | 4 +-
.../org/apache/commons/lang3/time/StopWatch.java | 34 +--
.../org/apache/commons/lang3/time/TimeZones.java | 2 +-
.../apache/commons/lang3/tuple/ImmutablePair.java | 2 +-
.../commons/lang3/tuple/ImmutableTriple.java | 2 +-
.../apache/commons/lang3/tuple/MutablePair.java | 4 +-
.../apache/commons/lang3/tuple/MutableTriple.java | 2 +-
.../java/org/apache/commons/lang3/tuple/Pair.java | 16 +-
.../org/apache/commons/lang3/tuple/Triple.java | 12 +-
.../apache/commons/lang3/util/FluentBitSet.java | 18 +-
.../commons/lang3/builder/ToStringBuilderTest.java | 2 +-
.../AbstractConcurrentInitializerTest.java | 2 +-
.../concurrent/AtomicInitializerNonObjectTest.java | 2 +-
.../concurrent/AtomicInitializerObjectTest.java | 2 +-
.../concurrent/AtomicInitializerSupplierTest.java | 2 +-
.../AtomicSafeInitializerSupplierTest.java | 2 +-
.../concurrent/AtomicSafeInitializerTest.java | 2 +-
.../concurrent/LazyInitializerAnonClassTest.java | 2 +-
.../concurrent/LazyInitializerCloserTest.java | 2 +-
.../LazyInitializerFailableCloserTest.java | 2 +-
.../concurrent/LazyInitializerSimpleTest.java | 2 +-
.../LazyInitializerSingleInstanceTest.java | 2 +-
.../concurrent/LazyInitializerSupplierTest.java | 2 +-
.../concurrent/MultiBackgroundInitializerTest.java | 2 +-
.../lang3/concurrent/TimedSemaphoreTest.java | 2 +-
.../lang3/time/FastDateParserReadObjectTest.java | 2 +-
.../commons/lang3/time/FastDateParserTest.java | 2 +-
.../commons/lang3/time/FastDatePrinterTest.java | 2 +-
176 files changed, 1242 insertions(+), 1242 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
index 2a995e3fc..654d8d891 100644
--- a/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/AnnotationUtils.java
@@ -231,7 +231,7 @@ && isValidAnnotationMemberType(m.getReturnType())) {
*
* @param a the Annotation for a hash code calculation is desired, not
* {@code null}
- * @return the calculated hash code
+ * @return The calculated hash code
* @throws RuntimeException if an {@link Exception} is encountered during
* annotation member access
* @throws IllegalStateException if an annotation method invocation returns
@@ -326,7 +326,7 @@ private static boolean memberEquals(final Class<?> type, final Object o1, final
* {@link Annotation#toString()}.
*
* @param a the annotation of which a string representation is desired
- * @return the standard string representation of an annotation, not
+ * @return The standard string representation of an annotation, not
* {@code null}
*/
public static String toString(final Annotation a) {
diff --git a/src/main/java/org/apache/commons/lang3/AppendableJoiner.java b/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
index f4b3776e0..86bc9d857 100644
--- a/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
+++ b/src/main/java/org/apache/commons/lang3/AppendableJoiner.java
@@ -278,7 +278,7 @@ public StringBuilder join(final StringBuilder stringBuilder, final Iterable<T> e
*
* @param stringBuilder The target.
* @param elements The source.
- * @return the given target StringBuilder.
+ * @return The given target StringBuilder.
*/
public StringBuilder join(final StringBuilder stringBuilder, @SuppressWarnings("unchecked") final T... elements) {
return joinSB(stringBuilder, prefix, suffix, delimiter, appender, elements);
diff --git a/src/main/java/org/apache/commons/lang3/ArrayFill.java b/src/main/java/org/apache/commons/lang3/ArrayFill.java
index d04491921..49b45f4d8 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayFill.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayFill.java
@@ -36,7 +36,7 @@ public final class ArrayFill {
* </pre>
*
* @param a the array to fill (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(byte[],byte)
* @see ArrayFill#fill(byte[],byte)
* @since 3.21.0
@@ -55,7 +55,7 @@ public static byte[] clear(final byte[] a) {
* </pre>
*
* @param a the array to fill (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(char[],char)
* @see ArrayFill#fill(char[],char)
* @see CharUtils#NUL
@@ -77,7 +77,7 @@ public static char[] clear(final char[] a) {
* @param a the array to fill (may be null).
* @param fromIndex the index of the first element (inclusive) to be filled with {@code '\0'}.
* @param toIndex the index of the last element (exclusive) to be filled with {@code '\0'}.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(char[], int, int, char)
* @since 3.21.0
*/
@@ -90,7 +90,7 @@ public static char[] clear(char[] a, int fromIndex, int toIndex) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(boolean[],boolean)
* @since 3.18.0
*/
@@ -106,7 +106,7 @@ public static boolean[] fill(final boolean[] a, final boolean val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(byte[],byte)
*/
public static byte[] fill(final byte[] a, final byte val) {
@@ -121,7 +121,7 @@ public static byte[] fill(final byte[] a, final byte val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(char[],char)
*/
public static char[] fill(final char[] a, final char val) {
@@ -138,7 +138,7 @@ public static char[] fill(final char[] a, final char val) {
* @param val the value to store in all elements of the array.
* @param fromIndex the index of the first element (inclusive) to be filled with the specified value.
* @param toIndex the index of the last element (exclusive) to be filled with the specified value.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(char[], int, int, char)
* @since 3.21.0
*/
@@ -154,7 +154,7 @@ public static char[] fill(char[] a, int fromIndex, int toIndex, char val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(double[],double)
*/
public static double[] fill(final double[] a, final double val) {
@@ -169,7 +169,7 @@ public static double[] fill(final double[] a, final double val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(float[],float)
*/
public static float[] fill(final float[] a, final float val) {
@@ -184,7 +184,7 @@ public static float[] fill(final float[] a, final float val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(int[],int)
*/
public static int[] fill(final int[] a, final int val) {
@@ -199,7 +199,7 @@ public static int[] fill(final int[] a, final int val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(long[],long)
*/
public static long[] fill(final long[] a, final long val) {
@@ -214,7 +214,7 @@ public static long[] fill(final long[] a, final long val) {
*
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(short[],short)
*/
public static short[] fill(final short[] a, final short val) {
@@ -237,7 +237,7 @@ public static short[] fill(final short[] a, final short val) {
* @param <T> type of elements of the array.
* @param array array to fill (may be null).
* @param generator a function accepting an index and producing the desired value for that position.
- * @return the input array.
+ * @return The input array.
* @param <E> The kind of thrown exception or error.
* @throws E Thrown by the given {@code generator}.
* @see Arrays#setAll(Object[], IntFunction)
@@ -258,7 +258,7 @@ public static <T, E extends Throwable> T[] fill(final T[] array, final FailableI
* @param <T> The array type.
* @param a the array to fill (may be null).
* @param val the value to store in all elements of the array.
- * @return the given array.
+ * @return The given array.
* @see Arrays#fill(Object[],Object)
*/
public static <T> T[] fill(final T[] a, final T val) {
diff --git a/src/main/java/org/apache/commons/lang3/ArraySorter.java b/src/main/java/org/apache/commons/lang3/ArraySorter.java
index 7ad5f4a82..f4522b6ee 100644
--- a/src/main/java/org/apache/commons/lang3/ArraySorter.java
+++ b/src/main/java/org/apache/commons/lang3/ArraySorter.java
@@ -32,7 +32,7 @@ public class ArraySorter {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(byte[])
*/
public static byte[] sort(final byte[] array) {
@@ -46,7 +46,7 @@ public static byte[] sort(final byte[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(char[])
*/
public static char[] sort(final char[] array) {
@@ -60,7 +60,7 @@ public static char[] sort(final char[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(double[])
*/
public static double[] sort(final double[] array) {
@@ -74,7 +74,7 @@ public static double[] sort(final double[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(float[])
*/
public static float[] sort(final float[] array) {
@@ -88,7 +88,7 @@ public static float[] sort(final float[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(int[])
*/
public static int[] sort(final int[] array) {
@@ -102,7 +102,7 @@ public static int[] sort(final int[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(long[])
*/
public static long[] sort(final long[] array) {
@@ -116,7 +116,7 @@ public static long[] sort(final long[] array) {
* Sorts the given array into ascending order and returns it.
*
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(short[])
*/
public static short[] sort(final short[] array) {
@@ -131,7 +131,7 @@ public static short[] sort(final short[] array) {
*
* @param <T> The array type.
* @param array the array to sort (may be null).
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(Object[])
*/
public static <T> T[] sort(final T[] array) {
@@ -148,7 +148,7 @@ public static <T> T[] sort(final T[] array) {
* @param array the array to sort (may be null).
* @param comparator the comparator to determine the order of the array. A {@code null} value uses the elements'
* {@link Comparable natural ordering}.
- * @return the given array.
+ * @return The given array.
* @see Arrays#sort(Object[])
*/
public static <T> T[] sort(final T[] array, final Comparator<? super T> comparator) {
diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
index 90073d2a1..8676ee826 100644
--- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java
@@ -1166,7 +1166,7 @@ public static <T> T[] addAll(final T[] array1, @SuppressWarnings("unchecked") fi
* @param totalLength the current accumulated length
* @param array the array whose length should be added (can be {@code null},
* in which case its length is considered 0)
- * @return the new total length after adding the array's length
+ * @return The new total length after adding the array's length
* @throws IllegalArgumentException if total arrays length exceed {@link ArrayUtils#SAFE_MAX_ARRAY_LENGTH}.
*/
private static int addExact(final int totalLength, final Object array) {
@@ -1488,7 +1488,7 @@ public static <T> T arraycopy(final T source, final int sourcePos, final T dest,
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static boolean[] clone(final boolean[] array) {
return array != null ? array.clone() : null;
@@ -1501,7 +1501,7 @@ public static boolean[] clone(final boolean[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static byte[] clone(final byte[] array) {
return array != null ? array.clone() : null;
@@ -1514,7 +1514,7 @@ public static byte[] clone(final byte[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static char[] clone(final char[] array) {
return array != null ? array.clone() : null;
@@ -1527,7 +1527,7 @@ public static char[] clone(final char[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static double[] clone(final double[] array) {
return array != null ? array.clone() : null;
@@ -1540,7 +1540,7 @@ public static double[] clone(final double[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static float[] clone(final float[] array) {
return array != null ? array.clone() : null;
@@ -1553,7 +1553,7 @@ public static float[] clone(final float[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static int[] clone(final int[] array) {
return array != null ? array.clone() : null;
@@ -1566,7 +1566,7 @@ public static int[] clone(final int[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static long[] clone(final long[] array) {
return array != null ? array.clone() : null;
@@ -1579,7 +1579,7 @@ public static long[] clone(final long[] array) {
* </p>
*
* @param array the array to clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static short[] clone(final short[] array) {
return array != null ? array.clone() : null;
@@ -1596,7 +1596,7 @@ public static short[] clone(final short[] array) {
*
* @param <T> the component type of the array.
* @param array the array to shallow clone, may be {@code null}.
- * @return the cloned array, {@code null} if {@code null} input.
+ * @return The cloned array, {@code null} if {@code null} input.
*/
public static <T> T[] clone(final T[] array) {
return array != null ? array.clone() : null;
@@ -2102,7 +2102,7 @@ private static Object copyArrayGrow1(final Object array, final Class<?> newArray
* @param <T> The type of array elements.
* @param array The array to index.
* @param index The index.
- * @return the nTh element of an array or null if the index is out of bounds or the array is null.
+ * @return The nTh element of an array or null if the index is out of bounds or the array is null.
* @since 3.11
*/
public static <T> T get(final T[] array, final int index) {
@@ -2116,7 +2116,7 @@ public static <T> T get(final T[] array, final int index) {
* @param array The array to index.
* @param index The index.
* @param defaultValue The return value of the given index is out of bounds.
- * @return the nTh element of an array or a default value if the index is out of bounds.
+ * @return The nTh element of an array or a default value if the index is out of bounds.
* @since 3.11
*/
public static <T> T get(final T[] array, final int index, final T defaultValue) {
@@ -2672,7 +2672,7 @@ public static BitSet indexesOf(final short[] array, final short valueToFind, int
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final boolean[] array, final boolean valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2690,7 +2690,7 @@ public static int indexOf(final boolean[] array, final boolean valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final boolean[] array, final boolean valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -2712,7 +2712,7 @@ public static int indexOf(final boolean[] array, final boolean valueToFind, fina
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final byte[] array, final byte valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2730,7 +2730,7 @@ public static int indexOf(final byte[] array, final byte valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final byte[] array, final byte valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -2752,7 +2752,7 @@ public static int indexOf(final byte[] array, final byte valueToFind, final int
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
* @since 2.1
*/
public static int indexOf(final char[] array, final char valueToFind) {
@@ -2771,7 +2771,7 @@ public static int indexOf(final char[] array, final char valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
* @since 2.1
*/
public static int indexOf(final char[] array, final char valueToFind, final int startIndex) {
@@ -2794,7 +2794,7 @@ public static int indexOf(final char[] array, final char valueToFind, final int
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final double[] array, final double valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2810,7 +2810,7 @@ public static int indexOf(final double[] array, final double valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param tolerance tolerance of the search.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final double[] array, final double valueToFind, final double tolerance) {
return indexOf(array, valueToFind, 0, tolerance);
@@ -2828,7 +2828,7 @@ public static int indexOf(final double[] array, final double valueToFind, final
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final double[] array, final double valueToFind, final int startIndex) {
if (Double.isNaN(valueToFind)) {
@@ -2859,7 +2859,7 @@ public static int indexOf(final double[] array, final double valueToFind, final
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
* @param tolerance tolerance of the search.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final double[] array, final double valueToFind, final int startIndex, final double tolerance) {
if (Double.isNaN(valueToFind)) {
@@ -2886,7 +2886,7 @@ public static int indexOf(final double[] array, final double valueToFind, final
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final float[] array, final float valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2904,7 +2904,7 @@ public static int indexOf(final float[] array, final float valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final float[] array, final float valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -2928,7 +2928,7 @@ public static int indexOf(final float[] array, final float valueToFind, final in
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final int[] array, final int valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2946,7 +2946,7 @@ public static int indexOf(final int[] array, final int valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final int[] array, final int valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -2968,7 +2968,7 @@ public static int indexOf(final int[] array, final int valueToFind, final int st
*
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final long[] array, final long valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -2986,7 +2986,7 @@ public static int indexOf(final long[] array, final long valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final long[] array, final long valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -3008,7 +3008,7 @@ public static int indexOf(final long[] array, final long valueToFind, final int
*
* @param array the array to search for the object, may be {@code null}.
* @param objectToFind the object to find, may be {@code null}.
- * @return the index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final Object[] array, final Object objectToFind) {
return indexOf(array, objectToFind, 0);
@@ -3026,7 +3026,7 @@ public static int indexOf(final Object[] array, final Object objectToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param objectToFind the object to find, may be {@code null}.
* @param startIndex the index to start searching.
- * @return the index of the object within the array starting at the index, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the object within the array starting at the index, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final Object[] array, final Object objectToFind, int startIndex) {
if (isEmpty(array)) {
@@ -3057,7 +3057,7 @@ public static int indexOf(final Object[] array, final Object objectToFind, int s
*
* @param array the array to search for the object, may be {@code null}
* @param valueToFind the value to find.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final short[] array, final short valueToFind) {
return indexOf(array, valueToFind, 0);
@@ -3075,7 +3075,7 @@ public static int indexOf(final short[] array, final short valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the index to start searching.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int indexOf(final short[] array, final short valueToFind, final int startIndex) {
if (isEmpty(array)) {
@@ -3093,7 +3093,7 @@ public static int indexOf(final short[] array, final short valueToFind, final in
* Finds the index of the NaN value in a double array.
* @param array the array to search for NaN, may be {@code null}.
* @param startIndex the index to start searching.
- * @return the index of the NaN value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the NaN value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
private static int indexOfNaN(final double[] array, final int startIndex) {
if (isEmpty(array)) {
@@ -4097,7 +4097,7 @@ public static <T> boolean isSorted(final T[] array, final Comparator<T> comparat
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final boolean[] array, final boolean valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4115,7 +4115,7 @@ public static int lastIndexOf(final boolean[] array, final boolean valueToFind)
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final boolean[] array, final boolean valueToFind, int startIndex) {
if (isEmpty(array) || startIndex < 0) {
@@ -4140,7 +4140,7 @@ public static int lastIndexOf(final boolean[] array, final boolean valueToFind,
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final byte[] array, final byte valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4158,7 +4158,7 @@ public static int lastIndexOf(final byte[] array, final byte valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final byte[] array, final byte valueToFind, int startIndex) {
if (array == null || startIndex < 0) {
@@ -4183,7 +4183,7 @@ public static int lastIndexOf(final byte[] array, final byte valueToFind, int st
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
* @since 2.1
*/
public static int lastIndexOf(final char[] array, final char valueToFind) {
@@ -4202,7 +4202,7 @@ public static int lastIndexOf(final char[] array, final char valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
* @since 2.1
*/
public static int lastIndexOf(final char[] array, final char valueToFind, int startIndex) {
@@ -4228,7 +4228,7 @@ public static int lastIndexOf(final char[] array, final char valueToFind, int st
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final double[] array, final double valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4244,7 +4244,7 @@ public static int lastIndexOf(final double[] array, final double valueToFind) {
* @param array the array to search for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param tolerance tolerance of the search.
- * @return the index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final double[] array, final double valueToFind, final double tolerance) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE, tolerance);
@@ -4262,7 +4262,7 @@ public static int lastIndexOf(final double[] array, final double valueToFind, fi
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final double[] array, final double valueToFind, int startIndex) {
if (Double.isNaN(valueToFind)) {
@@ -4296,7 +4296,7 @@ public static int lastIndexOf(final double[] array, final double valueToFind, in
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
* @param tolerance search for value within plus/minus this amount.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final double[] array, final double valueToFind, int startIndex, final double tolerance) {
if (Double.isNaN(valueToFind)) {
@@ -4326,7 +4326,7 @@ public static int lastIndexOf(final double[] array, final double valueToFind, in
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final float[] array, final float valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4344,7 +4344,7 @@ public static int lastIndexOf(final float[] array, final float valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final float[] array, final float valueToFind, int startIndex) {
if (isEmpty(array) || startIndex < 0) {
@@ -4371,7 +4371,7 @@ public static int lastIndexOf(final float[] array, final float valueToFind, int
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final int[] array, final int valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4389,7 +4389,7 @@ public static int lastIndexOf(final int[] array, final int valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final int[] array, final int valueToFind, int startIndex) {
if (array == null || startIndex < 0) {
@@ -4414,7 +4414,7 @@ public static int lastIndexOf(final int[] array, final int valueToFind, int star
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final long[] array, final long valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4432,7 +4432,7 @@ public static int lastIndexOf(final long[] array, final long valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final long[] array, final long valueToFind, int startIndex) {
if (array == null || startIndex < 0) {
@@ -4457,7 +4457,7 @@ public static int lastIndexOf(final long[] array, final long valueToFind, int st
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param objectToFind the object to find, may be {@code null}.
- * @return the last index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final Object[] array, final Object objectToFind) {
return lastIndexOf(array, objectToFind, Integer.MAX_VALUE);
@@ -4475,7 +4475,7 @@ public static int lastIndexOf(final Object[] array, final Object objectToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param objectToFind the object to find, may be {@code null}.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the object within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final Object[] array, final Object objectToFind, int startIndex) {
if (array == null || startIndex < 0) {
@@ -4508,7 +4508,7 @@ public static int lastIndexOf(final Object[] array, final Object objectToFind, i
*
* @param array the array to traverse backwards looking for the object, may be {@code null}.
* @param valueToFind the object to find.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final short[] array, final short valueToFind) {
return lastIndexOf(array, valueToFind, Integer.MAX_VALUE);
@@ -4526,7 +4526,7 @@ public static int lastIndexOf(final short[] array, final short valueToFind) {
* @param array the array to traverse for looking for the object, may be {@code null}.
* @param valueToFind the value to find.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
public static int lastIndexOf(final short[] array, final short valueToFind, int startIndex) {
if (array == null || startIndex < 0) {
@@ -4547,7 +4547,7 @@ public static int lastIndexOf(final short[] array, final short valueToFind, int
* Finds the last index of the NaN value in a double array.
* @param array the array to traverse backwards for NaN, may be {@code null}.
* @param startIndex the start index to traverse backwards from.
- * @return the last index of the NaN value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
+ * @return The last index of the NaN value within the array, {@link #INDEX_NOT_FOUND} ({@code -1}) if not found or {@code null} array input.
*/
private static int lastIndexOfNaN(final double[] array, final int startIndex) {
if (isEmpty(array) || startIndex < 0) {
@@ -4611,7 +4611,7 @@ public static <T> T[] newInstance(final Class<T> componentType, final int length
* @param <T> The array type.
* @param array the array to check for {@code null} or empty
* @param defaultArray A default array, usually empty.
- * @return the same array, or defaultArray if {@code null} or empty input.
+ * @return The same array, or defaultArray if {@code null} or empty input.
* @since 3.15.0
*/
public static <T> T[] nullTo(final T[] array, final T[] defaultArray) {
@@ -4630,7 +4630,7 @@ public static <T> T[] nullTo(final T[] array, final T[] defaultArray) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static boolean[] nullToEmpty(final boolean[] array) {
@@ -4649,7 +4649,7 @@ public static boolean[] nullToEmpty(final boolean[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Boolean[] nullToEmpty(final Boolean[] array) {
@@ -4668,7 +4668,7 @@ public static Boolean[] nullToEmpty(final Boolean[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static byte[] nullToEmpty(final byte[] array) {
@@ -4687,7 +4687,7 @@ public static byte[] nullToEmpty(final byte[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Byte[] nullToEmpty(final Byte[] array) {
@@ -4706,7 +4706,7 @@ public static Byte[] nullToEmpty(final Byte[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static char[] nullToEmpty(final char[] array) {
@@ -4725,7 +4725,7 @@ public static char[] nullToEmpty(final char[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Character[] nullToEmpty(final Character[] array) {
@@ -4744,7 +4744,7 @@ public static Character[] nullToEmpty(final Character[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 3.2
*/
public static Class<?>[] nullToEmpty(final Class<?>[] array) {
@@ -4763,7 +4763,7 @@ public static Class<?>[] nullToEmpty(final Class<?>[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static double[] nullToEmpty(final double[] array) {
@@ -4782,7 +4782,7 @@ public static double[] nullToEmpty(final double[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Double[] nullToEmpty(final Double[] array) {
@@ -4801,7 +4801,7 @@ public static Double[] nullToEmpty(final Double[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static float[] nullToEmpty(final float[] array) {
@@ -4820,7 +4820,7 @@ public static float[] nullToEmpty(final float[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Float[] nullToEmpty(final Float[] array) {
@@ -4839,7 +4839,7 @@ public static Float[] nullToEmpty(final Float[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static int[] nullToEmpty(final int[] array) {
@@ -4858,7 +4858,7 @@ public static int[] nullToEmpty(final int[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Integer[] nullToEmpty(final Integer[] array) {
@@ -4877,7 +4877,7 @@ public static Integer[] nullToEmpty(final Integer[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static long[] nullToEmpty(final long[] array) {
@@ -4896,7 +4896,7 @@ public static long[] nullToEmpty(final long[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Long[] nullToEmpty(final Long[] array) {
@@ -4915,7 +4915,7 @@ public static Long[] nullToEmpty(final Long[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Object[] nullToEmpty(final Object[] array) {
@@ -4934,7 +4934,7 @@ public static Object[] nullToEmpty(final Object[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static short[] nullToEmpty(final short[] array) {
@@ -4953,7 +4953,7 @@ public static short[] nullToEmpty(final short[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static Short[] nullToEmpty(final Short[] array) {
@@ -4972,7 +4972,7 @@ public static Short[] nullToEmpty(final Short[] array) {
* </p>
*
* @param array the array to check for {@code null} or empty.
- * @return the same array, {@code public static} empty array if {@code null} or empty input.
+ * @return The same array, {@code public static} empty array if {@code null} or empty input.
* @since 2.5
*/
public static String[] nullToEmpty(final String[] array) {
@@ -4989,7 +4989,7 @@ public static String[] nullToEmpty(final String[] array) {
* @param array the array to check for {@code null} or empty.
* @param type the class representation of the desired array.
* @param <T> the class type.
- * @return the same array, {@code public static} empty array if {@code null}.
+ * @return The same array, {@code public static} empty array if {@code null}.
* @throws IllegalArgumentException if the type argument is null.
* @since 3.5
*/
@@ -5006,7 +5006,7 @@ public static <T> T[] nullToEmpty(final T[] array, final Class<T[]> type) {
/**
* Gets the current thread's {@link ThreadLocalRandom} for {@code shuffle} methods that don't take a {@link Random} argument.
*
- * @return the current ThreadLocalRandom.
+ * @return The current ThreadLocalRandom.
*/
private static ThreadLocalRandom random() {
return ThreadLocalRandom.current();
@@ -7097,7 +7097,7 @@ public static void reverse(final short[] array, final int startIndexInclusive, f
* @param <T> type of elements of the array, may be {@code null}.
* @param array array to be initialized, may be {@code null}.
* @param generator a function accepting an index and producing the desired value for that position.
- * @return the input array
+ * @return The input array
* @since 3.13.0
*/
public static <T> T[] setAll(final T[] array, final IntFunction<? extends T> generator) {
@@ -7117,7 +7117,7 @@ public static <T> T[] setAll(final T[] array, final IntFunction<? extends T> gen
* @param <T> type of elements of the array, may be {@code null}.
* @param array array to be initialized, may be {@code null}.
* @param generator a function accepting an index and producing the desired value for that position.
- * @return the input array
+ * @return The input array
* @since 3.13.0
*/
public static <T> T[] setAll(final T[] array, final Supplier<? extends T> generator) {
@@ -8979,7 +8979,7 @@ public static void swap(final short[] array, int offset1, int offset2, int len)
*
* @param <T> the array's element type.
* @param items the varargs array items, null allowed.
- * @return the array, not null unless a null array is passed in.
+ * @return The array, not null unless a null array is passed in.
* @since 3.0
*/
public static <T> T[] toArray(@SuppressWarnings("unchecked") final T... items) {
diff --git a/src/main/java/org/apache/commons/lang3/BitField.java b/src/main/java/org/apache/commons/lang3/BitField.java
index 247460c06..bb11dead3 100644
--- a/src/main/java/org/apache/commons/lang3/BitField.java
+++ b/src/main/java/org/apache/commons/lang3/BitField.java
@@ -101,7 +101,7 @@ public BitField(final long mask) {
* Clears the bits.
*
* @param holder the int data containing the bits we're interested in.
- * @return the value of holder with the specified bits cleared (set to {@code 0}).
+ * @return The value of holder with the specified bits cleared (set to {@code 0}).
*/
public int clear(final int holder) {
return (int) (holder & ~mask);
@@ -111,7 +111,7 @@ public int clear(final int holder) {
* Clears the bits.
*
* @param holder the long data containing the bits we're interested in.
- * @return the value of holder with the specified bits cleared (set to {@code 0}).
+ * @return The value of holder with the specified bits cleared (set to {@code 0}).
* @since 3.21.0
*/
public long clear(final long holder) {
@@ -122,7 +122,7 @@ public long clear(final long holder) {
* Clears the bits.
*
* @param holder the byte data containing the bits we're interested in.
- * @return the value of holder with the specified bits cleared (set to {@code 0}).
+ * @return The value of holder with the specified bits cleared (set to {@code 0}).
*/
public byte clearByte(final byte holder) {
return (byte) clear(holder);
@@ -132,7 +132,7 @@ public byte clearByte(final byte holder) {
* Clears the bits.
*
* @param holder the short data containing the bits we're interested in.
- * @return the value of holder with the specified bits cleared (set to {@code 0}).
+ * @return The value of holder with the specified bits cleared (set to {@code 0}).
*/
public short clearShort(final short holder) {
return (short) clear(holder);
@@ -142,7 +142,7 @@ public short clearShort(final short holder) {
* Gets the value for the specified BitField, unshifted.
*
* @param holder the int data containing the bits we're interested in.
- * @return the selected bits.
+ * @return The selected bits.
*/
public int getRawValue(final int holder) {
return (int) (holder & mask);
@@ -152,7 +152,7 @@ public int getRawValue(final int holder) {
* Gets the value for the specified BitField, unshifted.
*
* @param holder the long data containing the bits we're interested in.
- * @return the selected bits.
+ * @return The selected bits.
* @since 3.21.0
*/
public long getRawValue(final long holder) {
@@ -163,7 +163,7 @@ public long getRawValue(final long holder) {
* Obtains the value for the specified BitField, unshifted.
*
* @param holder the short data containing the bits we're interested in.
- * @return the selected bits.
+ * @return The selected bits.
*/
public short getShortRawValue(final short holder) {
return (short) getRawValue(holder);
@@ -177,7 +177,7 @@ public short getShortRawValue(final short holder) {
* </p>
*
* @param holder the short data containing the bits we're interested in.
- * @return the selected bits, shifted right appropriately.
+ * @return The selected bits, shifted right appropriately.
* @see #setShortValue(short,short)
*/
public short getShortValue(final short holder) {
@@ -192,7 +192,7 @@ public short getShortValue(final short holder) {
* </p>
*
* @param holder the int data containing the bits we're interested in.
- * @return the selected bits, shifted right appropriately.
+ * @return The selected bits, shifted right appropriately.
* @see #setValue(int,int)
*/
public int getValue(final int holder) {
@@ -207,7 +207,7 @@ public int getValue(final int holder) {
* </p>
*
* @param holder the long data containing the bits we're interested in.
- * @return the selected bits, shifted right appropriately.
+ * @return The selected bits, shifted right appropriately.
* @see #setValue(long,long)
* @since 3.21.0
*/
@@ -275,7 +275,7 @@ public boolean isSet(final long holder) {
* Sets the bits.
*
* @param holder the int data containing the bits we're interested in.
- * @return the value of holder with the specified bits set to {@code 1}.
+ * @return The value of holder with the specified bits set to {@code 1}.
*/
public int set(final int holder) {
return (int) (holder | mask);
@@ -285,7 +285,7 @@ public int set(final int holder) {
* Sets the bits.
*
* @param holder the long data containing the bits we're interested in.
- * @return the value of holder with the specified bits set to {@code 1}.
+ * @return The value of holder with the specified bits set to {@code 1}.
* @since 3.21.0
*/
public long set(final long holder) {
@@ -297,7 +297,7 @@ public long set(final long holder) {
*
* @param holder the int data containing the bits we're interested in.
* @param flag indicating whether to set or clear the bits.
- * @return the value of holder with the specified bits set or cleared.
+ * @return The value of holder with the specified bits set or cleared.
*/
public int setBoolean(final int holder, final boolean flag) {
return flag ? set(holder) : clear(holder);
@@ -308,7 +308,7 @@ public int setBoolean(final int holder, final boolean flag) {
*
* @param holder the long data containing the bits we're interested in.
* @param flag indicating whether to set or clear the bits.
- * @return the value of holder with the specified bits set or cleared.
+ * @return The value of holder with the specified bits set or cleared.
* @since 3.21.0
*/
public long setBoolean(final long holder, final boolean flag) {
@@ -319,7 +319,7 @@ public long setBoolean(final long holder, final boolean flag) {
* Sets the bits.
*
* @param holder the byte data containing the bits we're interested in
- * @return the value of holder with the specified bits set to {@code 1}
+ * @return The value of holder with the specified bits set to {@code 1}
*/
public byte setByte(final byte holder) {
return (byte) set(holder);
@@ -330,7 +330,7 @@ public byte setByte(final byte holder) {
*
* @param holder the byte data containing the bits we're interested in.
* @param flag indicating whether to set or clear the bits.
- * @return the value of holder with the specified bits set or cleared.
+ * @return The value of holder with the specified bits set or cleared.
*/
public byte setByteBoolean(final byte holder, final boolean flag) {
return flag ? setByte(holder) : clearByte(holder);
@@ -340,7 +340,7 @@ public byte setByteBoolean(final byte holder, final boolean flag) {
* Sets the bits.
*
* @param holder the short data containing the bits we're interested in.
- * @return the value of holder with the specified bits set to {@code 1}.
+ * @return The value of holder with the specified bits set to {@code 1}.
*/
public short setShort(final short holder) {
return (short) set(holder);
@@ -351,7 +351,7 @@ public short setShort(final short holder) {
*
* @param holder the short data containing the bits we're interested in.
* @param flag indicating whether to set or clear the bits.
- * @return the value of holder with the specified bits set or cleared.
+ * @return The value of holder with the specified bits set or cleared.
*/
public short setShortBoolean(final short holder, final boolean flag) {
return flag ? setShort(holder) : clearShort(holder);
@@ -362,7 +362,7 @@ public short setShortBoolean(final short holder, final boolean flag) {
*
* @param holder the short data containing the bits we're interested in
* @param value the new value for the specified bits
- * @return the value of holder with the bits from the value parameter replacing the old bits
+ * @return The value of holder with the bits from the value parameter replacing the old bits
* @see #getShortValue(short)
*/
public short setShortValue(final short holder, final short value) {
@@ -374,7 +374,7 @@ public short setShortValue(final short holder, final short value) {
*
* @param holder the int data containing the bits we're interested in.
* @param value the new value for the specified bits.
- * @return the value of holder with the bits from the value parameter replacing the old bits.
+ * @return The value of holder with the bits from the value parameter replacing the old bits.
* @see #getValue(int)
*/
public int setValue(final int holder, final int value) {
@@ -386,7 +386,7 @@ public int setValue(final int holder, final int value) {
*
* @param holder the long data containing the bits we're interested in.
* @param value the new value for the specified bits.
- * @return the value of holder with the bits from the value parameter replacing the old bits.
+ * @return The value of holder with the bits from the value parameter replacing the old bits.
* @see #getValue(long)
* @since 3.21.0
*/
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index 7cb0c3e92..bebf53117 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -92,7 +92,7 @@ public class BooleanUtils {
* </pre>
*
* @param array an array of {@code boolean}s
- * @return the result of the logical 'and' operation. That is {@code false}
+ * @return The result of the logical 'and' operation. That is {@code false}
* if any of the parameters is {@code false} and {@code true} otherwise.
* @throws NullPointerException if {@code array} is {@code null}
* @throws IllegalArgumentException if {@code array} is empty.
@@ -124,7 +124,7 @@ public static boolean and(final boolean... array) {
* </p>
*
* @param array an array of {@link Boolean}s
- * @return the result of the logical 'and' operation. That is {@code false}
+ * @return The result of the logical 'and' operation. That is {@code false}
* if any of the parameters is {@code false} and {@code true} otherwise.
* @throws NullPointerException if {@code array} is {@code null}
* @throws IllegalArgumentException if {@code array} is empty.
@@ -150,7 +150,7 @@ public static Boolean[] booleanValues() {
*
* @param x the first {@code boolean} to compare
* @param y the second {@code boolean} to compare
- * @return the value {@code 0} if {@code x == y};
+ * @return The value {@code 0} if {@code x == y};
* a value less than {@code 0} if {@code !x && y}; and
* a value greater than {@code 0} if {@code x && !y}
* @since 3.4
@@ -259,7 +259,7 @@ public static boolean isTrue(final Boolean bool) {
* </pre>
*
* @param bool the Boolean to negate, may be null
- * @return the negated Boolean, or {@code null} if {@code null} input
+ * @return The negated Boolean, or {@code null} if {@code null} input
*/
public static Boolean negate(final Boolean bool) {
if (bool == null) {
@@ -278,7 +278,7 @@ public static Boolean negate(final Boolean bool) {
* </p>
*
* @param array an array of {@code boolean}s
- * @return the result of the one-hot operations
+ * @return The result of the one-hot operations
* @throws NullPointerException if {@code array} is {@code null}
* @throws IllegalArgumentException if {@code array} is empty.
*/
@@ -309,7 +309,7 @@ public static boolean oneHot(final boolean... array) {
* </p>
*
* @param array an array of {@code boolean}s
- * @return the result of the one-hot operations
+ * @return The result of the one-hot operations
* @throws NullPointerException if {@code array} is {@code null}
* @throws IllegalArgumentException if {@code array} is empty.
*/
@@ -509,7 +509,7 @@ public static boolean toBoolean(final Integer value, final Integer trueValue, fi
* </pre>
*
* @param str the String to check
- * @return the boolean value of the string, {@code false} if no match or the String is null
+ * @return The boolean value of the string, {@code false} if no match or the String is null
*/
public static boolean toBoolean(final String str) {
return toBooleanObject(str) == Boolean.TRUE;
@@ -526,7 +526,7 @@ public static boolean toBoolean(final String str) {
* @param str the String to check
* @param trueString the String to match for {@code true} (case-sensitive), may be {@code null}
* @param falseString the String to match for {@code false} (case-sensitive), may be {@code null}
- * @return the boolean value of the string
+ * @return The boolean value of the string
* @throws IllegalArgumentException if the String doesn't match
*/
public static boolean toBoolean(final String str, final String trueString, final String falseString) {
@@ -733,7 +733,7 @@ public static Boolean toBooleanObject(final Integer value, final Integer trueVal
* </pre>
*
* @param str the String to check; upper and lower case are treated as the same
- * @return the Boolean value of the string, {@code null} if no match or {@code null} input
+ * @return The Boolean value of the string, {@code null} if no match or {@code null} input
*/
public static Boolean toBooleanObject(final String str) {
// Previously used equalsIgnoreCase, which was fast for interned 'true'.
@@ -849,7 +849,7 @@ public static Boolean toBooleanObject(final String str) {
* @param trueString the String to match for {@code true} (case-sensitive), may be {@code null}
* @param falseString the String to match for {@code false} (case-sensitive), may be {@code null}
* @param nullString the String to match for {@code null} (case-sensitive), may be {@code null}
- * @return the Boolean value of the string, {@code null} if either the String matches {@code nullString}
+ * @return The Boolean value of the string, {@code null} if either the String matches {@code nullString}
* or if {@code null} input and {@code nullString} is {@code null}
* @throws IllegalArgumentException if the String doesn't match
*/
@@ -902,7 +902,7 @@ public static int toInteger(final boolean bool) {
* @param bool the to convert
* @param trueValue the value to return if {@code true}
* @param falseValue the value to return if {@code false}
- * @return the appropriate value
+ * @return The appropriate value
*/
public static int toInteger(final boolean bool, final int trueValue, final int falseValue) {
return bool ? trueValue : falseValue;
@@ -921,7 +921,7 @@ public static int toInteger(final boolean bool, final int trueValue, final int f
* @param trueValue the value to return if {@code true}
* @param falseValue the value to return if {@code false}
* @param nullValue the value to return if {@code null}
- * @return the appropriate value
+ * @return The appropriate value
*/
public static int toInteger(final Boolean bool, final int trueValue, final int falseValue, final int nullValue) {
if (bool == null) {
@@ -957,7 +957,7 @@ public static Integer toIntegerObject(final boolean bool) {
* @param bool the to convert
* @param trueValue the value to return if {@code true}, may be {@code null}
* @param falseValue the value to return if {@code false}, may be {@code null}
- * @return the appropriate value
+ * @return The appropriate value
*/
public static Integer toIntegerObject(final boolean bool, final Integer trueValue, final Integer falseValue) {
return bool ? trueValue : falseValue;
@@ -997,7 +997,7 @@ public static Integer toIntegerObject(final Boolean bool) {
* @param trueValue the value to return if {@code true}, may be {@code null}
* @param falseValue the value to return if {@code false}, may be {@code null}
* @param nullValue the value to return if {@code null}, may be {@code null}
- * @return the appropriate value
+ * @return The appropriate value
*/
public static Integer toIntegerObject(final Boolean bool, final Integer trueValue, final Integer falseValue, final Integer nullValue) {
if (bool == null) {
@@ -1202,7 +1202,7 @@ public static boolean xor(final boolean... array) {
* </p>
*
* @param array an array of {@link Boolean}s
- * @return the result of the xor operations
+ * @return The result of the xor operations
* @throws NullPointerException if {@code array} is {@code null}
* @throws IllegalArgumentException if {@code array} is empty.
*/
diff --git a/src/main/java/org/apache/commons/lang3/CharRange.java b/src/main/java/org/apache/commons/lang3/CharRange.java
index 88bb0aa4a..57bda1aa8 100644
--- a/src/main/java/org/apache/commons/lang3/CharRange.java
+++ b/src/main/java/org/apache/commons/lang3/CharRange.java
@@ -150,7 +150,7 @@ public void remove() {
* Constructs a {@link CharRange} over a single character.
*
* @param ch only character in this range.
- * @return the new CharRange object.
+ * @return The new CharRange object.
* @since 2.5
*/
public static CharRange is(final char ch) {
@@ -165,7 +165,7 @@ public static CharRange is(final char ch) {
*
* @param start first character, inclusive, in this range.
* @param end last character, inclusive, in this range.
- * @return the new CharRange object.
+ * @return The new CharRange object.
* @since 2.5
*/
public static CharRange isIn(final char start, final char end) {
@@ -179,7 +179,7 @@ public static CharRange isIn(final char start, final char end) {
* single character.</p>
*
* @param ch only character in this range.
- * @return the new CharRange object.
+ * @return The new CharRange object.
* @since 2.5
*/
public static CharRange isNot(final char ch) {
@@ -197,7 +197,7 @@ public static CharRange isNot(final char ch) {
*
* @param start first character, inclusive, in this range.
* @param end last character, inclusive, in this range.
- * @return the new CharRange object.
+ * @return The new CharRange object.
* @since 2.5
*/
public static CharRange isNotIn(final char start, final char end) {
@@ -296,7 +296,7 @@ public boolean equals(final Object obj) {
/**
* Gets the end character for this character range.
*
- * @return the end char (inclusive).
+ * @return The end char (inclusive).
*/
public char getEnd() {
return this.end;
@@ -305,7 +305,7 @@ public char getEnd() {
/**
* Gets the start character for this character range.
*
- * @return the start char (inclusive).
+ * @return The start char (inclusive).
*/
public char getStart() {
return this.start;
diff --git a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
index 4a544eb78..7372225a7 100644
--- a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java
@@ -67,7 +67,7 @@ private static boolean equalsIgnoreCase(final int cp1, final int cp2) {
* @param cs the {@link CharSequence} to be processed.
* @param searchChar the {@link CharSequence} to be searched for.
* @param start the start index.
- * @return the index where the search sequence was found, or {@code -1} if there is no such occurrence.
+ * @return The index where the search sequence was found, or {@code -1} if there is no such occurrence.
*/
static int indexOf(final CharSequence cs, final CharSequence searchChar, final int start) {
if (cs == null || searchChar == null) {
@@ -127,7 +127,7 @@ static int indexOf(final CharSequence cs, final CharSequence searchChar, final i
* @param cs the {@link CharSequence} to be processed, not null.
* @param searchChar the char to be searched for.
* @param start the start index, negative starts at the string start.
- * @return the index where the search char was found, -1 if not found.
+ * @return The index where the search char was found, -1 if not found.
* @since 3.6 updated to behave more like {@link String}.
*/
static int indexOf(final CharSequence cs, final int searchChar, int start) {
@@ -166,7 +166,7 @@ static int indexOf(final CharSequence cs, final int searchChar, int start) {
* @param cs the {@link CharSequence} to be processed.
* @param searchChar the {@link CharSequence} to find.
* @param start the start index.
- * @return the index where the search sequence was found.
+ * @return The index where the search sequence was found.
*/
static int lastIndexOf(final CharSequence cs, final CharSequence searchChar, int start) {
if (searchChar == null || cs == null) {
@@ -259,7 +259,7 @@ static int lastIndexOf(final CharSequence cs, final CharSequence searchChar, int
* @param cs the {@link CharSequence} to be processed.
* @param searchChar the char to be searched for.
* @param start the start index, negative returns -1, beyond length starts at end.
- * @return the index where the search char was found, -1 if not found.
+ * @return The index where the search char was found, -1 if not found.
* @since 3.6 updated to behave more like {@link String}.
*/
static int lastIndexOf(final CharSequence cs, final int searchChar, int start) {
@@ -399,7 +399,7 @@ public static CharSequence subSequence(final CharSequence cs, final int start) {
* Converts the given CharSequence to a char[].
*
* @param source the {@link CharSequence} to be processed.
- * @return the resulting char array, never null.
+ * @return The resulting char array, never null.
* @since 3.11
*/
public static char[] toCharArray(final CharSequence source) {
diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java
index bdbffc4c4..81d388773 100644
--- a/src/main/java/org/apache/commons/lang3/CharSet.java
+++ b/src/main/java/org/apache/commons/lang3/CharSet.java
@@ -271,7 +271,7 @@ public boolean equals(final Object obj) {
* Package private for testing.
* </p>
*
- * @return the set of character ranges.
+ * @return The set of character ranges.
*/
Set<CharRange> getCharRanges() {
return set;
diff --git a/src/main/java/org/apache/commons/lang3/CharSetUtils.java b/src/main/java/org/apache/commons/lang3/CharSetUtils.java
index d8dd4aa21..105647f26 100644
--- a/src/main/java/org/apache/commons/lang3/CharSetUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharSetUtils.java
@@ -80,7 +80,7 @@ public static boolean containsAny(final String str, final String... set) {
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to count characters in, may be null
* @param set String[] set of characters to count, may be null
- * @return the character count, zero if null string input
+ * @return The character count, zero if null string input
*/
public static int count(final String str, final String... set) {
if (isEmpty(str, set)) {
@@ -123,7 +123,7 @@ private static boolean deepEmpty(final String[] strings) {
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to delete characters from, may be null
* @param set String[] set of characters to delete, may be null
- * @return the modified String, {@code null} if null string input
+ * @return The modified String, {@code null} if null string input
*/
public static String delete(final String str, final String... set) {
if (isEmpty(str, set)) {
@@ -152,7 +152,7 @@ private static boolean isEmpty(final String str, final String... set) {
* @see CharSet#getInstance(String...) for set-syntax.
* @param str String to keep characters from, may be null
* @param set String[] set of characters to keep, may be null
- * @return the modified String, {@code null} if null string input
+ * @return The modified String, {@code null} if null string input
* @since 2.0
*/
public static String keep(final String str, final String... set) {
@@ -171,7 +171,7 @@ public static String keep(final String str, final String... set) {
* @param str String to modify characters within
* @param set String[] set of characters to modify
* @param expect whether to evaluate on match, or non-match
- * @return the modified String, not null
+ * @return The modified String, not null
*/
private static String modify(final String str, final String[] set, final boolean expect) {
final CharSet chars = CharSet.getInstance(set);
@@ -201,7 +201,7 @@ private static String modify(final String str, final String[] set, final boolean
* @see CharSet#getInstance(String...) for set-syntax.
* @param str the string to squeeze, may be null
* @param set the character set to use for manipulation, may be null
- * @return the modified String, {@code null} if null string input
+ * @return The modified String, {@code null} if null string input
*/
public static String squeeze(final String str, final String... set) {
if (isEmpty(str, set)) {
diff --git a/src/main/java/org/apache/commons/lang3/CharUtils.java b/src/main/java/org/apache/commons/lang3/CharUtils.java
index a454dd088..dbc8493ad 100644
--- a/src/main/java/org/apache/commons/lang3/CharUtils.java
+++ b/src/main/java/org/apache/commons/lang3/CharUtils.java
@@ -65,7 +65,7 @@ public class CharUtils {
*
* @param x the first {@code char} to compare
* @param y the second {@code char} to compare
- * @return the value {@code 0} if {@code x == y};
+ * @return The value {@code 0} if {@code x == y};
* a value less than {@code 0} if {@code x < y}; and
* a value greater than {@code 0} if {@code x > y}
* @since 3.4
@@ -332,7 +332,7 @@ public static boolean isOctal(final char ch) {
* </pre>
*
* @param ch the character to convert
- * @return the char value of the Character
+ * @return The char value of the Character
* @throws NullPointerException if the Character is null
*/
public static char toChar(final Character ch) {
@@ -350,7 +350,7 @@ public static char toChar(final Character ch) {
*
* @param ch the character to convert
* @param defaultValue the value to use if the Character is null
- * @return the char value of the Character or the default if null
+ * @return The char value of the Character or the default if null
*/
public static char toChar(final Character ch, final char defaultValue) {
return ch != null ? ch.charValue() : defaultValue;
@@ -368,7 +368,7 @@ public static char toChar(final Character ch, final char defaultValue) {
* </pre>
*
* @param str the character to convert
- * @return the char value of the first letter of the String
+ * @return The char value of the first letter of the String
* @throws NullPointerException if the string is null
* @throws IllegalArgumentException if the String is empty
*/
@@ -390,7 +390,7 @@ public static char toChar(final String str) {
*
* @param str the character to convert
* @param defaultValue the value to use if the Character is null
- * @return the char value of the first letter of the String or the default if null
+ * @return The char value of the first letter of the String or the default if null
*/
public static char toChar(final String str, final char defaultValue) {
return StringUtils.isEmpty(str) ? defaultValue : str.charAt(0);
@@ -423,7 +423,7 @@ public static Character toCharacterObject(final char c) {
* </pre>
*
* @param str the character to convert
- * @return the Character value of the first letter of the String
+ * @return The Character value of the first letter of the String
*/
public static Character toCharacterObject(final String str) {
return StringUtils.isEmpty(str) ? null : Character.valueOf(str.charAt(0));
@@ -441,7 +441,7 @@ public static Character toCharacterObject(final String str) {
* </pre>
*
* @param ch the character to convert
- * @return the int value of the character
+ * @return The int value of the character
* @throws IllegalArgumentException if the character is not ASCII numeric
*/
public static int toIntValue(final char ch) {
@@ -464,7 +464,7 @@ public static int toIntValue(final char ch) {
*
* @param ch the character to convert
* @param defaultValue the default value to use if the character is not numeric
- * @return the int value of the character
+ * @return The int value of the character
*/
public static int toIntValue(final char ch, final int defaultValue) {
return isAsciiNumeric(ch) ? ch - 48 : defaultValue;
@@ -483,7 +483,7 @@ public static int toIntValue(final char ch, final int defaultValue) {
* </pre>
*
* @param ch the character to convert, not null
- * @return the int value of the character
+ * @return The int value of the character
* @throws NullPointerException if the Character is null
* @throws IllegalArgumentException if the Character is not ASCII numeric
*/
@@ -505,7 +505,7 @@ public static int toIntValue(final Character ch) {
*
* @param ch the character to convert
* @param defaultValue the default value to use if the character is not numeric
- * @return the int value of the character
+ * @return The int value of the character
*/
public static int toIntValue(final Character ch, final int defaultValue) {
return ch != null ? toIntValue(ch.charValue(), defaultValue) : defaultValue;
@@ -564,7 +564,7 @@ public static String toString(final Character ch) {
* </pre>
*
* @param ch the character to convert
- * @return the escaped Unicode string
+ * @return The escaped Unicode string
*/
public static String unicodeEscaped(final char ch) {
return "\\u" +
@@ -588,7 +588,7 @@ public static String unicodeEscaped(final char ch) {
* </pre>
*
* @param ch the character to convert, may be null
- * @return the escaped Unicode string, null if null input
+ * @return The escaped Unicode string, null if null input
*/
public static String unicodeEscaped(final Character ch) {
return ch != null ? unicodeEscaped(ch.charValue()) : null;
diff --git a/src/main/java/org/apache/commons/lang3/Charsets.java b/src/main/java/org/apache/commons/lang3/Charsets.java
index 4db73473f..7a1bc49dc 100644
--- a/src/main/java/org/apache/commons/lang3/Charsets.java
+++ b/src/main/java/org/apache/commons/lang3/Charsets.java
@@ -38,7 +38,7 @@ final class Charsets {
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charset a Charset or null.
- * @return the given {@code charset} or the default Charset if {@code charset} is null.
+ * @return The given {@code charset} or the default Charset if {@code charset} is null.
*/
static Charset toCharset(final Charset charset) {
return charset == null ? Charset.defaultCharset() : charset;
@@ -48,7 +48,7 @@ static Charset toCharset(final Charset charset) {
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charsetName a Charset or null.
- * @return the given {@code charset} or the default Charset if {@code charset} is null.
+ * @return The given {@code charset} or the default Charset if {@code charset} is null.
* @throws UnsupportedCharsetException If no support for the named charset is available in this instance of the Java
* virtual machine
*/
@@ -60,7 +60,7 @@ static Charset toCharset(final String charsetName) {
* Returns the given {@code charset} or the default Charset if {@code charset} is null.
*
* @param charsetName a Charset or null.
- * @return the given {@code charset} or the default Charset if {@code charset} is null.
+ * @return The given {@code charset} or the default Charset if {@code charset} is null.
*/
static String toCharsetName(final String charsetName) {
return charsetName == null ? Charset.defaultCharset().name() : charsetName;
diff --git a/src/main/java/org/apache/commons/lang3/ClassLoaderUtils.java b/src/main/java/org/apache/commons/lang3/ClassLoaderUtils.java
index 9e53fef08..a970508da 100644
--- a/src/main/java/org/apache/commons/lang3/ClassLoaderUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassLoaderUtils.java
@@ -34,7 +34,7 @@ public class ClassLoaderUtils {
/**
* Gets the system class loader's URLs, if any.
*
- * @return the system class loader's URLs, if any.
+ * @return The system class loader's URLs, if any.
* @since 3.13.0
*/
public static URL[] getSystemURLs() {
@@ -44,7 +44,7 @@ public static URL[] getSystemURLs() {
/**
* Gets the current thread's context class loader's URLs, if any.
*
- * @return the current thread's context class loader's URLs, if any.
+ * @return The current thread's context class loader's URLs, if any.
* @since 3.13.0
*/
public static URL[] getThreadURLs() {
@@ -59,7 +59,7 @@ private static URL[] getURLs(final ClassLoader cl) {
* Converts the given class loader to a String calling {@link #toString(URLClassLoader)}.
*
* @param classLoader to URLClassLoader to convert.
- * @return the formatted string.
+ * @return The formatted string.
*/
public static String toString(final ClassLoader classLoader) {
if (classLoader instanceof URLClassLoader) {
@@ -72,7 +72,7 @@ public static String toString(final ClassLoader classLoader) {
* Converts the given URLClassLoader to a String in the format {@code "URLClassLoader.toString() + [URL1, URL2, ...]"}.
*
* @param classLoader to URLClassLoader to convert.
- * @return the formatted string.
+ * @return The formatted string.
*/
public static String toString(final URLClassLoader classLoader) {
return classLoader != null ? classLoader + Arrays.toString(classLoader.getURLs()) : "null";
diff --git a/src/main/java/org/apache/commons/lang3/ClassPathUtils.java b/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
index db7fbf385..6b77f69e3 100644
--- a/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassPathUtils.java
@@ -67,7 +67,7 @@ public static String pathToPackage(final String path) {
*
* @param context The context for constructing the name.
* @param resourceName the resource name to construct the fully qualified name for.
- * @return the fully qualified name of the resource with name {@code resourceName}.
+ * @return The fully qualified name of the resource with name {@code resourceName}.
* @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedName(final Class<?> context, final String resourceName) {
@@ -89,7 +89,7 @@ public static String toFullyQualifiedName(final Class<?> context, final String r
*
* @param context The context for constructing the name.
* @param resourceName the resource name to construct the fully qualified name for.
- * @return the fully qualified name of the resource with name {@code resourceName}.
+ * @return The fully qualified name of the resource with name {@code resourceName}.
* @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedName(final Package context, final String resourceName) {
@@ -111,7 +111,7 @@ public static String toFullyQualifiedName(final Package context, final String re
*
* @param context The context for constructing the path.
* @param resourceName the resource name to construct the fully qualified path for.
- * @return the fully qualified path of the resource with name {@code resourceName}.
+ * @return The fully qualified path of the resource with name {@code resourceName}.
* @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedPath(final Class<?> context, final String resourceName) {
@@ -133,7 +133,7 @@ public static String toFullyQualifiedPath(final Class<?> context, final String r
*
* @param context The context for constructing the path.
* @param resourceName the resource name to construct the fully qualified path for.
- * @return the fully qualified path of the resource with name {@code resourceName}.
+ * @return The fully qualified path of the resource with name {@code resourceName}.
* @throws NullPointerException if either {@code context} or {@code resourceName} is null.
*/
public static String toFullyQualifiedPath(final Package context, final String resourceName) {
diff --git a/src/main/java/org/apache/commons/lang3/ClassUtils.java b/src/main/java/org/apache/commons/lang3/ClassUtils.java
index c0ce2a726..3a22c7265 100644
--- a/src/main/java/org/apache/commons/lang3/ClassUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassUtils.java
@@ -186,7 +186,7 @@ public enum Interfaces {
/**
* Gets the class comparator, comparing by class name.
*
- * @return the class comparator.
+ * @return The class comparator.
* @since 3.13.0
*/
public static Comparator<Class<?>> comparator() {
@@ -240,7 +240,7 @@ public static List<Class<?>> convertClassNamesToClasses(final List<String> class
*
* @param cls the class to get the abbreviated name for, may be {@code null}.
* @param lengthHint the desired length of the abbreviated name.
- * @return the abbreviated name or an empty string.
+ * @return The abbreviated name or an empty string.
* @throws IllegalArgumentException if len <= 0.
* @see #getAbbreviatedName(String, int)
* @since 3.4
@@ -320,7 +320,7 @@ public static String getAbbreviatedName(final Class<?> cls, final int lengthHint
*
* @param className the className to get the abbreviated name for, may be {@code null}.
* @param lengthHint the desired length of the abbreviated name.
- * @return the abbreviated name or an empty string if the specified class name is {@code null} or empty string. The
+ * @return The abbreviated name or an empty string if the specified class name is {@code null} or empty string. The
* abbreviated name may be longer than the desired length if it cannot be abbreviated to the desired length.
* @throws IllegalArgumentException if {@code len <= 0}.
* @since 3.4
@@ -368,7 +368,7 @@ public static String getAbbreviatedName(final String className, final int length
* </p>
*
* @param cls the class to look up, may be {@code null}.
- * @return the {@link List} of interfaces in order, {@code null} if null input.
+ * @return The {@link List} of interfaces in order, {@code null} if null input.
*/
public static List<Class<?>> getAllInterfaces(final Class<?> cls) {
if (cls == null) {
@@ -405,7 +405,7 @@ private static void getAllInterfaces(Class<?> cls, final Set<Class<?>> interface
* </ol>
*
* @param cls the class to look up, may be {@code null}.
- * @return the {@link List} of superclasses in order going up from this one {@code null} if null input.
+ * @return The {@link List} of superclasses in order going up from this one {@code null} if null input.
*/
public static List<Class<?>> getAllSuperclasses(final Class<?> cls) {
if (cls == null) {
@@ -424,7 +424,7 @@ public static List<Class<?>> getAllSuperclasses(final Class<?> cls) {
* Gets the canonical class name for a {@link Class}.
*
* @param cls the class for which to get the canonical class name; may be null.
- * @return the canonical name of the class, or the empty String.
+ * @return The canonical name of the class, or the empty String.
* @since 3.7
* @see Class#getCanonicalName()
*/
@@ -437,7 +437,7 @@ public static String getCanonicalName(final Class<?> cls) {
*
* @param cls the class for which to get the canonical class name; may be null.
* @param valueIfNull the return value if null.
- * @return the canonical name of the class, or {@code valueIfNull}.
+ * @return The canonical name of the class, or {@code valueIfNull}.
* @since 3.7
* @see Class#getCanonicalName()
*/
@@ -453,7 +453,7 @@ public static String getCanonicalName(final Class<?> cls, final String valueIfNu
* Gets the canonical name for an {@link Object}.
*
* @param object the object for which to get the canonical class name; may be null.
- * @return the canonical name of the object, or the empty String.
+ * @return The canonical name of the object, or the empty String.
* @since 3.7
* @see Class#getCanonicalName()
*/
@@ -466,7 +466,7 @@ public static String getCanonicalName(final Object object) {
*
* @param object the object for which to get the canonical class name; may be null.
* @param valueIfNull the return value if null.
- * @return the canonical name of the object or {@code valueIfNull}.
+ * @return The canonical name of the object or {@code valueIfNull}.
* @since 3.7
* @see Class#getCanonicalName()
*/
@@ -552,7 +552,7 @@ private static String getCanonicalName(final String name) {
*
* @param classLoader the class loader to use to load the class.
* @param className the class name.
- * @return the class represented by {@code className} using the {@code classLoader}.
+ * @return The class represented by {@code className} using the {@code classLoader}.
* @throws NullPointerException if the className is null.
* @throws ClassNotFoundException if the class is not found.
* @throws IllegalArgumentException Thrown if the class name represents an array with more dimensions than the JVM supports, 255.
@@ -578,7 +578,7 @@ public static Class<?> getClass(final ClassLoader classLoader, final String clas
* @param classLoader the class loader to use to load the class.
* @param className the class name.
* @param initialize whether the class must be initialized.
- * @return the class represented by {@code className} using the {@code classLoader}.
+ * @return The class represented by {@code className} using the {@code classLoader}.
* @throws NullPointerException if the className is null.
* @throws ClassNotFoundException if the class is not found.
* @throws IllegalArgumentException Thrown if the class name represents an array with more dimensions than the JVM supports, 255.
@@ -616,7 +616,7 @@ public static Class<?> getClass(final ClassLoader classLoader, final String clas
* </p>
*
* @param className the class name
- * @return the class represented by {@code className} using the current thread's context class loader
+ * @return The class represented by {@code className} using the current thread's context class loader
* @throws NullPointerException if the className is null
* @throws ClassNotFoundException if the class is not found
* @throws IllegalArgumentException Thrown if the class name represents an array with more dimensions than the JVM supports, 255.
@@ -641,7 +641,7 @@ public static Class<?> getClass(final String className) throws ClassNotFoundExce
*
* @param className the class name.
* @param initialize whether the class must be initialized.
- * @return the class represented by {@code className} using the current thread's context class loader.
+ * @return The class represented by {@code className} using the current thread's context class loader.
* @throws NullPointerException if the className is null.
* @throws ClassNotFoundException if the class is not found.
* @throws IllegalArgumentException Thrown if the class name represents an array with more dimensions than the JVM supports, 255.
@@ -675,7 +675,7 @@ public static <T> Class<T> getComponentType(final Class<T[]> cls) {
* Null-safe version of {@code cls.getName()}
*
* @param cls the class for which to get the class name; may be null.
- * @return the class name or the empty string in case the argument is {@code null}.
+ * @return The class name or the empty string in case the argument is {@code null}.
* @since 3.7
* @see Class#getSimpleName()
*/
@@ -688,7 +688,7 @@ public static String getName(final Class<?> cls) {
*
* @param cls the class for which to get the class name; may be null.
* @param valueIfNull the return value if the argument {@code cls} is {@code null}.
- * @return the class name or {@code valueIfNull}
+ * @return The class name or {@code valueIfNull}
* @since 3.7
* @see Class#getName()
*/
@@ -704,7 +704,7 @@ static String getName(final Class<?> cls, final String valueIfNull, final boolea
* Null-safe version of {@code object.getClass().getName()}
*
* @param object the object for which to get the class name; may be null.
- * @return the class name or the empty String.
+ * @return The class name or the empty String.
* @since 3.7
* @see Class#getSimpleName()
*/
@@ -717,7 +717,7 @@ public static String getName(final Object object) {
*
* @param object the object for which to get the class name; may be null.
* @param valueIfNull the value to return if {@code object} is {@code null}.
- * @return the class name or {@code valueIfNull}.
+ * @return The class name or {@code valueIfNull}.
* @since 3.0
* @see Class#getName()
*/
@@ -729,7 +729,7 @@ public static String getName(final Object object, final String valueIfNull) {
* Gets the package name from the canonical name of a {@link Class}.
*
* @param cls the class to get the package name for, may be {@code null}.
- * @return the package name or an empty string.
+ * @return The package name or an empty string.
* @since 2.4
*/
public static String getPackageCanonicalName(final Class<?> cls) {
@@ -744,7 +744,7 @@ public static String getPackageCanonicalName(final Class<?> cls) {
*
* @param object the class to get the package name for, may be null.
* @param valueIfNull the value to return if null.
- * @return the package name of the object, or the null value.
+ * @return The package name of the object, or the null value.
* @since 2.4
*/
public static String getPackageCanonicalName(final Object object, final String valueIfNull) {
@@ -765,7 +765,7 @@ public static String getPackageCanonicalName(final Object object, final String v
* </p>
*
* @param name the name to get the package name for, may be {@code null}.
- * @return the package name or an empty string.
+ * @return The package name or an empty string.
* @since 2.4
*/
public static String getPackageCanonicalName(final String name) {
@@ -776,7 +776,7 @@ public static String getPackageCanonicalName(final String name) {
* Gets the package name of a {@link Class}.
*
* @param cls the class to get the package name for, may be {@code null}.
- * @return the package name or an empty string
+ * @return The package name or an empty string
*/
public static String getPackageName(final Class<?> cls) {
if (cls == null) {
@@ -790,7 +790,7 @@ public static String getPackageName(final Class<?> cls) {
*
* @param object the class to get the package name for, may be null.
* @param valueIfNull the value to return if null.
- * @return the package name of the object, or the null value.
+ * @return The package name of the object, or the null value.
*/
public static String getPackageName(final Object object, final String valueIfNull) {
if (object == null) {
@@ -810,7 +810,7 @@ public static String getPackageName(final Object object, final String valueIfNul
* </p>
*
* @param className the className to get the package name for, may be {@code null}.
- * @return the package name or an empty string.
+ * @return The package name or an empty string.
*/
public static String getPackageName(String className) {
if (StringUtils.isEmpty(className)) {
@@ -837,7 +837,7 @@ public static String getPackageName(String className) {
* Gets the primitive class for the given class name, for example "byte".
*
* @param className the primitive class for the given class name.
- * @return the primitive class.
+ * @return The primitive class.
*/
static Class<?> getPrimitiveClass(final String className) {
return NAME_PRIMITIVE_MAP.get(className);
@@ -857,7 +857,7 @@ static Class<?> getPrimitiveClass(final String className) {
* @param cls the class to check, not null.
* @param methodName the name of the method.
* @param parameterTypes the list of parameters.
- * @return the method.
+ * @return The method.
* @throws NullPointerException if the class is null.
* @throws SecurityException if a security violation occurred.
* @throws NoSuchMethodException if the method is not found in the given class or if the method doesn't conform with the
@@ -891,7 +891,7 @@ public static Method getPublicMethod(final Class<?> cls, final String methodName
* Gets the canonical name minus the package name from a {@link Class}.
*
* @param cls the class for which to get the short canonical class name; may be null.
- * @return the canonical name without the package name or an empty string.
+ * @return The canonical name without the package name or an empty string.
* @since 2.4
* @see Class#getCanonicalName()
*/
@@ -904,7 +904,7 @@ public static String getShortCanonicalName(final Class<?> cls) {
*
* @param object the class to get the short name for, may be null.
* @param valueIfNull the value to return if null.
- * @return the canonical name of the object without the package name, or the null value.
+ * @return The canonical name of the object without the package name, or the null value.
* @since 2.4
* @see Class#getCanonicalName()
*/
@@ -1003,7 +1003,7 @@ public static String getShortCanonicalName(final Object object, final String val
* </table>
*
* @param canonicalName the class name to get the short name for.
- * @return the canonical name of the class without the package name or an empty string.
+ * @return The canonical name of the class without the package name or an empty string.
* @since 2.4
*/
public static String getShortCanonicalName(final String canonicalName) {
@@ -1014,7 +1014,7 @@ public static String getShortCanonicalName(final String canonicalName) {
* Gets the class name minus the package name from a {@link Class}.
*
* @param cls the class to get the short name for.
- * @return the class name without the package name or an empty string. If the class is an inner class then the returned
+ * @return The class name without the package name or an empty string. If the class is an inner class then the returned
* value will contain the outer class or classes separated with {@code .} (dot) character.
*/
public static String getShortClassName(final Class<?> cls) {
@@ -1055,7 +1055,7 @@ public static String getShortClassName(final Class<?> cls) {
*
* @param object the class to get the short name for, may be {@code null}.
* @param valueIfNull the value to return if the object is {@code null}.
- * @return the class name of the object without the package name, or {@code valueIfNull} if the argument {@code object}
+ * @return The class name of the object without the package name, or {@code valueIfNull} if the argument {@code object}
* is {@code null}.
*/
public static String getShortClassName(final Object object, final String valueIfNull) {
@@ -1093,7 +1093,7 @@ public static String getShortClassName(final Object object, final String valueIf
*
* @param className the className to get the short name for. It has to be formatted as returned by
* {@code Class.getName()} and not {@code Class.getCanonicalName()}.
- * @return the class name of the class without the package name or an empty string. If the class is an inner class then
+ * @return The class name of the class without the package name or an empty string. If the class is an inner class then
* value contains the outer class or classes and the separator is replaced to be {@code .} (dot) character.
*/
public static String getShortClassName(String className) {
@@ -1128,7 +1128,7 @@ public static String getShortClassName(String className) {
* Null-safe version of {@code cls.getSimpleName()}
*
* @param cls the class for which to get the simple name; may be null.
- * @return the simple class name or the empty string in case the argument is {@code null}.
+ * @return The simple class name or the empty string in case the argument is {@code null}.
* @since 3.0
* @see Class#getSimpleName()
*/
@@ -1141,7 +1141,7 @@ public static String getSimpleName(final Class<?> cls) {
*
* @param cls the class for which to get the simple name; may be null.
* @param valueIfNull the value to return if null.
- * @return the simple class name or {@code valueIfNull} if the argument {@code cls} is {@code null}.
+ * @return The simple class name or {@code valueIfNull} if the argument {@code cls} is {@code null}.
* @since 3.0
* @see Class#getSimpleName()
*/
@@ -1161,7 +1161,7 @@ public static String getSimpleName(final Class<?> cls, final String valueIfNull)
* </p>
*
* @param object the object for which to get the simple class name; may be null.
- * @return the simple class name or the empty string in case the argument is {@code null}.
+ * @return The simple class name or the empty string in case the argument is {@code null}.
* @since 3.7
* @see Class#getSimpleName()
*/
@@ -1174,7 +1174,7 @@ public static String getSimpleName(final Object object) {
*
* @param object the object for which to get the simple class name; may be null.
* @param valueIfNull the value to return if {@code object} is {@code null}.
- * @return the simple class name or {@code valueIfNull} if the argument {@code object} is {@code null}.
+ * @return The simple class name or {@code valueIfNull} if the argument {@code object} is {@code null}.
* @since 3.0
* @see Class#getSimpleName()
*/
@@ -1566,7 +1566,7 @@ public static Class<?>[] primitivesToWrappers(final Class<?>... classes) {
* </p>
*
* @param cls the class to convert, may be null.
- * @return the wrapper class for {@code cls} or {@code cls} if {@code cls} is not a primitive. {@code null} if null input.
+ * @return The wrapper class for {@code cls} or {@code cls} if {@code cls} is not a primitive. {@code null} if null input.
* @since 2.1
*/
public static Class<?> primitiveToWrapper(final Class<?> cls) {
@@ -1603,7 +1603,7 @@ public static Class<?>[] toClass(final Object... array) {
* </p>
*
* @param className the class name.
- * @return the converted name.
+ * @return The converted name.
* @throws NullPointerException if the className is null.
* @throws IllegalArgumentException Thrown if the class name represents an array with more dimensions than the JVM supports, 255.
* @throws IllegalArgumentException Thrown if the class name length is greater than 65,535.
@@ -1724,7 +1724,7 @@ public static Class<?>[] wrappersToPrimitives(final Class<?>... classes) {
* </p>
*
* @param cls the class to convert, may be {@code null}.
- * @return the corresponding primitive type if {@code cls} is a wrapper class, {@code null} otherwise.
+ * @return The corresponding primitive type if {@code cls} is a wrapper class, {@code null} otherwise.
* @see #primitiveToWrapper(Class)
* @since 2.4
*/
diff --git a/src/main/java/org/apache/commons/lang3/DoubleRange.java b/src/main/java/org/apache/commons/lang3/DoubleRange.java
index 060f4116e..d3112c195 100644
--- a/src/main/java/org/apache/commons/lang3/DoubleRange.java
+++ b/src/main/java/org/apache/commons/lang3/DoubleRange.java
@@ -43,7 +43,7 @@ public final class DoubleRange extends NumberRange<Double> {
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
*/
public static DoubleRange of(final double fromInclusive, final double toInclusive) {
return of(Double.valueOf(fromInclusive), Double.valueOf(toInclusive));
@@ -62,7 +62,7 @@ public static DoubleRange of(final double fromInclusive, final double toInclusiv
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if either element is null.
*/
public static DoubleRange of(final Double fromInclusive, final Double toInclusive) {
@@ -99,7 +99,7 @@ private DoubleRange(final Double number1, final Double number2) {
* }</pre>
*
* @param element the element to test.
- * @return the minimum, the element, or the maximum depending on the element's location relative to the range.
+ * @return The minimum, the element, or the maximum depending on the element's location relative to the range.
* @since 3.19.0
*/
public double fit(final double element) {
diff --git a/src/main/java/org/apache/commons/lang3/EnumUtils.java b/src/main/java/org/apache/commons/lang3/EnumUtils.java
index 710363780..f854398c8 100644
--- a/src/main/java/org/apache/commons/lang3/EnumUtils.java
+++ b/src/main/java/org/apache/commons/lang3/EnumUtils.java
@@ -197,7 +197,7 @@ public static <E extends Enum<E>> long[] generateBitVectors(final Class<E> enumC
* @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
* @param enumName the enum name, null returns null.
- * @return the enum, null if not found.
+ * @return The enum, null if not found.
*/
public static <E extends Enum<E>> E getEnum(final Class<E> enumClass, final String enumName) {
return getEnum(enumClass, enumName, null);
@@ -213,7 +213,7 @@ public static <E extends Enum<E>> E getEnum(final Class<E> enumClass, final Stri
* @param enumClass the class of the enum to query, null returns default enum.
* @param enumName the enum name, null returns default enum.
* @param defaultEnum the default enum.
- * @return the enum, default enum if not found.
+ * @return The enum, default enum if not found.
* @since 3.10
*/
public static <E extends Enum<E>> E getEnum(final Class<E> enumClass, final String enumName, final E defaultEnum) {
@@ -236,7 +236,7 @@ public static <E extends Enum<E>> E getEnum(final Class<E> enumClass, final Stri
* @param <E> the type of the enumeration.
* @param enumClass the class of the enum to query, may be null.
* @param enumName the enum name, null returns null.
- * @return the enum, null if not found.
+ * @return The enum, null if not found.
* @since 3.8
*/
public static <E extends Enum<E>> E getEnumIgnoreCase(final Class<E> enumClass, final String enumName) {
@@ -253,7 +253,7 @@ public static <E extends Enum<E>> E getEnumIgnoreCase(final Class<E> enumClass,
* @param enumClass the class of the enum to query, null returns default enum.
* @param enumName the enum name, null returns default enum.
* @param defaultEnum the default enum.
- * @return the enum, default enum if not found.
+ * @return The enum, default enum if not found.
* @since 3.10
*/
public static <E extends Enum<E>> E getEnumIgnoreCase(final Class<E> enumClass, final String enumName,
@@ -268,7 +268,7 @@ public static <E extends Enum<E>> E getEnumIgnoreCase(final Class<E> enumClass,
*
* @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
- * @return the modifiable list of enums, never null.
+ * @return The modifiable list of enums, never null.
*/
public static <E extends Enum<E>> List<E> getEnumList(final Class<E> enumClass) {
return new ArrayList<>(Arrays.asList(enumClass.getEnumConstants()));
@@ -281,7 +281,7 @@ public static <E extends Enum<E>> List<E> getEnumList(final Class<E> enumClass)
*
* @param <E> The type of the enumeration.
* @param enumClass the class of the enum to query, not null.
- * @return the modifiable map of enum names to enums, never null.
+ * @return The modifiable map of enum names to enums, never null.
*/
public static <E extends Enum<E>> Map<String, E> getEnumMap(final Class<E> enumClass) {
return getEnumMap(enumClass, E::name);
@@ -298,7 +298,7 @@ public static <E extends Enum<E>> Map<String, E> getEnumMap(final Class<E> enumC
* @param <K> the type of the map key.
* @param enumClass the class of the enum to query, not null.
* @param keyFunction the function to query for the key, not null.
- * @return the modifiable map of enums, never null.
+ * @return The modifiable map of enums, never null.
* @since 3.13.0
*/
public static <E extends Enum<E>, K> Map<K, E> getEnumMap(final Class<E> enumClass, final Function<E, K> keyFunction) {
@@ -319,7 +319,7 @@ public static <E extends Enum<E>, K> Map<K, E> getEnumMap(final Class<E> enumCla
* @param enumClass the class of the enum to query, not null.
* @param propName the system property key for the enum name, null returns default enum.
* @param defaultEnum the default enum.
- * @return the enum, default enum if not found.
+ * @return The enum, default enum if not found.
* @since 3.13.0
*/
public static <E extends Enum<E>> E getEnumSystemProperty(final Class<E> enumClass, final String propName, final E defaultEnum) {
@@ -459,7 +459,7 @@ public static <E extends Enum<E>> EnumSet<E> processBitVectors(final Class<E> en
*
* @param <T> the type of stream elements.
* @param clazz the class containing the enum values, may be null.
- * @return the new stream, empty of {@code clazz} is null.
+ * @return The new stream, empty of {@code clazz} is null.
* @since 3.18.0
* @see Class#getEnumConstants()
*/
diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java
index ae14bcea5..854cf5802 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -119,7 +119,7 @@ public interface FailableBiFunction<O1, O2, R, T extends Throwable> {
*
* @param input1 the first input for the function
* @param input2 the second input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws T Thrown when the function fails.
*/
R apply(O1 input1, O2 input2) throws T;
@@ -144,7 +144,7 @@ public interface FailableBiPredicate<O1, O2, T extends Throwable> {
*
* @param object1 the first object to test the predicate on
* @param object2 the second object to test the predicate on
- * @return the predicate's evaluation
+ * @return The predicate's evaluation
* @throws T if the predicate fails
*/
boolean test(O1 object1, O2 object2) throws T;
@@ -212,7 +212,7 @@ public interface FailableFunction<I, R, T extends Throwable> {
* Applies this function.
*
* @param input the input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws T Thrown when the function fails.
*/
R apply(I input) throws T;
@@ -235,7 +235,7 @@ public interface FailablePredicate<I, T extends Throwable> {
* Tests the predicate.
*
* @param object the object to test the predicate on
- * @return the predicate's evaluation
+ * @return The predicate's evaluation
* @throws T if the predicate fails
*/
boolean test(I object) throws T;
@@ -320,7 +320,7 @@ public static <O, T extends Throwable> void accept(final FailableConsumer<O, T>
* @param <O2> the type of the second argument the function accepts
* @param <O> The return type of the function
* @param <T> The type of checked exception the function may throw
- * @return the value returned from the function
+ * @return The value returned from the function
*/
public static <O1, O2, O, T extends Throwable> O apply(final FailableBiFunction<O1, O2, O, T> function,
final O1 input1, final O2 input2) {
@@ -335,7 +335,7 @@ public static <O1, O2, O, T extends Throwable> O apply(final FailableBiFunction<
* @param <I> The type of the argument the function accepts
* @param <O> The return type of the function
* @param <T> The type of checked exception the function may throw
- * @return the value returned from the function
+ * @return The value returned from the function
*/
public static <I, O, T extends Throwable> O apply(final FailableFunction<I, O, T> function, final I input) {
return get(() -> function.apply(input));
@@ -459,7 +459,7 @@ public static <O> Supplier<O> asSupplier(final FailableSupplier<O, ?> supplier)
* @param callable the callable to call
* @param <O> The return type of the callable
* @param <T> The type of checked exception the callable may throw
- * @return the value returned from the callable
+ * @return The value returned from the callable
*/
public static <O, T extends Throwable> O call(final FailableCallable<O, T> callable) {
return get(callable::call);
@@ -584,7 +584,7 @@ public static <O> FailableStream<O> stream(final Stream<O> stream) {
* @param <O1> the type of the first argument the predicate tests
* @param <O2> the type of the second argument the predicate tests
* @param <T> The type of checked exception the predicate may throw
- * @return the boolean value returned by the predicate
+ * @return The boolean value returned by the predicate
*/
public static <O1, O2, T extends Throwable> boolean test(final FailableBiPredicate<O1, O2, T> predicate,
final O1 object1, final O2 object2) {
@@ -598,7 +598,7 @@ public static <O1, O2, T extends Throwable> boolean test(final FailableBiPredica
* @param object the input to test by {@code predicate}
* @param <O> The type of argument the predicate tests
* @param <T> The type of checked exception the predicate may throw
- * @return the boolean value returned by the predicate
+ * @return The boolean value returned by the predicate
*/
public static <O, T extends Throwable> boolean test(final FailablePredicate<O, T> predicate, final O object) {
return getAsBoolean(() -> predicate.test(object));
diff --git a/src/main/java/org/apache/commons/lang3/IntegerRange.java b/src/main/java/org/apache/commons/lang3/IntegerRange.java
index 69dc1a584..8c2a667bf 100644
--- a/src/main/java/org/apache/commons/lang3/IntegerRange.java
+++ b/src/main/java/org/apache/commons/lang3/IntegerRange.java
@@ -45,7 +45,7 @@ public final class IntegerRange extends NumberRange<Integer> {
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
*/
public static IntegerRange of(final int fromInclusive, final int toInclusive) {
return of(Integer.valueOf(fromInclusive), Integer.valueOf(toInclusive));
@@ -64,7 +64,7 @@ public static IntegerRange of(final int fromInclusive, final int toInclusive) {
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if either element is null.
*/
public static IntegerRange of(final Integer fromInclusive, final Integer toInclusive) {
@@ -101,7 +101,7 @@ private IntegerRange(final Integer number1, final Integer number2) {
* }</pre>
*
* @param element the element to test.
- * @return the minimum, the element, or the maximum depending on the element's location relative to the range.
+ * @return The minimum, the element, or the maximum depending on the element's location relative to the range.
* @since 3.19.0
*/
public int fit(final int element) {
diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java b/src/main/java/org/apache/commons/lang3/JavaVersion.java
index 3939563dc..df45bc5cd 100644
--- a/src/main/java/org/apache/commons/lang3/JavaVersion.java
+++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java
@@ -221,7 +221,7 @@ public enum JavaVersion {
* Transforms the given string with a Java version number to the corresponding constant of this enumeration class. This method is used internally.
*
* @param versionStr the Java version as string.
- * @return the corresponding enumeration constant or {@code null} if the version is unknown.
+ * @return The corresponding enumeration constant or {@code null} if the version is unknown.
*/
static JavaVersion get(final String versionStr) {
if (versionStr == null) {
@@ -303,7 +303,7 @@ static JavaVersion get(final String versionStr) {
* Transforms the given string with a Java version number to the corresponding constant of this enumeration class. This method is used internally.
*
* @param versionStr the Java version as string.
- * @return the corresponding enumeration constant or {@code null} if the version is unknown.
+ * @return The corresponding enumeration constant or {@code null} if the version is unknown.
*/
static JavaVersion getJavaVersion(final String versionStr) {
return get(versionStr);
@@ -312,7 +312,7 @@ static JavaVersion getJavaVersion(final String versionStr) {
/**
* Gets the Java Version from the system or 99.0 if the {@code java.specification.version} system property is not set.
*
- * @return the value of {@code java.specification.version} system property or 99.0 if it is not set.
+ * @return The value of {@code java.specification.version} system property or 99.0 if it is not set.
*/
private static float maxVersion() {
final float v = toFloatVersion(SystemProperties.getJavaSpecificationVersion("99.0"));
@@ -327,7 +327,7 @@ static String[] split(final String value) {
* Parses a float value from a String.
*
* @param value the String to parse.
- * @return the float value represented by the string or -1 if the given String cannot be parsed.
+ * @return The float value represented by the string or -1 if the given String cannot be parsed.
*/
private static float toFloatVersion(final String value) {
final int defaultReturnValue = -1;
@@ -408,7 +408,7 @@ public boolean atMost(final JavaVersion requiredVersion) {
* For example, {@code "1.5"}.
* </p>
*
- * @return the name, not null.
+ * @return The name, not null.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/LocaleUtils.java b/src/main/java/org/apache/commons/lang3/LocaleUtils.java
index 4a5821dad..622576da2 100644
--- a/src/main/java/org/apache/commons/lang3/LocaleUtils.java
+++ b/src/main/java/org/apache/commons/lang3/LocaleUtils.java
@@ -98,7 +98,7 @@ private static final class SyncAvoid {
* called.
* </p>
*
- * @return the unmodifiable and sorted list of available locales.
+ * @return The unmodifiable and sorted list of available locales.
*/
public static List<Locale> availableLocaleList() {
return SyncAvoid.AVAILABLE_LOCALE_ULIST;
@@ -116,7 +116,7 @@ private static List<Locale> availableLocaleList(final Predicate<Locale> predicat
* called.
* </p>
*
- * @return the unmodifiable set of available locales.
+ * @return The unmodifiable set of available locales.
*/
public static Set<Locale> availableLocaleSet() {
return SyncAvoid.AVAILABLE_LOCALE_USET;
@@ -263,7 +263,7 @@ public static List<Locale> languagesByCountry(final String countryCode) {
* </pre>
*
* @param locale the locale to start from.
- * @return the unmodifiable list of Locale objects, 0 being locale, not null.
+ * @return The unmodifiable list of Locale objects, 0 being locale, not null.
*/
public static List<Locale> localeLookupList(final Locale locale) {
return localeLookupList(locale, locale);
@@ -284,7 +284,7 @@ public static List<Locale> localeLookupList(final Locale locale) {
*
* @param locale the locale to start from, null returns empty list.
* @param defaultLocale the default locale to use if no other is found.
- * @return the unmodifiable list of Locale objects, 0 being locale, not null.
+ * @return The unmodifiable list of Locale objects, 0 being locale, not null.
*/
public static List<Locale> localeLookupList(final Locale locale, final Locale defaultLocale) {
final List<Locale> list = new ArrayList<>(4);
@@ -366,7 +366,7 @@ private static Locale parseLocale(final String str) {
* Returns the given locale if non-{@code null}, otherwise {@link Locale#getDefault()}.
*
* @param locale a locale or {@code null}.
- * @return the given locale if non-{@code null}, otherwise {@link Locale#getDefault()}.
+ * @return The given locale if non-{@code null}, otherwise {@link Locale#getDefault()}.
* @since 3.12.0
*/
public static Locale toLocale(final Locale locale) {
diff --git a/src/main/java/org/apache/commons/lang3/LongRange.java b/src/main/java/org/apache/commons/lang3/LongRange.java
index 88f3ee535..f10e932e6 100644
--- a/src/main/java/org/apache/commons/lang3/LongRange.java
+++ b/src/main/java/org/apache/commons/lang3/LongRange.java
@@ -45,7 +45,7 @@ public final class LongRange extends NumberRange<Long> {
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
*/
public static LongRange of(final long fromInclusive, final long toInclusive) {
return of(Long.valueOf(fromInclusive), Long.valueOf(toInclusive));
@@ -64,7 +64,7 @@ public static LongRange of(final long fromInclusive, final long toInclusive) {
*
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if either element is null.
*/
public static LongRange of(final Long fromInclusive, final Long toInclusive) {
@@ -101,7 +101,7 @@ private LongRange(final Long number1, final Long number2) {
* }</pre>
*
* @param element the element to test.
- * @return the minimum, the element, or the maximum depending on the element's location relative to the range.
+ * @return The minimum, the element, or the maximum depending on the element's location relative to the range.
* @since 3.19.0
*/
public long fit(final long element) {
diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
index f4b9f67bb..c5f91ae98 100644
--- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java
@@ -91,7 +91,7 @@ public static class Null implements Serializable {
/**
* Ensures singleton after serialization.
*
- * @return the singleton value.
+ * @return The singleton value.
*/
private Object readResolve() {
return NULL;
@@ -225,7 +225,7 @@ public static boolean anyNull(final Object... values) {
*
* @param <T> The type of the object.
* @param obj the object to clone, null returns null.
- * @return the clone if the object implements {@link Cloneable} otherwise {@code null}.
+ * @return The clone if the object implements {@link Cloneable} otherwise {@code null}.
* @throws CloneFailedException if the object is cloneable and the clone operation fails.
* @since 3.0
*/
@@ -268,7 +268,7 @@ public static <T> T clone(final T obj) {
*
* @param <T> The type of the object.
* @param obj the object to clone, null returns null.
- * @return the clone if the object implements {@link Cloneable} otherwise the object itself.
+ * @return The clone if the object implements {@link Cloneable} otherwise the object itself.
* @throws CloneFailedException if the object is cloneable and the clone operation fails.
* @since 3.0
*/
@@ -329,7 +329,7 @@ public static <T extends Comparable<? super T>> int compare(final T c1, final T
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the boolean value to return.
- * @return the boolean v, unchanged.
+ * @return The boolean v, unchanged.
* @since 3.2
*/
public static boolean CONST(final boolean v) {
@@ -346,7 +346,7 @@ public static boolean CONST(final boolean v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the byte value to return.
- * @return the byte v, unchanged.
+ * @return The byte v, unchanged.
* @since 3.2
*/
public static byte CONST(final byte v) {
@@ -363,7 +363,7 @@ public static byte CONST(final byte v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the char value to return.
- * @return the char v, unchanged.
+ * @return The char v, unchanged.
* @since 3.2
*/
public static char CONST(final char v) {
@@ -380,7 +380,7 @@ public static char CONST(final char v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the double value to return.
- * @return the double v, unchanged.
+ * @return The double v, unchanged.
* @since 3.2
*/
public static double CONST(final double v) {
@@ -397,7 +397,7 @@ public static double CONST(final double v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the float value to return.
- * @return the float v, unchanged.
+ * @return The float v, unchanged.
* @since 3.2
*/
public static float CONST(final float v) {
@@ -414,7 +414,7 @@ public static float CONST(final float v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the int value to return.
- * @return the int v, unchanged.
+ * @return The int v, unchanged.
* @since 3.2
*/
public static int CONST(final int v) {
@@ -431,7 +431,7 @@ public static int CONST(final int v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the long value to return.
- * @return the long v, unchanged.
+ * @return The long v, unchanged.
* @since 3.2
*/
public static long CONST(final long v) {
@@ -448,7 +448,7 @@ public static long CONST(final long v) {
* This way any jars that refer to this field do not have to recompile themselves if the field's value changes at some future date.
*
* @param v the short value to return.
- * @return the short v, unchanged.
+ * @return The short v, unchanged.
* @since 3.2
*/
public static short CONST(final short v) {
@@ -466,7 +466,7 @@ public static short CONST(final short v) {
*
* @param <T> The Object type.
* @param v the genericized Object value to return (typically a String).
- * @return the genericized Object v, unchanged (typically a String).
+ * @return The genericized Object v, unchanged (typically a String).
* @since 3.2
*/
public static <T> T CONST(final T v) {
@@ -484,7 +484,7 @@ public static <T> T CONST(final T v) {
*
* @param v the byte literal (as an int) value to return.
* @throws IllegalArgumentException if the value passed to v is larger than a byte, that is, smaller than -128 or larger than 127.
- * @return the byte v, unchanged.
+ * @return The byte v, unchanged.
* @since 3.2
*/
public static byte CONST_BYTE(final int v) {
@@ -505,7 +505,7 @@ public static byte CONST_BYTE(final int v) {
*
* @param v the short literal (as an int) value to return.
* @throws IllegalArgumentException if the value passed to v is larger than a short, that is, smaller than -32768 or larger than 32767.
- * @return the byte v, unchanged.
+ * @return The byte v, unchanged.
* @since 3.2
*/
public static short CONST_SHORT(final int v) {
@@ -583,7 +583,7 @@ public static boolean equals(final Object object1, final Object object2) {
*
* @param <T> The component type of the array.
* @param values the values to test, may be {@code null} or empty.
- * @return the first value from {@code values} which is not {@code null},
+ * @return The first value from {@code values} which is not {@code null},
* or {@code null} if there are no non-null values.
* @since 3.0
*/
@@ -624,7 +624,7 @@ public static <T> Class<T> getClass(final T object) {
* @param <T> the type of the return values.
* @param suppliers the suppliers returning the values to test. {@code null} values are ignored. Suppliers may return {@code null} or a value of type
* {@code T}.
- * @return the first return value from {@code suppliers} which is not {@code null}, or {@code null} if there are no non-null values.
+ * @return The first return value from {@code suppliers} which is not {@code null}, or {@code null} if there are no non-null values.
* @see Consumers#accept(Consumer, Object)
* @see Suppliers#get(Supplier)
* @since 3.10
@@ -703,7 +703,7 @@ public static <T> T getIfNull(final T object, final T defaultValue) {
* </pre>
*
* @param obj the object to obtain the hash code of, may be {@code null}.
- * @return the hash code of the object, or zero if null.
+ * @return The hash code of the object, or zero if null.
* @since 2.1
* @deprecated Replaced by {@code java.util.Objects.hashCode(Object)} in Java 7 and will be removed in future releases.
*/
@@ -744,7 +744,7 @@ public static String hashCodeHex(final Object object) {
* </pre>
*
* @param objects the objects to obtain the hash code of, may be {@code null}.
- * @return the hash code of the objects, or zero if null.
+ * @return The hash code of the objects, or zero if null.
* @since 3.0
* @deprecated Replaced by {@code java.util.Objects.hash(Object...)} in Java 7 and will be removed in future releases.
*/
@@ -807,7 +807,7 @@ public static void identityToString(final Appendable appendable, final Object ob
* </pre>
*
* @param object the object to create a toString for, may be {@code null}.
- * @return the default toString text, or {@code null} if {@code null} passed in.
+ * @return The default toString text, or {@code null} if {@code null} passed in.
*/
public static String identityToString(final Object object) {
if (object == null) {
@@ -1225,7 +1225,7 @@ public static <T> T requireNonEmpty(final T obj, final String message) {
* </pre>
*
* @param obj the Object to {@code toString()}, may be {@code null}.
- * @return the input's {@code toString()}, or {@code ""} if the input is {@code null}.
+ * @return The input's {@code toString()}, or {@code ""} if the input is {@code null}.
* @see Objects#toString(Object)
* @see Objects#toString(Object, String)
* @see StringUtils#defaultString(String)
@@ -1250,7 +1250,7 @@ public static String toString(final Object obj) {
*
* @param obj the Object to {@code toString}, may be null.
* @param nullStr the String to return if {@code null} input, may be null.
- * @return the passed in Object's toString, or {@code nullStr} if {@code null} input.
+ * @return The passed in Object's toString, or {@code nullStr} if {@code null} input.
* @see Objects#toString(Object)
* @see Objects#toString(Object, String)
* @see StringUtils#defaultString(String,String)
@@ -1281,7 +1281,7 @@ public static String toString(final Object obj, final String nullStr) {
*
* @param obj the Object to {@code toString}, may be null.
* @param supplier the Supplier of String used on {@code null} input, may be null.
- * @return the passed in Object's toString, or {@code nullStr} if {@code null} input.
+ * @return The passed in Object's toString, or {@code nullStr} if {@code null} input.
* @since 3.14.0
*/
public static String toString(final Supplier<Object> obj, final Supplier<String> supplier) {
@@ -1306,7 +1306,7 @@ public static String toString(final Supplier<Object> obj, final Supplier<String>
* @param <T> The obj type (used to provide better source compatibility in 3.14.0).
* @param obj the Object to {@code toString}, may be null.
* @param supplier the Supplier of String used on {@code null} input, may be null.
- * @return the passed in Object's toString, or {@code nullStr} if {@code null} input.
+ * @return The passed in Object's toString, or {@code nullStr} if {@code null} input.
* @since 3.11
*/
public static <T> String toString(final T obj, final Supplier<String> supplier) {
diff --git a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
index ba2129e40..27770400e 100644
--- a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java
@@ -109,7 +109,7 @@ public class RandomStringUtils {
* The method {@link ThreadLocalRandom#current()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link ThreadLocalRandom#current()}.
+ * @return The singleton instance based on {@link ThreadLocalRandom#current()}.
* @see ThreadLocalRandom#current()
* @see #secure()
* @see #secureStrong()
@@ -127,7 +127,7 @@ public static RandomStringUtils insecure() {
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #next(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -146,7 +146,7 @@ public static String random(final int count) {
* @param count the length of random string to create.
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #next(int, boolean, boolean)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -164,7 +164,7 @@ public static String random(final int count, final boolean letters, final boolea
*
* @param count the length of random string to create.
* @param chars the character array containing the set of characters to use, may be null.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #next(int, char...)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -185,7 +185,7 @@ public static String random(final int count, final char... chars) {
* @param end the position in set of chars to end before.
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #next(int, int, int, boolean, boolean)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -210,7 +210,7 @@ public static String random(final int count, final int start, final int end, fin
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
* @param chars the set of chars to choose randoms from. If {@code null}, then it will use the set of all chars.
- * @return the random string.
+ * @return The random string.
* @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #next(int, int, int, boolean, boolean, char...)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -247,7 +247,7 @@ public static String random(final int count, final int start, final int end, fin
* @param chars the set of chars to choose randoms from, must not be empty. If {@code null}, then it will use the
* set of all chars.
* @param random a source of randomness.
- * @return the random string.
+ * @return The random string.
* @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.
* @throws IllegalArgumentException if {@code count} < 0 or the provided chars array is empty.
* @since 2.0
@@ -465,7 +465,7 @@ public static String random(int count, int start, int end, final boolean letters
*
* @param count the length of random string to create.
* @param chars the String containing the set of characters to use, may be null, but must not be empty.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0 or the string is empty.
* @deprecated Use {@link #next(int, String)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -482,7 +482,7 @@ public static String random(final int count, final String chars) {
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #nextAlphabetic(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -500,7 +500,7 @@ public static String randomAlphabetic(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextAlphabetic(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -517,7 +517,7 @@ public static String randomAlphabetic(final int minLengthInclusive, final int ma
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #nextAlphanumeric(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -535,7 +535,7 @@ public static String randomAlphanumeric(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextAlphanumeric(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -553,7 +553,7 @@ public static String randomAlphanumeric(final int minLengthInclusive, final int
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #nextAscii(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -572,7 +572,7 @@ public static String randomAscii(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextAscii(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -590,7 +590,7 @@ public static String randomAscii(final int minLengthInclusive, final int maxLeng
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.5
* @deprecated Use {@link #nextGraph(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -609,7 +609,7 @@ public static String randomGraph(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextGraph(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -626,7 +626,7 @@ public static String randomGraph(final int minLengthInclusive, final int maxLeng
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @deprecated Use {@link #nextNumeric(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -644,7 +644,7 @@ public static String randomNumeric(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextNumeric(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -662,7 +662,7 @@ public static String randomNumeric(final int minLengthInclusive, final int maxLe
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.5
* @deprecated Use {@link #nextPrint(int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -681,7 +681,7 @@ public static String randomPrint(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
* @deprecated Use {@link #nextPrint(int, int)} from {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -697,7 +697,7 @@ public static String randomPrint(final int minLengthInclusive, final int maxLeng
* The method {@link SecureRandom#SecureRandom()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link SecureRandom#SecureRandom()}.
+ * @return The singleton instance based on {@link SecureRandom#SecureRandom()}.
* @see SecureRandom#SecureRandom()
* @since 3.16.0
*/
@@ -712,7 +712,7 @@ public static RandomStringUtils secure() {
* The method {@link SecureRandom#getInstanceStrong()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link SecureRandom#getInstanceStrong()}.
+ * @return The singleton instance based on {@link SecureRandom#getInstanceStrong()}.
* @see SecureRandom#getInstanceStrong()
* @since 3.17.0
*/
@@ -749,7 +749,7 @@ private RandomStringUtils(final Supplier<RandomUtils> random) {
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.16.0
*/
@@ -767,7 +767,7 @@ public String next(final int count) {
* @param count the length of random string to create.
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.16.0
*/
@@ -784,7 +784,7 @@ public String next(final int count, final boolean letters, final boolean numbers
*
* @param count the length of random string to create.
* @param chars the character array containing the set of characters to use, may be null.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.16.0
*/
@@ -807,7 +807,7 @@ public String next(final int count, final char... chars) {
* @param end the position in set of chars to end before.
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.16.0
*/
@@ -830,7 +830,7 @@ public String next(final int count, final int start, final int end, final boolea
* @param letters if {@code true}, generated string may include alphabetic characters.
* @param numbers if {@code true}, generated string may include numeric characters.
* @param chars the set of chars to choose randoms from. If {@code null}, then it will use the set of all chars.
- * @return the random string.
+ * @return The random string.
* @throws ArrayIndexOutOfBoundsException if there are not {@code (end - start) + 1} characters in the set array.
* @throws IllegalArgumentException if {@code count} < 0.
*/
@@ -849,7 +849,7 @@ public String next(final int count, final int start, final int end, final boolea
*
* @param count the length of random string to create.
* @param chars the String containing the set of characters to use, may be null, but must not be empty.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0 or the string is empty.
* @since 3.16.0
*/
@@ -868,7 +868,7 @@ public String next(final int count, final String chars) {
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
*/
public String nextAlphabetic(final int count) {
@@ -884,7 +884,7 @@ public String nextAlphabetic(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
*/
public String nextAlphabetic(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -899,7 +899,7 @@ public String nextAlphabetic(final int minLengthInclusive, final int maxLengthEx
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
*/
public String nextAlphanumeric(final int count) {
@@ -915,7 +915,7 @@ public String nextAlphanumeric(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
*/
public String nextAlphanumeric(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -931,7 +931,7 @@ public String nextAlphanumeric(final int minLengthInclusive, final int maxLength
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
*/
public String nextAscii(final int count) {
@@ -948,7 +948,7 @@ public String nextAscii(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
*/
public String nextAscii(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -964,7 +964,7 @@ public String nextAscii(final int minLengthInclusive, final int maxLengthExclusi
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.5
*/
@@ -981,7 +981,7 @@ public String nextGraph(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
*/
public String nextGraph(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -996,7 +996,7 @@ public String nextGraph(final int minLengthInclusive, final int maxLengthExclusi
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
*/
public String nextNumeric(final int count) {
@@ -1012,7 +1012,7 @@ public String nextNumeric(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.5
*/
public String nextNumeric(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -1028,7 +1028,7 @@ public String nextNumeric(final int minLengthInclusive, final int maxLengthExclu
* </p>
*
* @param count the length of random string to create.
- * @return the random string.
+ * @return The random string.
* @throws IllegalArgumentException if {@code count} < 0.
* @since 3.5
* @since 3.16.0
@@ -1046,7 +1046,7 @@ public String nextPrint(final int count) {
*
* @param minLengthInclusive the inclusive minimum length of the string to generate.
* @param maxLengthExclusive the exclusive maximum length of the string to generate.
- * @return the random string.
+ * @return The random string.
* @since 3.16.0
*/
public String nextPrint(final int minLengthInclusive, final int maxLengthExclusive) {
@@ -1056,7 +1056,7 @@ public String nextPrint(final int minLengthInclusive, final int maxLengthExclusi
/**
* Gets the Random.
*
- * @return the Random.
+ * @return The Random.
*/
private Random random() {
return randomUtils().random();
@@ -1065,7 +1065,7 @@ private Random random() {
/**
* Gets the RandomUtils.
*
- * @return the RandomUtils.
+ * @return The RandomUtils.
*/
private RandomUtils randomUtils() {
return random.get();
diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java
index 17f5428c6..edb71ac14 100644
--- a/src/main/java/org/apache/commons/lang3/RandomUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java
@@ -93,7 +93,7 @@ public class RandomUtils {
* The method {@link ThreadLocalRandom#current()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link ThreadLocalRandom#current()}.
+ * @return The singleton instance based on {@link ThreadLocalRandom#current()}.
* @see ThreadLocalRandom#current()
* @see #secure()
* @see #secureStrong()
@@ -106,7 +106,7 @@ public static RandomUtils insecure() {
/**
* Generates a random boolean value.
*
- * @return the random boolean.
+ * @return The random boolean.
* @since 3.5
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -119,7 +119,7 @@ public static boolean nextBoolean() {
* Generates an array of random bytes.
*
* @param count the size of the returned array.
- * @return the random byte array.
+ * @return The random byte array.
* @throws IllegalArgumentException if {@code count} is negative.
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@@ -131,7 +131,7 @@ public static byte[] nextBytes(final int count) {
/**
* Generates a random double between 0 (inclusive) and {@link Double#MAX_VALUE} ({@value Double#MAX_VALUE} exclusive).
*
- * @return the random double.
+ * @return The random double.
* @see #nextDouble(double, double)
* @since 3.5
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -147,7 +147,7 @@ public static double nextDouble() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random double.
+ * @return The random double.
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@Deprecated
@@ -158,7 +158,7 @@ public static double nextDouble(final double startInclusive, final double endExc
/**
* Generates a random float between 0 (inclusive) and {@link Float#MAX_VALUE} ({@value Float#MAX_VALUE} exclusive).
*
- * @return the random float.
+ * @return The random float.
* @see #nextFloat(float, float)
* @since 3.5
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -174,7 +174,7 @@ public static float nextFloat() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random float.
+ * @return The random float.
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@Deprecated
@@ -185,7 +185,7 @@ public static float nextFloat(final float startInclusive, final float endExclusi
/**
* Generates a random int between 0 (inclusive) and {@link Integer#MAX_VALUE} ({@value Integer#MAX_VALUE} exclusive).
*
- * @return the random integer.
+ * @return The random integer.
* @see #nextInt(int, int)
* @since 3.5
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -201,7 +201,7 @@ public static int nextInt() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random integer.
+ * @return The random integer.
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@Deprecated
@@ -212,7 +212,7 @@ public static int nextInt(final int startInclusive, final int endExclusive) {
/**
* Generates a random long between 0 (inclusive) and {@link Long#MAX_VALUE} ({@value Long#MAX_VALUE} exclusive).
*
- * @return the random long.
+ * @return The random long.
* @see #nextLong(long, long)
* @since 3.5
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
@@ -228,7 +228,7 @@ public static long nextLong() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random long.
+ * @return The random long.
* @deprecated Use {@link #secure()}, {@link #secureStrong()}, or {@link #insecure()}.
*/
@Deprecated
@@ -243,7 +243,7 @@ public static long nextLong(final long startInclusive, final long endExclusive)
* The method {@link SecureRandom#SecureRandom()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link SecureRandom#SecureRandom()}.
+ * @return The singleton instance based on {@link SecureRandom#SecureRandom()}.
* @see SecureRandom#SecureRandom()
* @since 3.16.0
*/
@@ -262,7 +262,7 @@ static SecureRandom secureRandom() {
* The method {@link SecureRandom#getInstanceStrong()} is called on-demand.
* </p>
*
- * @return the singleton instance based on {@link SecureRandom#getInstanceStrong()}.
+ * @return The singleton instance based on {@link SecureRandom#getInstanceStrong()}.
* @see SecureRandom#getInstanceStrong()
* @since 3.17.0
*/
@@ -297,7 +297,7 @@ Random random() {
/**
* Generates a random boolean value.
*
- * @return the random boolean.
+ * @return The random boolean.
* @since 3.16.0
*/
public boolean randomBoolean() {
@@ -308,7 +308,7 @@ public boolean randomBoolean() {
* Generates an array of random bytes.
*
* @param count the size of the returned array.
- * @return the random byte array.
+ * @return The random byte array.
* @throws IllegalArgumentException if {@code count} is negative.
* @since 3.16.0
*/
@@ -322,7 +322,7 @@ public byte[] randomBytes(final int count) {
/**
* Generates a random double between 0 (inclusive) and {@link Double#MAX_VALUE} ({@value Double#MAX_VALUE} exclusive).
*
- * @return the random double.
+ * @return The random double.
* @see #randomDouble(double, double)
* @since 3.16.0
*/
@@ -336,7 +336,7 @@ public double randomDouble() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random double.
+ * @return The random double.
* @since 3.16.0
*/
public double randomDouble(final double startInclusive, final double endExclusive) {
@@ -351,7 +351,7 @@ public double randomDouble(final double startInclusive, final double endExclusiv
/**
* Generates a random float between 0 (inclusive) and Float.MAX_VALUE (exclusive).
*
- * @return the random float.
+ * @return The random float.
* @see #randomFloat(float, float)
* @since 3.16.0
*/
@@ -365,7 +365,7 @@ public float randomFloat() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random float.
+ * @return The random float.
* @since 3.16.0
*/
public float randomFloat(final float startInclusive, final float endExclusive) {
@@ -380,7 +380,7 @@ public float randomFloat(final float startInclusive, final float endExclusive) {
/**
* Generates a random int between 0 (inclusive) and {@link Integer#MAX_VALUE} ({@value Integer#MAX_VALUE} exclusive).
*
- * @return the random integer.
+ * @return The random integer.
* @see #randomInt(int, int)
* @since 3.16.0
*/
@@ -394,7 +394,7 @@ public int randomInt() {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random integer.
+ * @return The random integer.
* @since 3.16.0
*/
public int randomInt(final int startInclusive, final int endExclusive) {
@@ -409,7 +409,7 @@ public int randomInt(final int startInclusive, final int endExclusive) {
/**
* Generates a random long between 0 (inclusive) and {@link Long#MAX_VALUE} ({@value Long#MAX_VALUE}, exclusive).
*
- * @return the random long.
+ * @return The random long.
* @see #randomLong(long, long)
* @since 3.16.0
*/
@@ -440,7 +440,7 @@ private long randomLong(final long n) {
* @param startInclusive the smallest value that can be returned, must be non-negative.
* @param endExclusive the upper bound (not included).
* @throws IllegalArgumentException if {@code startInclusive > endExclusive} or if {@code startInclusive} is negative.
- * @return the random long.
+ * @return The random long.
* @since 3.16.0
*/
public long randomLong(final long startInclusive, final long endExclusive) {
diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java
index ca3d6c778..8de29ab4c 100644
--- a/src/main/java/org/apache/commons/lang3/Range.java
+++ b/src/main/java/org/apache/commons/lang3/Range.java
@@ -74,7 +74,7 @@ public int compare(final Object obj1, final Object obj2) {
* @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException when fromInclusive is null.
* @throws NullPointerException when toInclusive is null.
* @throws ClassCastException if the elements are not {@link Comparable}.
@@ -98,7 +98,7 @@ public static <T extends Comparable<? super T>> Range<T> between(final T fromInc
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
* @param comparator the comparator to be used, null for natural ordering.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException when fromInclusive is null.
* @throws NullPointerException when toInclusive is null.
* @throws ClassCastException if using natural ordering and the elements are not {@link Comparable}.
@@ -122,7 +122,7 @@ private static int hash(final Object value1, final Object value2) {
*
* @param <T> The type of the elements in this range.
* @param element the value to use for this range, not null.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if the element is null.
* @throws ClassCastException if the element is not {@link Comparable}.
*/
@@ -140,7 +140,7 @@ public static <T extends Comparable<? super T>> Range<T> is(final T element) {
* @param <T> The type of the elements in this range.
* @param element the value to use for this range, must not be {@code null}.
* @param comparator the comparator to be used, null for natural ordering.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if the element is null.
* @throws ClassCastException if using natural ordering and the elements are not {@link Comparable}.
*/
@@ -160,7 +160,7 @@ public static <T> Range<T> is(final T element, final Comparator<T> comparator) {
* @param <T> The type of the elements in this range.
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException if either element is null.
* @throws ClassCastException if the elements are not {@link Comparable}.
* @since 3.13.0
@@ -182,7 +182,7 @@ public static <T extends Comparable<? super T>> Range<T> of(final T fromInclusiv
* @param fromInclusive the first value that defines the edge of the range, inclusive.
* @param toInclusive the second value that defines the edge of the range, inclusive.
* @param comparator the comparator to be used, null for natural ordering.
- * @return the range object, not null.
+ * @return The range object, not null.
* @throws NullPointerException when fromInclusive is null.
* @throws NullPointerException when toInclusive is null.
* @throws ClassCastException if using natural ordering and the elements are not {@link Comparable}.
@@ -340,7 +340,7 @@ public boolean equals(final Object obj) {
* }</pre>
*
* @param element the element to check for, not null.
- * @return the minimum, the element, or the maximum depending on the element's location relative to the range.
+ * @return The minimum, the element, or the maximum depending on the element's location relative to the range.
* @throws NullPointerException if {@code element} is {@code null}.
* @since 3.10
*/
@@ -362,7 +362,7 @@ public T fit(final T element) {
* <p>Natural ordering uses an internal comparator implementation, thus this
* method never returns null. See {@link #isNaturalOrdering()}.</p>
*
- * @return the comparator being used, not null.
+ * @return The comparator being used, not null.
*/
public Comparator<T> getComparator() {
return comparator;
@@ -371,7 +371,7 @@ public Comparator<T> getComparator() {
/**
* Gets the maximum value in this range.
*
- * @return the maximum value in this range, not null.
+ * @return The maximum value in this range, not null.
*/
public T getMaximum() {
return maximum;
@@ -380,7 +380,7 @@ public T getMaximum() {
/**
* Gets the minimum value in this range.
*
- * @return the minimum value in this range, not null.
+ * @return The minimum value in this range, not null.
*/
public T getMinimum() {
return minimum;
@@ -563,7 +563,7 @@ private void readObject(final ObjectInputStream in) throws IOException, ClassNot
*
* <p>The format of the String is '[<em>min</em>..<em>max</em>]'.</p>
*
- * @return the {@link String} representation of this range.
+ * @return The {@link String} representation of this range.
*/
@Override
public String toString() {
@@ -583,7 +583,7 @@ public String toString() {
* The default format used by {@code toString()} is {@code [%1$s..%2$s]}.</p>
*
* @param format the format string, optionally containing {@code %1$s}, {@code %2$s} and {@code %3$s}, not null.
- * @return the formatted string, not null.
+ * @return The formatted string, not null.
*/
public String toString(final String format) {
return String.format(format, minimum, maximum, comparator);
diff --git a/src/main/java/org/apache/commons/lang3/RegExUtils.java b/src/main/java/org/apache/commons/lang3/RegExUtils.java
index 319e7bb0a..5722a2186 100644
--- a/src/main/java/org/apache/commons/lang3/RegExUtils.java
+++ b/src/main/java/org/apache/commons/lang3/RegExUtils.java
@@ -37,7 +37,7 @@ public class RegExUtils {
* Compiles the given regular expression into a pattern with the {@link Pattern#DOTALL} flag.
*
* @param regex The expression to be compiled.
- * @return the given regular expression compiled into a pattern with the {@link Pattern#DOTALL} flag.
+ * @return The given regular expression compiled into a pattern with the {@link Pattern#DOTALL} flag.
* @since 3.13.0
*/
public static Pattern dotAll(final String regex) {
diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
index 896da5169..4de51e1ab 100644
--- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java
@@ -119,7 +119,7 @@ protected Class<?> resolveClass(final ObjectStreamClass desc) throws IOException
*
* @param <T> the type of the object involved.
* @param object the {@link Serializable} object to clone.
- * @return the cloned object.
+ * @return The cloned object.
* @throws SerializationException (runtime) if the serialization fails.
* @see <a href="https://docs.oracle.com/en/java/javase/25/docs/specs/serialization/">Java Object Serialization Specification</a>
*/
@@ -153,7 +153,7 @@ public static <T extends Serializable> T clone(final T object) {
*
* @param <T> the object type to be deserialized.
* @param objectData the serialized object, must not be null.
- * @return the deserialized object.
+ * @return The deserialized object.
* @throws NullPointerException if {@code objectData} is {@code null}.
* @throws SerializationException (runtime) if the serialization fails.
* @see org.apache.commons.io.serialization.ValidatingObjectInputStream
@@ -189,7 +189,7 @@ public static <T> T deserialize(final byte[] objectData) {
*
* @param <T> the object type to be deserialized.
* @param inputStream the serialized object input stream, must not be null.
- * @return the deserialized object.
+ * @return The deserialized object.
* @throws NullPointerException if {@code inputStream} is {@code null}.
* @throws SerializationException (runtime) if the serialization fails.
* @see org.apache.commons.io.serialization.ValidatingObjectInputStream
@@ -232,7 +232,7 @@ public static <T> T requireNonNull(final T obj, final String message) throws Inv
*
* @param <T> The type of the object involved.
* @param obj the object to roundtrip.
- * @return the serialized and deserialized object.
+ * @return The serialized and deserialized object.
* @see <a href="https://docs.oracle.com/en/java/javase/25/docs/specs/serialization/">Java Object Serialization Specification</a>
* @since 3.3
*/
diff --git a/src/main/java/org/apache/commons/lang3/Streams.java b/src/main/java/org/apache/commons/lang3/Streams.java
index b3a9c3bdf..c8456a4b5 100644
--- a/src/main/java/org/apache/commons/lang3/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/Streams.java
@@ -260,7 +260,7 @@ protected void assertNotTerminated() {
* @param <R> The type of the result.
* @param <A> The intermediate accumulation type of the {@link Collector}.
* @param collector the {@link Collector} describing the reduction.
- * @return the result of the reduction.
+ * @return The result of the reduction.
* @see #collect(Supplier, BiConsumer, BiConsumer)
* @see Collectors
*/
@@ -337,7 +337,7 @@ public <A, R> R collect(final Supplier<R> supplier, final BiConsumer<R, ? super
*
* @param predicate a non-interfering, stateless predicate to apply to each
* element to determine if it should be included.
- * @return the new stream.
+ * @return The new stream.
*/
public FailableStream<O> filter(final FailablePredicate<O, ?> predicate) {
assertNotTerminated();
@@ -389,7 +389,7 @@ protected void makeTerminated() {
*
* @param <R> The element type of the new stream.
* @param mapper A non-interfering, stateless function to apply to each element.
- * @return the new stream.
+ * @return The new stream.
*/
public <R> FailableStream<R> map(final FailableFunction<O, R, ?> mapper) {
assertNotTerminated();
@@ -443,7 +443,7 @@ public <R> FailableStream<R> map(final FailableFunction<O, R, ?> mapper) {
* @param identity the identity value for the accumulating function.
* @param accumulator an associative, non-interfering, stateless
* function for combining two values.
- * @return the result of the reduction.
+ * @return The result of the reduction.
*/
public O reduce(final O identity, final BinaryOperator<O> accumulator) {
makeTerminated();
diff --git a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
index b28290eb1..530abfb76 100644
--- a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java
@@ -425,7 +425,7 @@ public int translate(final CharSequence input, final int index, final Writer out
* <a href="https://datatracker.ietf.org/doc/html/rfc4180">RFC 4180</a>.
*
* @param input the input CSV column String, may be null
- * @return the input String, enclosed in double quotes if the value contains a comma,
+ * @return The input String, enclosed in double quotes if the value contains a comma,
* newline or double quote, {@code null} if null string input
* @since 2.4
*/
@@ -674,7 +674,7 @@ public static String escapeXml11(final String input) {
* <a href="https://datatracker.ietf.org/doc/html/rfc4180">RFC 4180</a>.
*
* @param input the input CSV column String, may be null
- * @return the input String, with enclosing double quotes removed and embedded double
+ * @return The input String, with enclosing double quotes removed and embedded double
* quotes unescaped, {@code null} if null string input
* @since 2.4
*/
diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java
index ab5d94bba..4418b7e0e 100644
--- a/src/main/java/org/apache/commons/lang3/StringUtils.java
+++ b/src/main/java/org/apache/commons/lang3/StringUtils.java
@@ -421,7 +421,7 @@ public static String abbreviate(final String str, String abbrevMarker, final int
* @param str the String to abbreviate, may be null.
* @param middle the String to replace the middle characters with, may be null.
* @param length the length to abbreviate {@code str} to.
- * @return the abbreviated String if the above criteria is met, or the original String supplied for abbreviation.
+ * @return The abbreviated String if the above criteria is met, or the original String supplied for abbreviation.
* @since 2.5
*/
public static String abbreviateMiddle(final String str, final String middle, final int length) {
@@ -540,7 +540,7 @@ private static StringBuilder capacity(final int count, final byte maxElementChar
* </pre>
*
* @param str the String to capitalize, may be null.
- * @return the capitalized String, {@code null} if null String input.
+ * @return The capitalized String, {@code null} if null String input.
* @see org.apache.commons.text.WordUtils#capitalize(String)
* @see #uncapitalize(String)
* @since 2.0
@@ -1068,7 +1068,7 @@ public static boolean contains(final CharSequence seq, final int searchChar) {
*
* @param cs the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the {@code true} if any of the chars are found, {@code false} if no match or null input.
+ * @return The {@code true} if any of the chars are found, {@code false} if no match or null input.
* @since 2.4
* @since 3.0 Changed signature from containsAny(String, char[]) to containsAny(CharSequence, char...)
*/
@@ -1115,7 +1115,7 @@ public static boolean containsAny(final CharSequence cs, final char... searchCha
*
* @param cs the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the {@code true} if any of the chars are found, {@code false} if no match or null input.
+ * @return The {@code true} if any of the chars are found, {@code false} if no match or null input.
* @since 2.4
* @since 3.0 Changed signature from containsAny(String, String) to containsAny(CharSequence, CharSequence)
*/
@@ -1480,7 +1480,7 @@ private static void convertRemainingAccentCharacters(final StringBuilder decompo
*
* @param str the CharSequence to check, may be null.
* @param ch the char to count.
- * @return the number of occurrences, 0 if the CharSequence is {@code null}.
+ * @return The number of occurrences, 0 if the CharSequence is {@code null}.
* @since 3.4
*/
public static int countMatches(final CharSequence str, final char ch) {
@@ -1517,7 +1517,7 @@ public static int countMatches(final CharSequence str, final char ch) {
*
* @param str the CharSequence to check, may be null.
* @param sub the substring to count, may be null.
- * @return the number of occurrences, 0 if either CharSequence is {@code null}.
+ * @return The number of occurrences, 0 if either CharSequence is {@code null}.
* @since 3.0 Changed signature from countMatches(String, String) to countMatches(CharSequence, CharSequence)
*/
public static int countMatches(final CharSequence str, final CharSequence sub) {
@@ -1553,7 +1553,7 @@ public static int countMatches(final CharSequence str, final CharSequence sub) {
* @param str the CharSequence to check, may be null.
* @param defaultStr the default CharSequence to return if {@code str} is {@link #isBlank(CharSequence) blank} (whitespaces, empty ({@code ""}), or
* {@code null}); may be null.
- * @return the passed in CharSequence, or the default.
+ * @return The passed in CharSequence, or the default.
* @see StringUtils#defaultString(String, String)
* @see #isBlank(CharSequence)
*/
@@ -1575,7 +1575,7 @@ public static <T extends CharSequence> T defaultIfBlank(final T str, final T def
* @param <T> the specific kind of CharSequence.
* @param str the CharSequence to check, may be null.
* @param defaultStr the default CharSequence to return if the input is empty ("") or {@code null}, may be null.
- * @return the passed in CharSequence, or the default.
+ * @return The passed in CharSequence, or the default.
* @see StringUtils#defaultString(String, String)
*/
public static <T extends CharSequence> T defaultIfEmpty(final T str, final T defaultStr) {
@@ -1592,7 +1592,7 @@ public static <T extends CharSequence> T defaultIfEmpty(final T str, final T def
* </pre>
*
* @param str the String to check, may be null.
- * @return the passed in String, or the empty String if it was {@code null}.
+ * @return The passed in String, or the empty String if it was {@code null}.
* @see Objects#toString(Object, String)
* @see String#valueOf(Object)
*/
@@ -1620,7 +1620,7 @@ public static String defaultString(final String str) {
*
* @param str the String to check, may be null.
* @param nullDefault the default String to return if the input is {@code null}, may be null.
- * @return the passed in String, or the default if it was {@code null}.
+ * @return The passed in String, or the default if it was {@code null}.
* @see Objects#toString(Object, String)
* @see String#valueOf(Object)
* @deprecated Use {@link Objects#toString(Object, String)}.
@@ -1641,7 +1641,7 @@ public static String defaultString(final String str, final String nullDefault) {
* </pre>
*
* @param str the String to delete whitespace from, may be null.
- * @return the String without whitespaces, {@code null} if null String input.
+ * @return The String without whitespaces, {@code null} if null String input.
*/
public static String deleteWhitespace(final String str) {
if (isEmpty(str)) {
@@ -1686,7 +1686,7 @@ public static String deleteWhitespace(final String str) {
*
* @param str1 the first String, may be null.
* @param str2 the second String, may be null.
- * @return the portion of str2 where it differs from str1; returns the empty String if they are equal.
+ * @return The portion of str2 where it differs from str1; returns the empty String if they are equal.
* @see #indexOfDifference(CharSequence,CharSequence)
* @since 2.0
*/
@@ -1918,7 +1918,7 @@ public static boolean equalsIgnoreCase(final CharSequence cs1, final CharSequenc
*
* @param <T> the specific kind of CharSequence.
* @param values the values to test, may be {@code null} or empty.
- * @return the first value from {@code values} which is not blank, or {@code null} if there are no non-blank values.
+ * @return The first value from {@code values} which is not blank, or {@code null} if there are no non-blank values.
* @since 3.8
*/
@SafeVarargs
@@ -1953,7 +1953,7 @@ public static <T extends CharSequence> T firstNonBlank(final T... values) {
*
* @param <T> the specific kind of CharSequence.
* @param values the values to test, may be {@code null} or empty.
- * @return the first value from {@code values} which is not empty, or {@code null} if there are no non-empty values.
+ * @return The first value from {@code values} which is not empty, or {@code null} if there are no non-empty values.
* @since 3.8
*/
@SafeVarargs
@@ -2023,7 +2023,7 @@ public static byte[] getBytes(final String string, final String charset) throws
* </pre>
*
* @param strs array of String objects, entries may be null.
- * @return the initial sequence of characters that are common to all Strings in the array; empty String if the array is null, the elements are all null or
+ * @return The initial sequence of characters that are common to all Strings in the array; empty String if the array is null, the elements are all null or
* if there is no common prefix.
* @since 2.4
*/
@@ -2185,7 +2185,7 @@ public static int getFuzzyDistance(final CharSequence term, final CharSequence q
* @param str the CharSequence to check, may be null.
* @param defaultSupplier the supplier of default CharSequence to return if the input is {@link #isBlank(CharSequence) blank} (whitespaces, empty
* ({@code ""}), or {@code null}); may be null.
- * @return the passed in CharSequence, or the default
+ * @return The passed in CharSequence, or the default
* @see StringUtils#defaultString(String, String)
* @see #isBlank(CharSequence)
* @since 3.10
@@ -2215,7 +2215,7 @@ public static <T extends CharSequence> T getIfBlank(final T str, final Supplier<
* @param <T> the specific kind of CharSequence.
* @param str the CharSequence to check, may be null.
* @param defaultSupplier the supplier of default CharSequence to return if the input is empty ("") or {@code null}, may be null.
- * @return the passed in CharSequence, or the default.
+ * @return The passed in CharSequence, or the default.
* @see StringUtils#defaultString(String, String)
* @since 3.10
*/
@@ -2564,7 +2564,7 @@ distance is O(nm), but a bound of k allows us to reduce it to O(km) time by only
*
* @param seq the CharSequence to check, may be null.
* @param searchSeq the CharSequence to find, may be null.
- * @return the first index of the search CharSequence, -1 if no match or {@code null} string input.
+ * @return The first index of the search CharSequence, -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, String) to indexOf(CharSequence, CharSequence)
* @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence) Strings.CS.indexOf(CharSequence, CharSequence)}.
@@ -2600,7 +2600,7 @@ public static int indexOf(final CharSequence seq, final CharSequence searchSeq)
* @param seq the CharSequence to check, may be null.
* @param searchSeq the CharSequence to find, may be null.
* @param startPos the start position, negative treated as zero.
- * @return the first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input.
+ * @return The first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, String, int) to indexOf(CharSequence, CharSequence, int)
* @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence, int) Strings.CS.indexOf(CharSequence, CharSequence, int)}.
@@ -2645,7 +2645,7 @@ public static int indexOf(final CharSequence seq, final CharSequence searchSeq,
*
* @param seq the CharSequence to check, may be null.
* @param searchChar the character to find.
- * @return the first index of the search character, -1 if no match or {@code null} string input.
+ * @return The first index of the search character, -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, int) to indexOf(CharSequence, int)
* @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@link String}
@@ -2702,7 +2702,7 @@ public static int indexOf(final CharSequence seq, final int searchChar) {
* @param seq the CharSequence to check, may be null.
* @param searchChar the character to find.
* @param startPos the start position, negative treated as zero.
- * @return the first index of the search character (always ≥ startPos), -1 if no match or {@code null} string input.
+ * @return The first index of the search character (always ≥ startPos), -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from indexOf(String, int, int) to indexOf(CharSequence, int, int)
* @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@link String}
@@ -2733,7 +2733,7 @@ public static int indexOf(final CharSequence seq, final int searchChar, final in
*
* @param cs the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the index of any of the chars, -1 if no match or null input.
+ * @return The index of any of the chars, -1 if no match or null input.
* @since 2.0
* @since 3.0 Changed signature from indexOfAny(String, char[]) to indexOfAny(CharSequence, char...)
*/
@@ -2765,7 +2765,7 @@ public static int indexOfAny(final CharSequence cs, final char... searchChars) {
*
* @param str the CharSequence to check, may be null.
* @param searchStrs the CharSequences to search for, may be null.
- * @return the first index of any of the searchStrs in str, -1 if no match.
+ * @return The first index of any of the searchStrs in str, -1 if no match.
* @since 3.0 Changed signature from indexOfAny(String, String[]) to indexOfAny(CharSequence, CharSequence...)
*/
public static int indexOfAny(final CharSequence str, final CharSequence... searchStrs) {
@@ -2812,7 +2812,7 @@ public static int indexOfAny(final CharSequence str, final CharSequence... searc
* @param cs the CharSequence to check, may be null.
* @param csStart Start searching the input {@code cs} at this index.
* @param searchChars the chars to search for, may be null.
- * @return the index of any of the chars, -1 if no match or null input.
+ * @return The index of any of the chars, -1 if no match or null input.
* @since 2.0
* @since 3.0 Changed signature from indexOfAny(String, char[]) to indexOfAny(CharSequence, char...)
*/
@@ -2856,7 +2856,7 @@ public static int indexOfAny(final CharSequence cs, final int csStart, final cha
*
* @param cs the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the index of any of the chars, -1 if no match or null input.
+ * @return The index of any of the chars, -1 if no match or null input.
* @since 2.0
* @since 3.0 Changed signature from indexOfAny(String, String) to indexOfAny(CharSequence, String)
*/
@@ -2887,7 +2887,7 @@ public static int indexOfAny(final CharSequence cs, final String searchChars) {
*
* @param cs the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the index of any of the chars, -1 if no match or null input.
+ * @return The index of any of the chars, -1 if no match or null input.
* @since 2.0
* @since 3.0 Changed signature from indexOfAnyBut(String, char[]) to indexOfAnyBut(CharSequence, char...)
*/
@@ -2918,7 +2918,7 @@ public static int indexOfAnyBut(final CharSequence cs, final char... searchChars
*
* @param seq the CharSequence to check, may be null.
* @param searchChars the chars to search for, may be null.
- * @return the index of any of the chars, -1 if no match or null input.
+ * @return The index of any of the chars, -1 if no match or null input.
* @since 2.0
* @since 3.0 Changed signature from indexOfAnyBut(String, String) to indexOfAnyBut(CharSequence, CharSequence)
*/
@@ -2967,7 +2967,7 @@ public static int indexOfAnyBut(final CharSequence seq, final CharSequence searc
* </pre>
*
* @param css array of CharSequences, entries may be null.
- * @return the index where the strings begin to differ; -1 if they are all equal.
+ * @return The index where the strings begin to differ; -1 if they are all equal.
* @since 2.4
* @since 3.0 Changed signature from indexOfDifference(String...) to indexOfDifference(CharSequence...)
*/
@@ -3050,7 +3050,7 @@ public static int indexOfDifference(final CharSequence... css) {
*
* @param cs1 the first CharSequence, may be null.
* @param cs2 the second CharSequence, may be null.
- * @return the index where cs1 and cs2 begin to differ; -1 if they are equal.
+ * @return The index where cs1 and cs2 begin to differ; -1 if they are equal.
* @since 2.0
* @since 3.0 Changed signature from indexOfDifference(String, String) to indexOfDifference(CharSequence, CharSequence)
*/
@@ -3099,7 +3099,7 @@ public static int indexOfDifference(final CharSequence cs1, final CharSequence c
*
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
- * @return the first index of the search CharSequence, -1 if no match or {@code null} string input.
+ * @return The first index of the search CharSequence, -1 if no match or {@code null} string input.
* @since 2.5
* @since 3.0 Changed signature from indexOfIgnoreCase(String, String) to indexOfIgnoreCase(CharSequence, CharSequence)
* @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence) Strings.CI.indexOf(CharSequence, CharSequence)}.
@@ -3134,7 +3134,7 @@ public static int indexOfIgnoreCase(final CharSequence str, final CharSequence s
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
* @param startPos the start position, negative treated as zero.
- * @return the first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input.
+ * @return The first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input.
* @since 2.5
* @since 3.0 Changed signature from indexOfIgnoreCase(String, String, int) to indexOfIgnoreCase(CharSequence, CharSequence, int)
* @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence, int) Strings.CI.indexOf(CharSequence, CharSequence, int)}.
@@ -3870,7 +3870,7 @@ public static boolean isWhitespace(final CharSequence cs) {
*
* @param array the array of values to join together, may be null.
* @param delimiter the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.12.0
*/
public static String join(final boolean[] array, final char delimiter) {
@@ -3905,7 +3905,7 @@ public static String join(final boolean[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.12.0
*/
public static String join(final boolean[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -3947,7 +3947,7 @@ public static String join(final boolean[] array, final char delimiter, final int
* the array of values to join together, may be null.
* @param delimiter
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final byte[] array, final char delimiter) {
@@ -3983,7 +3983,7 @@ public static String join(final byte[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final byte[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4025,7 +4025,7 @@ public static String join(final byte[] array, final char delimiter, final int st
* the array of values to join together, may be null.
* @param delimiter
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final char[] array, final char delimiter) {
@@ -4061,7 +4061,7 @@ public static String join(final char[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final char[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4103,7 +4103,7 @@ public static String join(final char[] array, final char delimiter, final int st
* the array of values to join together, may be null.
* @param delimiter
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final double[] array, final char delimiter) {
@@ -4139,7 +4139,7 @@ public static String join(final double[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final double[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4181,7 +4181,7 @@ public static String join(final double[] array, final char delimiter, final int
* the array of values to join together, may be null.
* @param delimiter
* the separator character to use.
- * @return the joined String, {@code null} if null array input
+ * @return The joined String, {@code null} if null array input
* @since 3.2
*/
public static String join(final float[] array, final char delimiter) {
@@ -4217,7 +4217,7 @@ public static String join(final float[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final float[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4259,7 +4259,7 @@ public static String join(final float[] array, final char delimiter, final int s
* the array of values to join together, may be null.
* @param separator
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final int[] array, final char separator) {
@@ -4295,7 +4295,7 @@ public static String join(final int[] array, final char separator) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final int[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4330,7 +4330,7 @@ public static String join(final int[] array, final char delimiter, final int sta
*
* @param iterable the {@link Iterable} providing the values to join together, may be null.
* @param separator the separator character to use.
- * @return the joined String, {@code null} if null iterator input.
+ * @return The joined String, {@code null} if null iterator input.
* @since 2.3
*/
public static String join(final Iterable<?> iterable, final char separator) {
@@ -4350,7 +4350,7 @@ public static String join(final Iterable<?> iterable, final char separator) {
*
* @param iterable the {@link Iterable} providing the values to join together, may be null.
* @param separator the separator character to use, null treated as "".
- * @return the joined String, {@code null} if null iterator input.
+ * @return The joined String, {@code null} if null iterator input.
* @since 2.3
*/
public static String join(final Iterable<?> iterable, final String separator) {
@@ -4370,7 +4370,7 @@ public static String join(final Iterable<?> iterable, final String separator) {
*
* @param iterator the {@link Iterator} of values to join together, may be null.
* @param separator the separator character to use.
- * @return the joined String, {@code null} if null iterator input.
+ * @return The joined String, {@code null} if null iterator input.
* @since 2.0
*/
public static String join(final Iterator<?> iterator, final char separator) {
@@ -4397,7 +4397,7 @@ public static String join(final Iterator<?> iterator, final char separator) {
*
* @param iterator the {@link Iterator} of values to join together, may be null.
* @param separator the separator character to use, null treated as "".
- * @return the joined String, {@code null} if null iterator input.
+ * @return The joined String, {@code null} if null iterator input.
*/
public static String join(final Iterator<?> iterator, final String separator) {
// handle null, zero and one elements before building a buffer
@@ -4430,7 +4430,7 @@ public static String join(final Iterator<?> iterator, final String separator) {
* @param separator the separator character to use.
* @param startIndex the first index to start joining from. It is an error to pass in a start index past the end of the list.
* @param endIndex the index to stop joining from (exclusive). It is an error to pass in an end index past the end of the list.
- * @return the joined String, {@code null} if null list input.
+ * @return The joined String, {@code null} if null list input.
* @since 3.8
*/
public static String join(final List<?> list, final char separator, final int startIndex, final int endIndex) {
@@ -4465,7 +4465,7 @@ public static String join(final List<?> list, final char separator, final int st
* @param separator the separator character to use.
* @param startIndex the first index to start joining from. It is an error to pass in a start index past the end of the list.
* @param endIndex the index to stop joining from (exclusive). It is an error to pass in an end index past the end of the list.
- * @return the joined String, {@code null} if null list input.
+ * @return The joined String, {@code null} if null list input.
* @since 3.8
*/
public static String join(final List<?> list, final String separator, final int startIndex, final int endIndex) {
@@ -4500,7 +4500,7 @@ public static String join(final List<?> list, final String separator, final int
* the array of values to join together, may be null.
* @param separator
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final long[] array, final char separator) {
@@ -4536,7 +4536,7 @@ public static String join(final long[] array, final char separator) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final long[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4576,7 +4576,7 @@ public static String join(final long[] array, final char delimiter, final int st
*
* @param array the array of values to join together, may be null.
* @param delimiter the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 2.0
*/
public static String join(final Object[] array, final char delimiter) {
@@ -4606,7 +4606,7 @@ public static String join(final Object[] array, final char delimiter) {
* @param delimiter the separator character to use.
* @param startIndex the first index to start joining from. It is an error to pass in a start index past the end of the array.
* @param endIndex the index to stop joining from (exclusive). It is an error to pass in an end index past the end of the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 2.0
*/
public static String join(final Object[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4633,7 +4633,7 @@ public static String join(final Object[] array, final char delimiter, final int
*
* @param array the array of values to join together, may be null.
* @param delimiter the separator character to use, null treated as "".
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
*/
public static String join(final Object[] array, final String delimiter) {
return array != null ? join(array, ObjectUtils.toString(delimiter), 0, array.length) : null;
@@ -4664,7 +4664,7 @@ public static String join(final Object[] array, final String delimiter) {
* @param delimiter the separator character to use, null treated as "".
* @param startIndex the first index to start joining from.
* @param endIndex the index to stop joining from (exclusive).
- * @return the joined String, {@code null} if null array input; or the empty string if {@code endIndex - startIndex <= 0}. The number of joined entries is
+ * @return The joined String, {@code null} if null array input; or the empty string if {@code endIndex - startIndex <= 0}. The number of joined entries is
* given by {@code endIndex - startIndex}.
* @throws ArrayIndexOutOfBoundsException ife<br>
* {@code startIndex < 0} or <br>
@@ -4697,7 +4697,7 @@ public static String join(final Object[] array, final String delimiter, final in
* the array of values to join together, may be null.
* @param delimiter
* the separator character to use.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final short[] array, final char delimiter) {
@@ -4733,7 +4733,7 @@ public static String join(final short[] array, final char delimiter) {
* @param endIndex
* the index to stop joining from (exclusive). It is an error to pass in an end index past the end of
* the array.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 3.2
*/
public static String join(final short[] array, final char delimiter, final int startIndex, final int endIndex) {
@@ -4772,7 +4772,7 @@ public static String join(final short[] array, final char delimiter, final int s
*
* @param <T> the specific type of values to join together.
* @param elements the values to join together, may be null.
- * @return the joined String, {@code null} if null array input.
+ * @return The joined String, {@code null} if null array input.
* @since 2.0
* @since 3.0 Changed signature to use varargs
*/
@@ -4797,7 +4797,7 @@ public static <T> String join(final T... elements) {
*
* @param delimiter the separator character to use, null treated as "".
* @param array the varargs providing the values to join together. {@code null} elements are treated as "".
- * @return the joined String.
+ * @return The joined String.
* @throws IllegalArgumentException if a null varargs is provided.
* @since 3.5
*/
@@ -4827,7 +4827,7 @@ public static String joinWith(final String delimiter, final Object... array) {
*
* @param seq the CharSequence to check, may be null.
* @param searchSeq the CharSequence to find, may be null.
- * @return the last index of the search String, -1 if no match or {@code null} string input.
+ * @return The last index of the search String, -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from lastIndexOf(String, String) to lastIndexOf(CharSequence, CharSequence)
* @deprecated Use {@link Strings#lastIndexOf(CharSequence, CharSequence) Strings.CS.lastIndexOf(CharSequence, CharSequence)}.
@@ -4864,7 +4864,7 @@ public static int lastIndexOf(final CharSequence seq, final CharSequence searchS
* @param seq the CharSequence to check, may be null.
* @param searchSeq the CharSequence to find, may be null.
* @param startPos the start position, negative treated as zero.
- * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input.
+ * @return The last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from lastIndexOf(String, String, int) to lastIndexOf(CharSequence, CharSequence, int)
* @deprecated Use {@link Strings#lastIndexOf(CharSequence, CharSequence, int) Strings.CS.lastIndexOf(CharSequence, CharSequence, int)}.
@@ -4904,7 +4904,7 @@ public static int lastIndexOf(final CharSequence seq, final CharSequence searchS
*
* @param seq the {@link CharSequence} to check, may be null.
* @param searchChar the character to find.
- * @return the last index of the search character, -1 if no match or {@code null} string input.
+ * @return The last index of the search character, -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from lastIndexOf(String, int) to lastIndexOf(CharSequence, int)
* @since 3.6 Updated {@link CharSequenceUtils} call to behave more like {@link String}
@@ -4956,7 +4956,7 @@ public static int lastIndexOf(final CharSequence seq, final int searchChar) {
* @param seq the CharSequence to check, may be null.
* @param searchChar the character to find.
* @param startPos the start position.
- * @return the last index of the search character (always ≤ startPos), -1 if no match or {@code null} string input.
+ * @return The last index of the search character (always ≤ startPos), -1 if no match or {@code null} string input.
* @since 2.0
* @since 3.0 Changed signature from lastIndexOf(String, int, int) to lastIndexOf(CharSequence, int, int)
*/
@@ -4990,7 +4990,7 @@ public static int lastIndexOf(final CharSequence seq, final int searchChar, fina
*
* @param str the CharSequence to check, may be null.
* @param searchStrs the CharSequences to search for, may be null.
- * @return the last index of any of the CharSequences, -1 if no match.
+ * @return The last index of any of the CharSequences, -1 if no match.
* @since 3.0 Changed signature from lastIndexOfAny(String, String[]) to lastIndexOfAny(CharSequence, CharSequence)
*/
public static int lastIndexOfAny(final CharSequence str, final CharSequence... searchStrs) {
@@ -5029,7 +5029,7 @@ public static int lastIndexOfAny(final CharSequence str, final CharSequence... s
*
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
- * @return the first index of the search CharSequence, -1 if no match or {@code null} string input.
+ * @return The first index of the search CharSequence, -1 if no match or {@code null} string input.
* @since 2.5
* @since 3.0 Changed signature from lastIndexOfIgnoreCase(String, String) to lastIndexOfIgnoreCase(CharSequence, CharSequence)
* @deprecated Use {@link Strings#lastIndexOf(CharSequence, CharSequence) Strings.CI.lastIndexOf(CharSequence, CharSequence)}.
@@ -5063,7 +5063,7 @@ public static int lastIndexOfIgnoreCase(final CharSequence str, final CharSequen
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
* @param startPos the start position.
- * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} input.
+ * @return The last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} input.
* @since 2.5
* @since 3.0 Changed signature from lastIndexOfIgnoreCase(String, String, int) to lastIndexOfIgnoreCase(CharSequence, CharSequence, int)
* @deprecated Use {@link Strings#lastIndexOf(CharSequence, CharSequence, int) Strings.CI.lastIndexOf(CharSequence, CharSequence, int)}.
@@ -5105,7 +5105,7 @@ public static int lastIndexOfIgnoreCase(final CharSequence str, final CharSequen
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
* @param ordinal the n-th last {@code searchStr} to find.
- * @return the n-th last index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
+ * @return The n-th last index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
* @since 2.5
* @since 3.0 Changed signature from lastOrdinalIndexOf(String, String, int) to lastOrdinalIndexOf(CharSequence, CharSequence, int)
*/
@@ -5132,7 +5132,7 @@ public static int lastOrdinalIndexOf(final CharSequence str, final CharSequence
*
* @param str the String to get the leftmost characters from, may be null.
* @param len the length of the required String.
- * @return the leftmost characters, {@code null} if null String input.
+ * @return The leftmost characters, {@code null} if null String input.
*/
public static String left(final String str, final int len) {
if (str == null) {
@@ -5293,7 +5293,7 @@ public static int length(final CharSequence cs) {
* </p>
*
* @param str the String to lower case, may be null.
- * @return the lower cased String, {@code null} if null String input.
+ * @return The lower cased String, {@code null} if null String input.
*/
public static String lowerCase(final String str) {
if (str == null) {
@@ -5317,7 +5317,7 @@ public static String lowerCase(final String str) {
*
* @param str the String to lower case, may be null.
* @param locale the locale that defines the case transformation rules, must not be null.
- * @return the lower cased String, {@code null} if null String input.
+ * @return The lower cased String, {@code null} if null String input.
* @since 2.5
*/
public static String lowerCase(final String str, final Locale locale) {
@@ -5404,7 +5404,7 @@ private static int[] matches(final CharSequence first, final CharSequence second
* @param str the String to get the characters from, may be null.
* @param pos the position to start from, negative treated as zero.
* @param len the length of the required String.
- * @return the middle characters, {@code null} if null String input.
+ * @return The middle characters, {@code null} if null String input.
*/
public static String mid(final String str, int pos, final int len) {
if (str == null) {
@@ -5452,7 +5452,7 @@ public static String mid(final String str, int pos, final int len) {
* </p>
*
* @param str the source String to normalize whitespaces from, may be null.
- * @return the modified string with whitespace normalized, {@code null} if null String input.
+ * @return The modified string with whitespace normalized, {@code null} if null String input.
* @see Pattern
* @see #trim(String)
* @see <a href="https://www.w3.org/TR/xpath/#function-normalize-space">https://www.w3.org/TR/xpath/#function-normalize-space</a>
@@ -5540,7 +5540,7 @@ public static String normalizeSpace(final String str) {
* @param str the CharSequence to check, may be null.
* @param searchStr the CharSequence to find, may be null.
* @param ordinal the n-th {@code searchStr} to find.
- * @return the n-th index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
+ * @return The n-th index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
* @since 2.1
* @since 3.0 Changed signature from ordinalIndexOf(String, String, int) to ordinalIndexOf(CharSequence, CharSequence, int)
*/
@@ -5562,7 +5562,7 @@ public static int ordinalIndexOf(final CharSequence str, final CharSequence sear
* @param searchStr the CharSequence to find, may be null.
* @param ordinal the n-th {@code searchStr} to find, overlapping matches are allowed.
* @param lastIndex true if lastOrdinalIndexOf() otherwise false if ordinalIndexOf().
- * @return the n-th index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
+ * @return The n-th index of the search CharSequence, {@code -1} ({@code INDEX_NOT_FOUND}) if no match or {@code null} string input.
*/
// Shared code between ordinalIndexOf(String, String, int) and lastOrdinalIndexOf(String, String, int)
private static int ordinalIndexOf(final CharSequence str, final CharSequence searchStr, final int ordinal, final boolean lastIndex) {
@@ -5745,7 +5745,7 @@ public static String prependIfMissingIgnoreCase(final String str, final CharSequ
*
* @param str the source String to search, may be null.
* @param remove the char to search for and remove, may be null.
- * @return the substring with the char removed if found, {@code null} if null String input.
+ * @return The substring with the char removed if found, {@code null} if null String input.
* @since 2.1
*/
public static String remove(final String str, final char remove) {
@@ -5781,7 +5781,7 @@ public static String remove(final String str, final char remove) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 2.1
* @deprecated Use {@link Strings#remove(String, String) Strings.CS.remove(String, String)}.
*/
@@ -5822,7 +5822,7 @@ public static String remove(final String str, final String remove) {
*
* @param text text to remove from, may be null.
* @param regex the regular expression to which this string is to be matched.
- * @return the text with any removes processed, {@code null} if null String input.
+ * @return The text with any removes processed, {@code null} if null String input.
* @throws java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid.
* @see #replaceAll(String, String, String)
* @see #removePattern(String, String)
@@ -5857,7 +5857,7 @@ public static String removeAll(final String text, final String regex) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 2.1
* @deprecated Use {@link Strings#removeEnd(String, CharSequence) Strings.CS.removeEnd(String, CharSequence)}.
*/
@@ -5888,7 +5888,7 @@ public static String removeEnd(final String str, final String remove) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for (case-insensitive) and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 2.4
* @deprecated Use {@link Strings#removeEnd(String, CharSequence) Strings.CI.removeEnd(String, CharSequence)}.
*/
@@ -5930,7 +5930,7 @@ public static String removeEndIgnoreCase(final String str, final String remove)
*
* @param text text to remove from, may be null.
* @param regex the regular expression to which this string is to be matched.
- * @return the text with the first replacement processed, {@code null} if null String input.
+ * @return The text with the first replacement processed, {@code null} if null String input.
* @throws java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid.
* @see #replaceFirst(String, String, String)
* @see String#replaceFirst(String, String)
@@ -5965,7 +5965,7 @@ public static String removeFirst(final String text, final String regex) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for (case-insensitive) and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 3.5
* @deprecated Use {@link Strings#remove(String, String) Strings.CI.remove(String, String)}.
*/
@@ -6028,7 +6028,7 @@ public static String removePattern(final String source, final String regex) {
*
* @param str the source String to search, may be null.
* @param remove the char to search for and remove.
- * @return the substring with the char removed if found, {@code null} if null String input.
+ * @return The substring with the char removed if found, {@code null} if null String input.
* @since 3.13.0
*/
public static String removeStart(final String str, final char remove) {
@@ -6058,7 +6058,7 @@ public static String removeStart(final String str, final char remove) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 2.1
* @deprecated Use {@link Strings#removeStart(String, CharSequence) Strings.CS.removeStart(String, CharSequence)}.
*/
@@ -6088,7 +6088,7 @@ public static String removeStart(final String str, final String remove) {
*
* @param str the source String to search, may be null.
* @param remove the String to search for (case-insensitive) and remove, may be null.
- * @return the substring with the string removed if found, {@code null} if null String input.
+ * @return The substring with the string removed if found, {@code null} if null String input.
* @since 2.4
* @deprecated Use {@link Strings#removeStart(String, CharSequence) Strings.CI.removeStart(String, CharSequence)}.
*/
@@ -6230,7 +6230,7 @@ public static String repeat(final String repeat, final String separator, final i
* @param text text to search and replace in, may be null.
* @param searchString the String to search for, may be null.
* @param replacement the String to replace it with, may be null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @see #replace(String text, String searchString, String replacement, int max)
* @deprecated Use {@link Strings#replace(String, String, String) Strings.CS.replace(String, String, String)}.
*/
@@ -6265,7 +6265,7 @@ public static String replace(final String text, final String searchString, final
* @param searchString the String to search for, may be null.
* @param replacement the String to replace it with, may be null.
* @param max maximum number of values to replace, or {@code -1} if no maximum.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @deprecated Use {@link Strings#replace(String, String, String, int) Strings.CS.replace(String, String, String, int)}.
*/
@Deprecated
@@ -6310,7 +6310,7 @@ public static String replace(final String text, final String searchString, final
* @param text text to search and replace in, may be null.
* @param regex the regular expression to which this string is to be matched.
* @param replacement the string to be substituted for each match.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @throws java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid.
* @see #replacePattern(String, String, String)
* @see String#replaceAll(String, String)
@@ -6441,7 +6441,7 @@ public static String replaceChars(final String str, final String searchChars, St
* @param text text to search and replace in, no-op if null.
* @param searchList the Strings to search for, no-op if null.
* @param replacementList the Strings to replace them with, no-op if null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @throws IllegalArgumentException if the lengths of the arrays are not the same (null is ok, and/or size 0).
* @since 2.4
*/
@@ -6478,7 +6478,7 @@ public static String replaceEach(final String text, final String[] searchList, f
* @param replacementList the Strings to replace them with, no-op if null.
* @param repeat if true, then replace repeatedly until there are no more possible replacements or timeToLive < 0.
* @param timeToLive if less than 0 then there is a circular reference and endless loop.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @throws IllegalStateException if the search is repeating and there is an endless loop due to outputs of one being inputs to another.
* @throws IllegalArgumentException if the lengths of the arrays are not the same (null is ok, and/or size 0).
* @since 2.4
@@ -6627,7 +6627,7 @@ private static String replaceEach(
* @param text text to search and replace in, no-op if null.
* @param searchList the Strings to search for, no-op if null.
* @param replacementList the Strings to replace them with, no-op if null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @throws IllegalStateException if the search is repeating and there is an endless loop due to outputs of one being inputs to another.
* @throws IllegalArgumentException if the lengths of the arrays are not the same (null is ok, and/or size 0).
* @since 2.4
@@ -6674,7 +6674,7 @@ public static String replaceEachRepeatedly(final String text, final String[] sea
* @param text text to search and replace in, may be null.
* @param regex the regular expression to which this string is to be matched.
* @param replacement the string to be substituted for the first match.
- * @return the text with the first replacement processed, {@code null} if null String input.
+ * @return The text with the first replacement processed, {@code null} if null String input.
* @throws java.util.regex.PatternSyntaxException if the regular expression's syntax is invalid.
* @see String#replaceFirst(String, String)
* @see java.util.regex.Pattern
@@ -6708,7 +6708,7 @@ public static String replaceFirst(final String text, final String regex, final S
* @param text text to search and replace in, may be null.
* @param searchString the String to search for (case-insensitive), may be null.
* @param replacement the String to replace it with, may be null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @see #replaceIgnoreCase(String text, String searchString, String replacement, int max)
* @since 3.5
* @deprecated Use {@link Strings#replace(String, String, String) Strings.CI.replace(String, String, String)}.
@@ -6744,7 +6744,7 @@ public static String replaceIgnoreCase(final String text, final String searchStr
* @param searchString the String to search for (case-insensitive), may be null.
* @param replacement the String to replace it with, may be null.
* @param max maximum number of values to replace, or {@code -1} if no maximum.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @since 3.5
* @deprecated Use {@link Strings#replace(String, String, String, int) Strings.CI.replace(String, String, String, int)}.
*/
@@ -6774,7 +6774,7 @@ public static String replaceIgnoreCase(final String text, final String searchStr
* @param text text to search and replace in, may be null.
* @param searchString the String to search for, may be null.
* @param replacement the String to replace with, may be null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @see #replace(String text, String searchString, String replacement, int max)
* @deprecated Use {@link Strings#replaceOnce(String, String, String) Strings.CS.replaceOnce(String, String, String)}.
*/
@@ -6805,7 +6805,7 @@ public static String replaceOnce(final String text, final String searchString, f
* @param text text to search and replace in, may be null.
* @param searchString the String to search for (case-insensitive), may be null.
* @param replacement the String to replace with, may be null.
- * @return the text with any replacements processed, {@code null} if null String input.
+ * @return The text with any replacements processed, {@code null} if null String input.
* @see #replaceIgnoreCase(String text, String searchString, String replacement, int max)
* @since 3.5
* @deprecated Use {@link Strings#replaceOnce(String, String, String) Strings.CI.replaceOnce(String, String, String)}.
@@ -6873,7 +6873,7 @@ public static String replacePattern(final String source, final String regex, fin
* </pre>
*
* @param str the String to reverse, may be null.
- * @return the reversed String, {@code null} if null String input.
+ * @return The reversed String, {@code null} if null String input.
*/
public static String reverse(final String str) {
if (str == null) {
@@ -6898,7 +6898,7 @@ public static String reverse(final String str) {
*
* @param str the String to reverse, may be null.
* @param separatorChar the separator character to use.
- * @return the reversed String, {@code null} if null String input.
+ * @return The reversed String, {@code null} if null String input.
* @since 2.0
*/
public static String reverseDelimited(final String str, final char separatorChar) {
@@ -6926,7 +6926,7 @@ public static String reverseDelimited(final String str, final char separatorChar
*
* @param str the String to get the rightmost characters from, may be null.
* @param len the length of the required String.
- * @return the rightmost characters, {@code null} if null String input.
+ * @return The rightmost characters, {@code null} if null String input.
*/
public static String right(final String str, final int len) {
if (str == null) {
@@ -7076,7 +7076,7 @@ public static String rightPad(final String str, final int size, String padStr) {
*
* @param str the String to rotate, may be null.
* @param shift number of time to shift (positive : right shift, negative : left shift).
- * @return the rotated String, or the original String if {@code shift == 0}, or {@code null} if null String input.
+ * @return The rotated String, or the original String if {@code shift == 0}, or {@code null} if null String input.
* @since 3.5
*/
public static String rotate(final String str, final int shift) {
@@ -7903,7 +7903,7 @@ public static boolean startsWithIgnoreCase(final CharSequence str, final CharSeq
* </pre>
*
* @param str the String to remove whitespace from, may be null.
- * @return the stripped String, {@code null} if null String input.
+ * @return The stripped String, {@code null} if null String input.
*/
public static String strip(final String str) {
return strip(str, null);
@@ -7934,7 +7934,7 @@ public static String strip(final String str) {
*
* @param str the String to remove characters from, may be null.
* @param stripChars the characters to remove, null treated as whitespace.
- * @return the stripped String, {@code null} if null String input.
+ * @return The stripped String, {@code null} if null String input.
*/
public static String strip(String str, final String stripChars) {
str = stripStart(str, stripChars);
@@ -7997,7 +7997,7 @@ public static String stripAccents(final String input) {
* </pre>
*
* @param strs the array to remove whitespace from, may be null.
- * @return the stripped Strings, {@code null} if null array input.
+ * @return The stripped Strings, {@code null} if null array input.
*/
public static String[] stripAll(final String... strs) {
return stripAll(strs, null);
@@ -8025,7 +8025,7 @@ public static String[] stripAll(final String... strs) {
*
* @param strs the array to remove characters from, may be null.
* @param stripChars the characters to remove, null treated as whitespace.
- * @return the stripped Strings, {@code null} if null array input.
+ * @return The stripped Strings, {@code null} if null array input.
*/
public static String[] stripAll(final String[] strs, final String stripChars) {
final int strsLen = ArrayUtils.getLength(strs);
@@ -8060,7 +8060,7 @@ public static String[] stripAll(final String[] strs, final String stripChars) {
*
* @param str the String to remove characters from, may be null.
* @param stripChars the set of characters to remove, null treated as whitespace.
- * @return the stripped String, {@code null} if null String input.
+ * @return The stripped String, {@code null} if null String input.
*/
public static String stripEnd(final String str, final String stripChars) {
int end = length(str);
@@ -8105,7 +8105,7 @@ public static String stripEnd(final String str, final String stripChars) {
*
* @param str the String to remove characters from, may be null.
* @param stripChars the characters to remove, null treated as whitespace.
- * @return the stripped String, {@code null} if null String input.
+ * @return The stripped String, {@code null} if null String input.
*/
public static String stripStart(final String str, final String stripChars) {
final int strLen = length(str);
@@ -8146,7 +8146,7 @@ public static String stripStart(final String str, final String stripChars) {
* </pre>
*
* @param str the String to be stripped, may be null.
- * @return the trimmed String, or an empty String if {@code null} input.
+ * @return The trimmed String, or an empty String if {@code null} input.
* @since 2.0
*/
public static String stripToEmpty(final String str) {
@@ -8172,7 +8172,7 @@ public static String stripToEmpty(final String str) {
* </pre>
*
* @param str the String to be stripped, may be null.
- * @return the stripped String, {@code null} if whitespace, empty or null String input.
+ * @return The stripped String, {@code null} if whitespace, empty or null String input.
* @since 2.0
*/
public static String stripToNull(String str) {
@@ -8310,7 +8310,7 @@ public static String substring(final String str, int start, int end) {
*
* @param str the String to get a substring from, may be null.
* @param find the character (Unicode code point) to find.
- * @return the substring after the first occurrence of the specified character, {@code null} if null String input.
+ * @return The substring after the first occurrence of the specified character, {@code null} if null String input.
* @since 3.11
*/
public static String substringAfter(final String str, final int find) {
@@ -8349,7 +8349,7 @@ public static String substringAfter(final String str, final int find) {
*
* @param str the String to get a substring from, may be null.
* @param find the String to find, may be null.
- * @return the substring after the first occurrence of the specified string, {@code null} if null String input.
+ * @return The substring after the first occurrence of the specified string, {@code null} if null String input.
* @since 2.0
*/
public static String substringAfter(final String str, final String find) {
@@ -8390,7 +8390,7 @@ public static String substringAfter(final String str, final String find) {
*
* @param str the String to get a substring from, may be null.
* @param find the character (Unicode code point) to find.
- * @return the substring after the last occurrence of the specified character, {@code null} if null String input.
+ * @return The substring after the last occurrence of the specified character, {@code null} if null String input.
* @since 3.11
*/
public static String substringAfterLast(final String str, final int find) {
@@ -8430,7 +8430,7 @@ public static String substringAfterLast(final String str, final int find) {
*
* @param str the String to get a substring from, may be null.
* @param find the String to find, may be null.
- * @return the substring after the last occurrence of the specified string, {@code null} if null String input.
+ * @return The substring after the last occurrence of the specified string, {@code null} if null String input.
* @since 2.0
*/
public static String substringAfterLast(final String str, final String find) {
@@ -8469,7 +8469,7 @@ public static String substringAfterLast(final String str, final String find) {
*
* @param str the String to get a substring from, may be null.
* @param find the character (Unicode code point) to find.
- * @return the substring before the first occurrence of the specified character, {@code null} if null String input.
+ * @return The substring before the first occurrence of the specified character, {@code null} if null String input.
* @since 3.12.0
*/
public static String substringBefore(final String str, final int find) {
@@ -8508,7 +8508,7 @@ public static String substringBefore(final String str, final int find) {
*
* @param str the String to get a substring from, may be null.
* @param find the String to find, may be null.
- * @return the substring before the first occurrence of the specified string, {@code null} if null String input.
+ * @return The substring before the first occurrence of the specified string, {@code null} if null String input.
* @since 2.0
*/
public static String substringBefore(final String str, final String find) {
@@ -8550,7 +8550,7 @@ public static String substringBefore(final String str, final String find) {
*
* @param str the String to get a substring from, may be null.
* @param find the String to find, may be null.
- * @return the substring before the last occurrence of the specified string, {@code null} if null String input.
+ * @return The substring before the last occurrence of the specified string, {@code null} if null String input.
* @since 2.0
*/
public static String substringBeforeLast(final String str, final String find) {
@@ -8582,7 +8582,7 @@ public static String substringBeforeLast(final String str, final String find) {
*
* @param str the String containing the substring, may be null.
* @param tag the String before and after the substring, may be null.
- * @return the substring, {@code null} if no match.
+ * @return The substring, {@code null} if no match.
* @since 2.0
*/
public static String substringBetween(final String str, final String tag) {
@@ -8613,7 +8613,7 @@ public static String substringBetween(final String str, final String tag) {
* @param str the String containing the substring, may be null.
* @param open the String before the substring, may be null.
* @param close the String after the substring, may be null.
- * @return the substring, {@code null} if no match.
+ * @return The substring, {@code null} if no match.
* @since 2.0
*/
public static String substringBetween(final String str, final String open, final String close) {
@@ -8708,7 +8708,7 @@ public static String[] substringsBetween(final String str, final String open, fi
* </p>
*
* @param str the String to swap case, may be null.
- * @return the changed String, {@code null} if null String input.
+ * @return The changed String, {@code null} if null String input.
*/
public static String swapCase(final String str) {
if (isEmpty(str)) {
@@ -8778,7 +8778,7 @@ public static String toEncodedString(final byte[] bytes, final Charset charset)
* Converts the given source String as a lower-case using the {@link Locale#ROOT} locale in a null-safe manner.
*
* @param source A source String or null.
- * @return the given source String as a lower-case using the {@link Locale#ROOT} locale or null.
+ * @return The given source String as a lower-case using the {@link Locale#ROOT} locale or null.
* @since 3.10
*/
public static String toRootLowerCase(final String source) {
@@ -8789,7 +8789,7 @@ public static String toRootLowerCase(final String source) {
* Converts the given source String as an upper-case using the {@link Locale#ROOT} locale in a null-safe manner.
*
* @param source A source String or null.
- * @return the given source String as an upper-case using the {@link Locale#ROOT} locale or null.
+ * @return The given source String as an upper-case using the {@link Locale#ROOT} locale or null.
* @since 3.10
*/
public static String toRootUpperCase(final String source) {
@@ -8831,7 +8831,7 @@ public static String toString(final byte[] bytes, final String charsetName) {
* </pre>
*
* @param str the String to be trimmed, may be null.
- * @return the trimmed string, {@code null} if null String input.
+ * @return The trimmed string, {@code null} if null String input.
*/
public static String trim(final String str) {
return str == null ? null : str.trim();
@@ -8853,7 +8853,7 @@ public static String trim(final String str) {
* }</pre>
*
* @param str the String to be trimmed, may be null.
- * @return the trimmed string, {@code null} if null String input.
+ * @return The trimmed string, {@code null} if null String input.
* @since 3.21.0
*/
public static String trimAsciiControl(final String str) {
@@ -8888,7 +8888,7 @@ public static String trimAsciiControl(final String str) {
* </pre>
*
* @param str the String to be trimmed, may be null.
- * @return the trimmed String, or an empty String if {@code null} input.
+ * @return The trimmed String, or an empty String if {@code null} input.
* @since 2.0
*/
public static String trimToEmpty(final String str) {
@@ -8912,7 +8912,7 @@ public static String trimToEmpty(final String str) {
* </pre>
*
* @param str the String to be trimmed, may be null.
- * @return the trimmed String, {@code null} if only chars <= 32, empty or null String input.
+ * @return The trimmed String, {@code null} if only chars <= 32, empty or null String input.
* @since 2.0
*/
public static String trimToNull(final String str) {
@@ -9051,7 +9051,7 @@ public static String truncate(final String str, final int offset, final int maxW
* </pre>
*
* @param str the String to uncapitalize, may be null.
- * @return the uncapitalized String, {@code null} if null String input.
+ * @return The uncapitalized String, {@code null} if null String input.
* @see org.apache.commons.text.WordUtils#uncapitalize(String)
* @see #capitalize(String)
* @since 2.0
@@ -9157,7 +9157,7 @@ public static String unwrap(final String str, final String wrapToken) {
* </p>
*
* @param str the String to upper case, may be null.
- * @return the upper-cased String, {@code null} if null String input.
+ * @return The upper-cased String, {@code null} if null String input.
*/
public static String upperCase(final String str) {
if (str == null) {
@@ -9181,7 +9181,7 @@ public static String upperCase(final String str) {
*
* @param str the String to upper case, may be null.
* @param locale the locale that defines the case transformation rules, must not be null.
- * @return the upper-cased String, {@code null} if null String input.
+ * @return The upper-cased String, {@code null} if null String input.
* @since 2.5
*/
public static String upperCase(final String str, final Locale locale) {
@@ -9217,7 +9217,7 @@ public static String valueOf(final char[] value) {
*
* @param str the string to be wrapped, may be {@code null}.
* @param wrapWith the char that will wrap {@code str}.
- * @return the wrapped string, or {@code null} if {@code str == null}.
+ * @return The wrapped string, or {@code null} if {@code str == null}.
* @since 3.4
*/
public static String wrap(final String str, final char wrapWith) {
@@ -9281,7 +9281,7 @@ public static String wrap(final String str, final String wrapWith) {
*
* @param str the string to be wrapped, may be {@code null}.
* @param wrapWith the char that will wrap {@code str}.
- * @return the wrapped string, or {@code null} if {@code str == null}.
+ * @return The wrapped string, or {@code null} if {@code str == null}.
* @since 3.5
*/
public static String wrapIfMissing(final String str, final char wrapWith) {
@@ -9330,7 +9330,7 @@ public static String wrapIfMissing(final String str, final char wrapWith) {
*
* @param str the string to be wrapped, may be {@code null}.
* @param wrapWith the string that will wrap {@code str}.
- * @return the wrapped string, or {@code null} if {@code str == null}.
+ * @return The wrapped string, or {@code null} if {@code str == null}.
* @since 3.5
*/
public static String wrapIfMissing(final String str, final String wrapWith) {
diff --git a/src/main/java/org/apache/commons/lang3/Strings.java b/src/main/java/org/apache/commons/lang3/Strings.java
index 32ca691c5..92e218164 100644
--- a/src/main/java/org/apache/commons/lang3/Strings.java
+++ b/src/main/java/org/apache/commons/lang3/Strings.java
@@ -826,7 +826,7 @@ public boolean equalsAny(final CharSequence string, final CharSequence... search
*
* @param seq the CharSequence to check, may be null
* @param searchSeq the CharSequence to find, may be null
- * @return the first index of the search CharSequence, -1 if no match or {@code null} string input
+ * @return The first index of the search CharSequence, -1 if no match or {@code null} string input
*/
public int indexOf(final CharSequence seq, final CharSequence searchSeq) {
return indexOf(seq, searchSeq, 0);
@@ -879,7 +879,7 @@ public int indexOf(final CharSequence seq, final CharSequence searchSeq) {
* @param seq the CharSequence to check, may be null
* @param searchSeq the CharSequence to find, may be null
* @param startPos the start position, negative treated as zero
- * @return the first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input
+ * @return The first index of the search CharSequence (always ≥ startPos), -1 if no match or {@code null} string input
*/
public abstract int indexOf(CharSequence seq, CharSequence searchSeq, int startPos);
@@ -935,7 +935,7 @@ boolean isNullIsLess() {
*
* @param str the CharSequence to check, may be null
* @param searchStr the CharSequence to find, may be null
- * @return the last index of the search String, -1 if no match or {@code null} string input
+ * @return The last index of the search String, -1 if no match or {@code null} string input
*/
public int lastIndexOf(final CharSequence str, final CharSequence searchStr) {
if (str == null) {
@@ -990,7 +990,7 @@ public int lastIndexOf(final CharSequence str, final CharSequence searchStr) {
* @param seq the CharSequence to check, may be null
* @param searchSeq the CharSequence to find, may be null
* @param startPos the start position, negative treated as zero
- * @return the last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input
+ * @return The last index of the search CharSequence (always ≤ startPos), -1 if no match or {@code null} string input
*/
public abstract int lastIndexOf(CharSequence seq, CharSequence searchSeq, int startPos);
@@ -1112,7 +1112,7 @@ public String prependIfMissing(final String str, final CharSequence prefix, fina
*
* @param str the source String to search, may be null
* @param remove the String to search for and remove, may be null
- * @return the substring with the string removed if found, {@code null} if null String input
+ * @return The substring with the string removed if found, {@code null} if null String input
*/
public String remove(final String str, final String remove) {
return replace(str, remove, StringUtils.EMPTY, -1);
@@ -1157,7 +1157,7 @@ public String remove(final String str, final String remove) {
*
* @param str the source String to search, may be null
* @param remove the String to search for and remove, may be null
- * @return the substring with the string removed if found, {@code null} if null String input
+ * @return The substring with the string removed if found, {@code null} if null String input
*/
public String removeEnd(final String str, final CharSequence remove) {
if (StringUtils.isEmpty(str) || StringUtils.isEmpty(remove)) {
@@ -1207,7 +1207,7 @@ public String removeEnd(final String str, final CharSequence remove) {
*
* @param str the source String to search, may be null
* @param remove the String to search for and remove, may be null
- * @return the substring with the string removed if found, {@code null} if null String input
+ * @return The substring with the string removed if found, {@code null} if null String input
*/
public String removeStart(final String str, final CharSequence remove) {
if (str != null && startsWith(str, remove)) {
@@ -1256,7 +1256,7 @@ public String removeStart(final String str, final CharSequence remove) {
* @param text text to search and replace in, may be null
* @param searchString the String to search for, may be null
* @param replacement the String to replace it with, may be null
- * @return the text with any replacements processed, {@code null} if null String input
+ * @return The text with any replacements processed, {@code null} if null String input
*/
public String replace(final String text, final String searchString, final String replacement) {
return replace(text, searchString, replacement, -1);
@@ -1310,7 +1310,7 @@ public String replace(final String text, final String searchString, final String
* @param searchString the String to search for, may be null
* @param replacement the String to replace it with, may be null
* @param max maximum number of values to replace, or {@code -1} if no maximum
- * @return the text with any replacements processed, {@code null} if null String input
+ * @return The text with any replacements processed, {@code null} if null String input
*/
public String replace(final String text, final String searchString, final String replacement, int max) {
if (StringUtils.isEmpty(text) || StringUtils.isEmpty(searchString) || replacement == null || max == 0) {
@@ -1377,7 +1377,7 @@ public String replace(final String text, final String searchString, final String
* @param text text to search and replace in, may be null
* @param searchString the String to search for, may be null
* @param replacement the String to replace with, may be null
- * @return the text with any replacements processed, {@code null} if null String input
+ * @return The text with any replacements processed, {@code null} if null String input
*/
public String replaceOnce(final String text, final String searchString, final String replacement) {
return replace(text, searchString, replacement, 1);
diff --git a/src/main/java/org/apache/commons/lang3/SystemProperties.java b/src/main/java/org/apache/commons/lang3/SystemProperties.java
index a6c2e87f5..dfd5ccce4 100644
--- a/src/main/java/org/apache/commons/lang3/SystemProperties.java
+++ b/src/main/java/org/apache/commons/lang3/SystemProperties.java
@@ -3703,7 +3703,7 @@ public static String getLineSeparator() {
* </p>
*
* @param defaultIfAbsent get this Supplier when the property is empty or throws SecurityException.
- * @return the current value from the system properties map.
+ * @return The current value from the system properties map.
* @since 3.15.0
*/
public static String getLineSeparator(final Supplier<String> defaultIfAbsent) {
@@ -3913,7 +3913,7 @@ public static String getProperty(final String property) {
*
* @param property the system property name.
* @param defaultIfAbsent use this value when the property is empty or throws SecurityException.
- * @return the system property value or {@code null} if a security problem occurs.
+ * @return The system property value or {@code null} if a security problem occurs.
*/
static String getProperty(final String property, final String defaultIfAbsent) {
return getProperty(property, () -> defaultIfAbsent);
@@ -3927,7 +3927,7 @@ static String getProperty(final String property, final String defaultIfAbsent) {
*
* @param property the system property name.
* @param defaultIfAbsent get this Supplier when the property is empty or throws SecurityException.
- * @return the system property value or {@code null} if a security problem occurs.
+ * @return The system property value or {@code null} if a security problem occurs.
*/
static String getProperty(final String property, final Supplier<String> defaultIfAbsent) {
try {
diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java
index 971c36933..50a712a15 100644
--- a/src/main/java/org/apache/commons/lang3/SystemUtils.java
+++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java
@@ -2122,7 +2122,7 @@ public class SystemUtils {
*
* @param name the environment variable name.
* @param defaultValue the default value.
- * @return the environment variable value or {@code defaultValue} if a security problem occurs.
+ * @return The environment variable value or {@code defaultValue} if a security problem occurs.
* @since 3.8
*/
public static String getEnvironmentVariable(final String name, final String defaultValue) {
@@ -2143,7 +2143,7 @@ public static String getEnvironmentVariable(final String name, final String defa
* If you want to know what the network stack says is the host name, you should use {@code InetAddress.getLocalHost().getHostName()}.
* </p>
*
- * @return the host name. Will be {@code null} if the environment variable is not defined.
+ * @return The host name. Will be {@code null} if the environment variable is not defined.
* @since 3.6
*/
public static String getHostName() {
diff --git a/src/main/java/org/apache/commons/lang3/ThreadUtils.java b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
index ad5b7677c..6374f3d06 100644
--- a/src/main/java/org/apache/commons/lang3/ThreadUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ThreadUtils.java
@@ -305,7 +305,7 @@ public static Collection<ThreadGroup> findThreadGroups(final ThreadGroupPredicat
* Finds active thread groups with the specified group name.
*
* @param threadGroupName The thread group name.
- * @return the thread groups with the specified group name or an empty collection if no such thread group exists. The collection returned is always
+ * @return The thread groups with the specified group name or an empty collection if no such thread group exists. The collection returned is always
* unmodifiable.
* @throws NullPointerException if group name is null.
* @throws SecurityException if the current thread cannot access the system thread group.
@@ -458,7 +458,7 @@ public static Collection<Thread> getAllThreads() {
* This method returns null if this thread has died (been stopped).
* </p>
*
- * @return the system thread group.
+ * @return The system thread group.
* @throws SecurityException if the current thread cannot modify thread groups from this thread's thread group up to the system thread group.
*/
public static ThreadGroup getSystemThreadGroup() {
diff --git a/src/main/java/org/apache/commons/lang3/Validate.java b/src/main/java/org/apache/commons/lang3/Validate.java
index 69893973c..2efdbc69f 100644
--- a/src/main/java/org/apache/commons/lang3/Validate.java
+++ b/src/main/java/org/apache/commons/lang3/Validate.java
@@ -658,7 +658,7 @@ public static void matchesPattern(final CharSequence input, final String pattern
*
* @param <T> The iterable type.
* @param iterable the iterable to check, validated not null by this method.
- * @return the validated iterable (never {@code null} method for chaining).
+ * @return The validated iterable (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IllegalArgumentException if an element is {@code null}.
* @see #noNullElements(Iterable, String, Object...)
@@ -685,7 +685,7 @@ public static <T extends Iterable<?>> T noNullElements(final T iterable) {
* @param iterable the iterable to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated iterable (never {@code null} method for chaining).
+ * @return The validated iterable (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IllegalArgumentException if an element is {@code null}.
* @see #noNullElements(Iterable)
@@ -717,7 +717,7 @@ public static <T extends Iterable<?>> T noNullElements(final T iterable, final S
*
* @param <T> The array type.
* @param array the array to check, validated not null by this method.
- * @return the validated array (never {@code null} method for chaining).
+ * @return The validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IllegalArgumentException if an element is {@code null}.
* @see #noNullElements(Object[], String, Object...)
@@ -744,7 +744,7 @@ public static <T> T[] noNullElements(final T[] array) {
* @param array the array to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated array (never {@code null} method for chaining).
+ * @return The validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IllegalArgumentException if an element is {@code null}.
* @see #noNullElements(Object[])
@@ -772,7 +772,7 @@ public static <T> T[] noNullElements(final T[] array, final String message, fina
*
* @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by this method.
- * @return the validated character sequence (never {@code null} method for chaining).
+ * @return The validated character sequence (never {@code null} method for chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IllegalArgumentException if the character sequence is blank.
* @see #notBlank(CharSequence, String, Object...)
@@ -794,7 +794,7 @@ public static <T extends CharSequence> T notBlank(final T chars) {
* @param chars the character sequence to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated character sequence (never {@code null} method for chaining).
+ * @return The validated character sequence (never {@code null} method for chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IllegalArgumentException if the character sequence is blank.
* @see #notBlank(CharSequence)
@@ -820,7 +820,7 @@ public static <T extends CharSequence> T notBlank(final T chars, final String me
*
* @param <T> The collection type.
* @param collection the collection to check, validated not null by this method.
- * @return the validated collection (never {@code null} method for chaining).
+ * @return The validated collection (never {@code null} method for chaining).
* @throws NullPointerException if the collection is {@code null}.
* @throws IllegalArgumentException if the collection is empty.
* @see #notEmpty(Collection, String, Object...)
@@ -840,7 +840,7 @@ public static <T extends Collection<?>> T notEmpty(final T collection) {
*
* @param <T> The map type.
* @param map the map to check, validated not null by this method.
- * @return the validated map (never {@code null} method for chaining).
+ * @return The validated map (never {@code null} method for chaining).
* @throws NullPointerException if the map is {@code null}.
* @throws IllegalArgumentException if the map is empty.
* @see #notEmpty(Map, String, Object...)
@@ -861,7 +861,7 @@ public static <T extends Collection<?>> T notEmpty(final T collection) {
*
* @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by this method.
- * @return the validated character sequence (never {@code null} method for chaining).
+ * @return The validated character sequence (never {@code null} method for chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IllegalArgumentException if the character sequence is empty.
* @see #notEmpty(CharSequence, String, Object...)
@@ -881,7 +881,7 @@ public static <T extends CharSequence> T notEmpty(final T chars) {
* @param collection the collection to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated collection (never {@code null} method for chaining).
+ * @return The validated collection (never {@code null} method for chaining).
* @throws NullPointerException if the collection is {@code null}.
* @throws IllegalArgumentException if the collection is empty.
* @see #notEmpty(Object[])
@@ -905,7 +905,7 @@ public static <T extends Collection<?>> T notEmpty(final T collection, final Str
* @param map the map to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated map (never {@code null} method for chaining).
+ * @return The validated map (never {@code null} method for chaining).
* @throws NullPointerException if the map is {@code null}.
* @throws IllegalArgumentException if the map is empty.
* @see #notEmpty(Object[])
@@ -929,7 +929,7 @@ public static <T extends Collection<?>> T notEmpty(final T collection, final Str
* @param chars the character sequence to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated character sequence (never {@code null} method for chaining).
+ * @return The validated character sequence (never {@code null} method for chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IllegalArgumentException if the character sequence is empty.
* @see #notEmpty(CharSequence)
@@ -953,7 +953,7 @@ public static <T extends CharSequence> T notEmpty(final T chars, final String me
*
* @param <T> The array type.
* @param array the array to check, validated not null by this method.
- * @return the validated array (never {@code null} method for chaining).
+ * @return The validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IllegalArgumentException if the array is empty.
* @see #notEmpty(Object[], String, Object...)
@@ -973,7 +973,7 @@ public static <T> T[] notEmpty(final T[] array) {
* @param array the array to check, validated not null by this method.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated array (never {@code null} method for chaining).
+ * @return The validated array (never {@code null} method for chaining).
* @throws NullPointerException if the array is {@code null}
* @throws IllegalArgumentException if the array is empty
* @see #notEmpty(Object[])
@@ -1034,7 +1034,7 @@ public static void notNaN(final double value, final String message, final Object
*
* @param <T> The object type.
* @param object the object to check.
- * @return the validated object (never {@code null} for method chaining).
+ * @return The validated object (never {@code null} for method chaining).
* @throws NullPointerException if the object is {@code null}.
* @see #notNull(Object, String, Object...)
* @deprecated Use {@link Objects#requireNonNull(Object)}.
@@ -1054,7 +1054,7 @@ public static <T> T notNull(final T object) {
* @param object the object to check.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message.
- * @return the validated object (never {@code null} for method chaining).
+ * @return The validated object (never {@code null} for method chaining).
* @throws NullPointerException if the object is {@code null}.
* @see Objects#requireNonNull(Object)
*/
@@ -1079,7 +1079,7 @@ private static Supplier<String> toSupplier(final String message, final Object...
* @param <T> The collection type.
* @param collection the collection to check, validated not null by this method.
* @param index the index to check.
- * @return the validated collection (never {@code null} for method chaining).
+ * @return The validated collection (never {@code null} for method chaining).
* @throws NullPointerException if the collection is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(Collection, int, String, Object...)
@@ -1106,7 +1106,7 @@ public static <T extends Collection<?>> T validIndex(final T collection, final i
* @param <T> The character sequence type.
* @param chars the character sequence to check, validated not null by this method.
* @param index the index to check.
- * @return the validated character sequence (never {@code null} for method chaining).
+ * @return The validated character sequence (never {@code null} for method chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(CharSequence, int, String, Object...)
@@ -1130,7 +1130,7 @@ public static <T extends CharSequence> T validIndex(final T chars, final int ind
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated collection (never {@code null} for chaining).
+ * @return The validated collection (never {@code null} for chaining).
* @throws NullPointerException if the collection is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(Collection, int)
@@ -1159,7 +1159,7 @@ public static <T extends Collection<?>> T validIndex(final T collection, final i
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated character sequence (never {@code null} for method chaining).
+ * @return The validated character sequence (never {@code null} for method chaining).
* @throws NullPointerException if the character sequence is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(CharSequence, int)
@@ -1189,7 +1189,7 @@ public static <T extends CharSequence> T validIndex(final T chars, final int ind
* @param <T> The array type.
* @param array the array to check, validated not null by this method.
* @param index the index to check.
- * @return the validated array (never {@code null} for method chaining).
+ * @return The validated array (never {@code null} for method chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(Object[], int, String, Object...)
@@ -1213,7 +1213,7 @@ public static <T> T[] validIndex(final T[] array, final int index) {
* @param index the index to check.
* @param message the {@link String#format(String, Object...)} exception message if invalid, not null.
* @param values the optional values for the formatted exception message, null array not recommended.
- * @return the validated array (never {@code null} for method chaining).
+ * @return The validated array (never {@code null} for method chaining).
* @throws NullPointerException if the array is {@code null}.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #validIndex(Object[], int)
diff --git a/src/main/java/org/apache/commons/lang3/arch/Processor.java b/src/main/java/org/apache/commons/lang3/arch/Processor.java
index 01a7b020d..f4d282b34 100644
--- a/src/main/java/org/apache/commons/lang3/arch/Processor.java
+++ b/src/main/java/org/apache/commons/lang3/arch/Processor.java
@@ -63,7 +63,7 @@ public enum Arch {
/**
* Gets the label suitable for display.
*
- * @return the label.
+ * @return The label.
*/
public String getLabel() {
return label;
@@ -132,7 +132,7 @@ public enum Type {
/**
* Gets the label suitable for display.
*
- * @return the label.
+ * @return The label.
* @since 3.13.0
*/
public String getLabel() {
diff --git a/src/main/java/org/apache/commons/lang3/builder/AbstractReflection.java b/src/main/java/org/apache/commons/lang3/builder/AbstractReflection.java
index 3a33788c6..5427bafa5 100644
--- a/src/main/java/org/apache/commons/lang3/builder/AbstractReflection.java
+++ b/src/main/java/org/apache/commons/lang3/builder/AbstractReflection.java
@@ -164,7 +164,7 @@ private static boolean setAccessibleTrue(final Field field) {
*
* @param lhs {@code this} object.
* @param rhs the other object.
- * @return the pair.
+ * @return The pair.
*/
static Pair<IDKey, IDKey> toRegisterPair(final Object lhs, final Object rhs) {
return Pair.of(new IDKey(lhs), new IDKey(rhs));
diff --git a/src/main/java/org/apache/commons/lang3/builder/Builder.java b/src/main/java/org/apache/commons/lang3/builder/Builder.java
index 20752242f..b1e60bee2 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Builder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Builder.java
@@ -79,7 +79,7 @@ public interface Builder<T> {
* Returns a reference to the object being constructed or result being
* calculated by the builder.
*
- * @return the object constructed or result calculated by the builder.
+ * @return The object constructed or result calculated by the builder.
*/
T build();
}
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diff.java b/src/main/java/org/apache/commons/lang3/builder/Diff.java
index 47973816c..a6289cbbd 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diff.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diff.java
@@ -62,7 +62,7 @@ protected Diff(final String fieldName) {
/**
* Gets the name of the field.
*
- * @return the field name.
+ * @return The field name.
*/
public final String getFieldName() {
return fieldName;
@@ -71,7 +71,7 @@ public final String getFieldName() {
/**
* Gets the type of the field.
*
- * @return the field type.
+ * @return The field type.
* @deprecated Unused, will be removed in 4.0.0.
*/
@Deprecated
@@ -99,7 +99,7 @@ public final T setValue(final T value) {
* [fieldname: left-value, right-value]
* </pre>
*
- * @return the string representation.
+ * @return The string representation.
*/
@Override
public final String toString() {
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 5cc24f00e..28022d669 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java
@@ -599,7 +599,7 @@ public DiffResult<T> build() {
/**
* Gets the left object.
*
- * @return the left object.
+ * @return The left object.
*/
T getLeft() {
return left;
@@ -608,7 +608,7 @@ T getLeft() {
/**
* Gets the right object.
*
- * @return the right object.
+ * @return The right object.
*/
T getRight() {
return right;
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 eb4f18564..0d5f882f5 100644
--- a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
+++ b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java
@@ -89,7 +89,7 @@ public List<Diff<?>> getDiffs() {
/**
* Gets the object the right object has been compared to.
*
- * @return the left object of the diff
+ * @return The left object of the diff
* @since 3.10
*/
public T getLeft() {
@@ -99,7 +99,7 @@ public T getLeft() {
/**
* Gets the number of differences between the two objects.
*
- * @return the number of differences
+ * @return The number of differences
*/
public int getNumberOfDiffs() {
return diffList.size();
@@ -108,7 +108,7 @@ public int getNumberOfDiffs() {
/**
* Gets the object the left object has been compared to.
*
- * @return the right object of the diff
+ * @return The right object of the diff
* @since 3.10
*/
public T getRight() {
@@ -118,7 +118,7 @@ public T getRight() {
/**
* Gets the style used by the {@link #toString()} method.
*
- * @return the style
+ * @return The style
*/
public ToStringStyle getToStringStyle() {
return style;
@@ -127,7 +127,7 @@ public ToStringStyle getToStringStyle() {
/**
* Returns an iterator over the {@link Diff} objects contained in this list.
*
- * @return the iterator
+ * @return The iterator
*/
@Override
public Iterator<Diff<?>> iterator() {
diff --git a/src/main/java/org/apache/commons/lang3/builder/IDKey.java b/src/main/java/org/apache/commons/lang3/builder/IDKey.java
index 910844adb..377b7dbf4 100644
--- a/src/main/java/org/apache/commons/lang3/builder/IDKey.java
+++ b/src/main/java/org/apache/commons/lang3/builder/IDKey.java
@@ -65,7 +65,7 @@ public boolean equals(final Object other) {
/**
* Gets the hash code, the system identity hash code.
*
- * @return the hash code.
+ * @return The hash code.
*/
@Override
public int hashCode() {
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 ca9da55e8..f4fdc40b9 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java
@@ -232,7 +232,7 @@ public DiffResult<T> build() {
/**
* Gets the field names that should be excluded from the diff.
*
- * @return the excludeFieldNames.
+ * @return The excludeFieldNames.
* @since 3.13.0
*/
public String[] getExcludeFieldNames() {
@@ -252,7 +252,7 @@ private T getRight() {
*
* @param field the field to use.
* @param target the object to call on, may be {@code null} for {@code static} fields.
- * @return the field value.
+ * @return The field value.
* @throws NullPointerException if the field is {@code null}.
* @throws IllegalAccessException if the field is not made accessible.
* @throws SecurityException if an underlying accessible object's method denies the request.
diff --git a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
index 417a109ce..c7cebea78 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionToStringBuilder.java
@@ -144,7 +144,7 @@ static String[] toNoNullStringArray(final Object[] array) {
*
* @param object
* the Object to be output
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object is {@code null}
*
@@ -177,7 +177,7 @@ public static String toString(final Object object) {
* the Object to be output
* @param style
* the style of the {@code toString} to create, may be {@code null}
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object or {@link ToStringStyle} is {@code null}
*
@@ -216,7 +216,7 @@ public static String toString(final Object object, final ToStringStyle style) {
* the style of the {@code toString} to create, may be {@code null}
* @param outputTransients
* whether to include transient fields
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object is {@code null}
*
@@ -262,7 +262,7 @@ public static String toString(final Object object, final ToStringStyle style, fi
* whether to include transient fields
* @param outputStatics
* whether to include static fields
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object is {@code null}
*
@@ -316,7 +316,7 @@ public static String toString(final Object object, final ToStringStyle style, fi
* whether to exclude fields whose values are null
* @param reflectUpToClass
* the superclass to reflect up to (inclusive), may be {@code null}
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object is {@code null}
*
@@ -371,7 +371,7 @@ public static <T> String toString(
* whether to include static fields
* @param reflectUpToClass
* the superclass to reflect up to (inclusive), may be {@code null}
- * @return the String result
+ * @return The String result
* @throws IllegalArgumentException
* if the Object is {@code null}
*
@@ -664,7 +664,7 @@ protected void appendFieldsIn(final Class<?> clazz) {
/**
* Gets the excludeFieldNames.
*
- * @return the excludeFieldNames.
+ * @return The excludeFieldNames.
*/
public String[] getExcludeFieldNames() {
return this.excludeFieldNames.clone();
@@ -673,7 +673,7 @@ public String[] getExcludeFieldNames() {
/**
* Gets the includeFieldNames
*
- * @return the includeFieldNames.
+ * @return The includeFieldNames.
* @since 3.13.0
*/
public String[] getIncludeFieldNames() {
@@ -833,7 +833,7 @@ public void setUpToClass(final Class<?> clazz) {
/**
* Gets the String built by this builder.
*
- * @return the built string
+ * @return The built string
*/
@Override
public String toString() {
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 6ebdb9ba1..f7c548678 100644
--- a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java
@@ -49,7 +49,7 @@ public StandardToStringStyle() {
/**
* Gets the array end text.
*
- * @return the current array end text
+ * @return The current array end text
*/
@Override
public String getArrayEnd() {
@@ -59,7 +59,7 @@ public String getArrayEnd() {
/**
* Gets the array separator text.
*
- * @return the current array separator text
+ * @return The current array separator text
*/
@Override
public String getArraySeparator() {
@@ -69,7 +69,7 @@ public String getArraySeparator() {
/**
* Gets the array start text.
*
- * @return the current array start text
+ * @return The current array start text
*/
@Override
public String getArrayStart() {
@@ -79,7 +79,7 @@ public String getArrayStart() {
/**
* Gets the content end text.
*
- * @return the current content end text
+ * @return The current content end text
*/
@Override
public String getContentEnd() {
@@ -89,7 +89,7 @@ public String getContentEnd() {
/**
* Gets the content start text.
*
- * @return the current content start text
+ * @return The current content start text
*/
@Override
public String getContentStart() {
@@ -99,7 +99,7 @@ public String getContentStart() {
/**
* Gets the field name value separator text.
*
- * @return the current field name value separator text
+ * @return The current field name value separator text
*/
@Override
public String getFieldNameValueSeparator() {
@@ -109,7 +109,7 @@ public String getFieldNameValueSeparator() {
/**
* Gets the field separator text.
*
- * @return the current field separator text
+ * @return The current field separator text
*/
@Override
public String getFieldSeparator() {
@@ -119,7 +119,7 @@ public String getFieldSeparator() {
/**
* Gets the text to output when {@code null} found.
*
- * @return the current text to output when {@code null} found
+ * @return The current text to output when {@code null} found
*/
@Override
public String getNullText() {
@@ -132,7 +132,7 @@ public String getNullText() {
*
* <p>This is output after the size value.</p>
*
- * @return the current end of size text
+ * @return The current end of size text
*/
@Override
public String getSizeEndText() {
@@ -145,7 +145,7 @@ public String getSizeEndText() {
*
* <p>This is output before the size value.</p>
*
- * @return the current start of size text
+ * @return The current start of size text
*/
@Override
public String getSizeStartText() {
@@ -158,7 +158,7 @@ public String getSizeStartText() {
*
* <p>This is output after the size value.</p>
*
- * @return the current end of summary text
+ * @return The current end of summary text
*/
@Override
public String getSummaryObjectEndText() {
@@ -171,7 +171,7 @@ public String getSummaryObjectEndText() {
*
* <p>This is output before the size value.</p>
*
- * @return the current start of summary text
+ * @return The current start of summary text
*/
@Override
public String getSummaryObjectStartText() {
@@ -181,7 +181,7 @@ public String getSummaryObjectStartText() {
/**
* Gets whether to output array content detail.
*
- * @return the current array content detail setting
+ * @return The current array content detail setting
*/
@Override
public boolean isArrayContentDetail() {
@@ -192,7 +192,7 @@ public boolean isArrayContentDetail() {
* Gets whether to use full detail when the caller doesn't
* specify.
*
- * @return the current defaultFullDetail flag
+ * @return The current defaultFullDetail flag
*/
@Override
public boolean isDefaultFullDetail() {
@@ -215,7 +215,7 @@ public boolean isFieldSeparatorAtEnd() {
* Gets whether the field separator should be added at the start
* of each buffer.
*
- * @return the fieldSeparatorAtStart flag
+ * @return The fieldSeparatorAtStart flag
* @since 2.0
*/
@Override
@@ -226,7 +226,7 @@ public boolean isFieldSeparatorAtStart() {
/**
* Gets whether to use the class name.
*
- * @return the current useClassName flag
+ * @return The current useClassName flag
*/
@Override
public boolean isUseClassName() {
@@ -236,7 +236,7 @@ public boolean isUseClassName() {
/**
* Gets whether to use the field names passed in.
*
- * @return the current useFieldNames flag
+ * @return The current useFieldNames flag
*/
@Override
public boolean isUseFieldNames() {
@@ -246,7 +246,7 @@ public boolean isUseFieldNames() {
/**
* Gets whether to use the identity hash code.
*
- * @return the current useIdentityHashCode flag
+ * @return The current useIdentityHashCode flag
*/
@Override
public boolean isUseIdentityHashCode() {
@@ -256,7 +256,7 @@ public boolean isUseIdentityHashCode() {
/**
* Gets whether to output short or long class names.
*
- * @return the current useShortClassName flag
+ * @return The current useShortClassName flag
* @since 2.0
*/
@Override
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 a5f2f0b54..935840215 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java
@@ -182,7 +182,7 @@ public static Builder builder() {
* <p>One reason for changing the default could be to have a verbose style during
* development and a compact style in production.</p>
*
- * @return the default {@link ToStringStyle}, never null
+ * @return The default {@link ToStringStyle}, never null
*/
public static ToStringStyle getDefaultStyle() {
return defaultStyle;
@@ -193,7 +193,7 @@ public static ToStringStyle getDefaultStyle() {
* {@code toString} for the specified object.
*
* @param object the Object to be output
- * @return the String result
+ * @return The String result
* @see ReflectionToStringBuilder#toString(Object)
*/
public static String reflectionToString(final Object object) {
@@ -206,7 +206,7 @@ public static String reflectionToString(final Object object) {
*
* @param object the Object to be output
* @param style the style of the {@code toString} to create, may be {@code null}
- * @return the String result
+ * @return The String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle)
*/
public static String reflectionToString(final Object object, final ToStringStyle style) {
@@ -220,7 +220,7 @@ public static String reflectionToString(final Object object, final ToStringStyle
* @param object the Object to be output
* @param style the style of the {@code toString} to create, may be {@code null}
* @param outputTransients whether to include transient fields
- * @return the String result
+ * @return The String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle,boolean)
*/
public static String reflectionToString(final Object object, final ToStringStyle style, final boolean outputTransients) {
@@ -236,7 +236,7 @@ public static String reflectionToString(final Object object, final ToStringStyle
* @param style the style of the {@code toString} to create, may be {@code null}
* @param outputTransients whether to include transient fields
* @param reflectUpToClass the superclass to reflect up to (inclusive), may be {@code null}
- * @return the String result
+ * @return The String result
* @see ReflectionToStringBuilder#toString(Object,ToStringStyle,boolean,boolean,Class)
* @since 2.0
*/
@@ -1044,7 +1044,7 @@ public ToStringBuilder appendToString(final String toString) {
* Returns the String that was build as an object representation. The
* default implementation utilizes the {@link #toString()} implementation.
*
- * @return the String {@code toString}
+ * @return The String {@code toString}
* @see #toString()
* @since 3.0
*/
@@ -1066,7 +1066,7 @@ public Object getObject() {
/**
* Gets the {@link StringBuffer} being populated.
*
- * @return the {@link StringBuffer} being populated
+ * @return The {@link StringBuffer} being populated
*/
public StringBuffer getStringBuffer() {
return buffer;
@@ -1075,7 +1075,7 @@ public StringBuffer getStringBuffer() {
/**
* Gets the {@link ToStringStyle} being used.
*
- * @return the {@link ToStringStyle} being used
+ * @return The {@link ToStringStyle} being used
* @since 2.0
*/
public ToStringStyle getStyle() {
@@ -1090,7 +1090,7 @@ public ToStringStyle getStyle() {
*
* <p>If the object is {@code null}, return the style's {@code nullText}</p>
*
- * @return the String {@code toString}
+ * @return The String {@code toString}
*/
@Override
public String toString() {
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 30e44779c..77e962b7b 100644
--- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
+++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
@@ -98,7 +98,7 @@ private static final class DefaultToStringStyle extends ToStringStyle {
/**
* Ensure Singleton after serialization.
*
- * @return the singleton.
+ * @return The singleton.
*/
private Object readResolve() {
return DEFAULT_STYLE;
@@ -316,7 +316,7 @@ private boolean isJsonObject(final String valueAsString) {
/**
* Ensure Singleton after serialization.
*
- * @return the singleton
+ * @return The singleton
*/
private Object readResolve() {
return JSON_STYLE;
@@ -351,7 +351,7 @@ private static final class MultiLineToStringStyle extends ToStringStyle {
/**
* Ensure Singleton after serialization.
*
- * @return the singleton.
+ * @return The singleton.
*/
private Object readResolve() {
return MULTI_LINE_STYLE;
@@ -384,7 +384,7 @@ private static final class NoClassNameToStringStyle extends ToStringStyle {
/**
* Ensure Singleton after serialization.
*
- * @return the singleton
+ * @return The singleton
*/
private Object readResolve() {
return NO_CLASS_NAME_STYLE;
@@ -416,7 +416,7 @@ private static final class NoFieldNameToStringStyle extends ToStringStyle {
/**
* Ensure Singleton after serialization.
*
- * @return the singleton
+ * @return The singleton
*/
private Object readResolve() {
return NO_FIELD_NAMES_STYLE;
@@ -449,7 +449,7 @@ private static final class ShortPrefixToStringStyle extends ToStringStyle {
/**
* Ensure {@code Singleton} after serialization.
*
- * @return the singleton.
+ * @return The singleton.
*/
private Object readResolve() {
return SHORT_PREFIX_STYLE;
@@ -485,7 +485,7 @@ private static final class SimpleToStringStyle extends ToStringStyle {
/**
* Ensure <code>Singleton</code> after serialization.
*
- * @return the singleton
+ * @return The singleton
*/
private Object readResolve() {
return SIMPLE_STYLE;
@@ -1804,7 +1804,7 @@ public void appendToString(final StringBuffer buffer, final String toString) {
/**
* Gets the array end text.
*
- * @return the current array end text.
+ * @return The current array end text.
*/
protected String getArrayEnd() {
return arrayEnd;
@@ -1813,7 +1813,7 @@ protected String getArrayEnd() {
/**
* Gets the array separator text.
*
- * @return the current array separator text.
+ * @return The current array separator text.
*/
protected String getArraySeparator() {
return arraySeparator;
@@ -1822,7 +1822,7 @@ protected String getArraySeparator() {
/**
* Gets the array start text.
*
- * @return the current array start text.
+ * @return The current array start text.
*/
protected String getArrayStart() {
return arrayStart;
@@ -1831,7 +1831,7 @@ protected String getArrayStart() {
/**
* Gets the content end text.
*
- * @return the current content end text.
+ * @return The current content end text.
*/
protected String getContentEnd() {
return contentEnd;
@@ -1840,7 +1840,7 @@ protected String getContentEnd() {
/**
* Gets the content start text.
*
- * @return the current content start text.
+ * @return The current content start text.
*/
protected String getContentStart() {
return contentStart;
@@ -1849,7 +1849,7 @@ protected String getContentStart() {
/**
* Gets the field name value separator text.
*
- * @return the current field name value separator text.
+ * @return The current field name value separator text.
*/
protected String getFieldNameValueSeparator() {
return fieldNameValueSeparator;
@@ -1858,7 +1858,7 @@ protected String getFieldNameValueSeparator() {
/**
* Gets the field separator text.
*
- * @return the current field separator text.
+ * @return The current field separator text.
*/
protected String getFieldSeparator() {
return fieldSeparator;
@@ -1867,7 +1867,7 @@ protected String getFieldSeparator() {
/**
* Gets the text to output when {@code null} found.
*
- * @return the current text to output when null found.
+ * @return The current text to output when null found.
*/
protected String getNullText() {
return nullText;
@@ -1881,7 +1881,7 @@ protected String getNullText() {
* </p>
*
* @param cls the {@link Class} to get the short name of.
- * @return the short name.
+ * @return The short name.
*/
protected String getShortClassName(final Class<?> cls) {
return ClassUtils.getShortClassName(cls);
@@ -1894,7 +1894,7 @@ protected String getShortClassName(final Class<?> cls) {
* This is output after the size value.
* </p>
*
- * @return the current end of size text.
+ * @return The current end of size text.
*/
protected String getSizeEndText() {
return sizeEndText;
@@ -1907,7 +1907,7 @@ protected String getSizeEndText() {
* This is output before the size value.
* </p>
*
- * @return the current start of size text.
+ * @return The current start of size text.
*/
protected String getSizeStartText() {
return sizeStartText;
@@ -1920,7 +1920,7 @@ protected String getSizeStartText() {
* This is output after the size value.
* </p>
*
- * @return the current end of summary text.
+ * @return The current end of summary text.
*/
protected String getSummaryObjectEndText() {
return summaryObjectEndText;
@@ -1933,7 +1933,7 @@ protected String getSummaryObjectEndText() {
* This is output before the size value.
* </p>
*
- * @return the current start of summary text.
+ * @return The current start of summary text.
*/
protected String getSummaryObjectStartText() {
return summaryObjectStartText;
@@ -1942,7 +1942,7 @@ protected String getSummaryObjectStartText() {
/**
* Gets whether to output array content detail.
*
- * @return the current array content detail setting.
+ * @return The current array content detail setting.
*/
protected boolean isArrayContentDetail() {
return arrayContentDetail;
@@ -1951,7 +1951,7 @@ protected boolean isArrayContentDetail() {
/**
* Gets whether to use full detail when the caller doesn't specify.
*
- * @return the current defaultFullDetail flag.
+ * @return The current defaultFullDetail flag.
*/
protected boolean isDefaultFullDetail() {
return defaultFullDetail;
@@ -1970,7 +1970,7 @@ protected boolean isFieldSeparatorAtEnd() {
/**
* Gets whether the field separator should be added at the start of each buffer.
*
- * @return the fieldSeparatorAtStart flag.
+ * @return The fieldSeparatorAtStart flag.
* @since 2.0
*/
protected boolean isFieldSeparatorAtStart() {
@@ -2002,7 +2002,7 @@ protected boolean isFullDetail(final Boolean fullDetailRequest) {
/**
* Gets whether to use the class name.
*
- * @return the current useClassName flag.
+ * @return The current useClassName flag.
*/
protected boolean isUseClassName() {
return useClassName;
@@ -2011,7 +2011,7 @@ protected boolean isUseClassName() {
/**
* Gets whether to use the field names passed in.
*
- * @return the current useFieldNames flag.
+ * @return The current useFieldNames flag.
*/
protected boolean isUseFieldNames() {
return useFieldNames;
@@ -2020,7 +2020,7 @@ protected boolean isUseFieldNames() {
/**
* Gets whether to use the identity hash code.
*
- * @return the current useIdentityHashCode flag.
+ * @return The current useIdentityHashCode flag.
*/
protected boolean isUseIdentityHashCode() {
return useIdentityHashCode;
@@ -2029,7 +2029,7 @@ protected boolean isUseIdentityHashCode() {
/**
* Gets whether to output short or long class names.
*
- * @return the current useShortClassName flag.
+ * @return The current useShortClassName flag.
* @since 2.0
*/
protected boolean isUseShortClassName() {
diff --git a/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java b/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
index 8150b2423..e73aff672 100644
--- a/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
+++ b/src/main/java/org/apache/commons/lang3/compare/ComparableUtils.java
@@ -215,7 +215,7 @@ public static <A extends Comparable<A>> Predicate<A> lt(final A b) {
* @param <A> Type of what we are comparing.
* @param comparable1 the first comparable, may be null.
* @param comparable2 the second comparable, may be null.
- * @return the largest of {@code comparable1} and {@code comparable2}.
+ * @return The largest of {@code comparable1} and {@code comparable2}.
* @see ObjectUtils#max(Comparable...)
* @since 3.13.0
*/
@@ -232,7 +232,7 @@ public static <A extends Comparable<A>> A max(final A comparable1, final A compa
* @param <A> Type of what we are comparing.
* @param comparable1 the first comparable, may be null.
* @param comparable2 the second comparable, may be null.
- * @return the smallest of {@code comparable1} and {@code comparable2}.
+ * @return The smallest of {@code comparable1} and {@code comparable2}.
* @see ObjectUtils#min(Comparable...)
* @since 3.13.0
*/
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 1c2150ada..cc74996bd 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
@@ -62,7 +62,7 @@ public State oppositeState() {
* Returns the opposite state to the represented state. This is useful
* for flipping the current state.
*
- * @return the opposite state
+ * @return The opposite state
*/
public abstract State oppositeState();
}
@@ -77,7 +77,7 @@ public State oppositeState() {
* Converts the given state value to a boolean <em>open</em> property.
*
* @param state the state to be converted
- * @return the boolean open flag
+ * @return The boolean open flag
*/
protected static boolean isOpen(final State state) {
return state == State.OPEN;
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 d92bb67db..32dd60cc4 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java
@@ -64,7 +64,7 @@ public AbstractBuilder() {
/**
* Gets the closer consumer called by {@link #close()}.
*
- * @return the closer consumer called by {@link #close()}.
+ * @return The closer consumer called by {@link #close()}.
*/
public FailableConsumer<T, ? extends Exception> getCloser() {
return closer;
@@ -73,7 +73,7 @@ public AbstractBuilder() {
/**
* Gets the initializer supplier called by {@link #initialize()}.
*
- * @return the initializer supplier called by {@link #initialize()}.
+ * @return The initializer supplier called by {@link #initialize()}.
*/
public FailableSupplier<T, ? extends Exception> getInitializer() {
return initializer;
@@ -170,7 +170,7 @@ public void close() throws ConcurrentException {
* Subclasses and clients that do not provide an initializer are expected to implement this method.
* </p>
*
- * @return the managed data object.
+ * @return The managed data object.
* @throws E if an error occurs during object creation.
*/
@SuppressWarnings("unchecked")
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/AbstractFutureProxy.java b/src/main/java/org/apache/commons/lang3/concurrent/AbstractFutureProxy.java
index 9793dfe1f..890a0f113 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractFutureProxy.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractFutureProxy.java
@@ -59,7 +59,7 @@ public V get(final long timeout, final TimeUnit unit) throws InterruptedExceptio
/**
* Gets the delegate.
*
- * @return the delegate.
+ * @return The delegate.
*/
public Future<V> getFuture() {
return future;
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 1be7b77bf..67df27cb8 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/AtomicInitializer.java
@@ -128,7 +128,7 @@ private AtomicInitializer(final FailableSupplier<T, ConcurrentException> initial
* Gets the object managed by this initializer. The object is created if it is not available yet and stored internally. This method always returns the same
* object.
*
- * @return the object created by this {@link AtomicInitializer}.
+ * @return The object created by this {@link AtomicInitializer}.
* @throws ConcurrentException if an error occurred during initialization of the object.
*/
@Override
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 b07d565d4..153955a96 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -146,7 +146,7 @@ private final class InitializationTask implements Callable<T> {
/**
* Initiates initialization and returns the result.
*
- * @return the result object
+ * @return The result object
* @throws Exception if an error occurs
*/
@Override
@@ -219,7 +219,7 @@ private BackgroundInitializer(final FailableSupplier<T, ConcurrentException> ini
* Creates the {@link ExecutorService} to be used. This method is called if
* no {@link ExecutorService} was provided at construction time.
*
- * @return the {@link ExecutorService} to be used.
+ * @return The {@link ExecutorService} to be used.
*/
private ExecutorService createExecutor() {
return Executors.newFixedThreadPool(getTaskCount());
@@ -249,7 +249,7 @@ private Callable<T> createTask(final ExecutorService execDestroy) {
* was called causes an {@link IllegalStateException} exception to be
* thrown.
*
- * @return the object produced by this initializer.
+ * @return The object produced by this initializer.
* @throws ConcurrentException if a checked exception occurred during
* background processing.
* @throws IllegalStateException if {@link #start()} has not been called.
@@ -275,7 +275,7 @@ public T get() throws ConcurrentException {
* was set, this is also the active executor. Otherwise this method returns
* the temporary executor that was created by this object.
*
- * @return the {@link ExecutorService} for executing the background task.
+ * @return The {@link ExecutorService} for executing the background task.
*/
protected final synchronized ExecutorService getActiveExecutor() {
return executor;
@@ -284,7 +284,7 @@ protected final synchronized ExecutorService getActiveExecutor() {
/**
* Gets the external {@link ExecutorService} to be used by this class.
*
- * @return the {@link ExecutorService}.
+ * @return The {@link ExecutorService}.
*/
public final synchronized ExecutorService getExternalExecutor() {
return externalExecutor;
@@ -295,7 +295,7 @@ public final synchronized ExecutorService getExternalExecutor() {
* was called. Therefore this method can only be called after {@code
* start()}.
*
- * @return the {@link Future} object wrapped by this initializer.
+ * @return The {@link Future} object wrapped by this initializer.
* @throws IllegalStateException if {@link #start()} has not been called.
*/
public synchronized Future<T> getFuture() {
@@ -314,7 +314,7 @@ public synchronized Future<T> getFuture() {
* method. Therefore overriding methods should be careful with obtaining
* other locks and return as fast as possible.
*
- * @return the number of background tasks required by this initializer.
+ * @return The number of background tasks required by this initializer.
*/
protected int getTaskCount() {
return 1;
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 0359251ca..b55e1c8a3 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/BasicThreadFactory.java
@@ -139,7 +139,7 @@ public Builder() {
* options that have been specified by calling methods on this builder.
* After creating the factory {@link #reset()} is called.
*
- * @return the new {@link BasicThreadFactory}.
+ * @return The new {@link BasicThreadFactory}.
*/
@Override
public BasicThreadFactory build() {
@@ -298,7 +298,7 @@ private BasicThreadFactory(final Builder builder) {
* calls {@code setDaemon(true)} on the newly created threads. Result can be
* {@code null} if no daemon flag was provided at creation time.
*
- * @return the daemon flag.
+ * @return The daemon flag.
*/
public final Boolean getDaemonFlag() {
return daemon;
@@ -312,7 +312,7 @@ public final Boolean getDaemonFlag() {
* the second one {@code "MyThread-2"} and so on.
* </p>
*
- * @return the naming pattern.
+ * @return The naming pattern.
*/
public final String getNamingPattern() {
return namingPattern;
@@ -322,7 +322,7 @@ public final String getNamingPattern() {
* Gets the priority of the threads created by this factory. Result can
* be {@code null} if no priority was specified.
*
- * @return the priority for newly created threads.
+ * @return The priority for newly created threads.
*/
public final Integer getPriority() {
return priority;
@@ -333,7 +333,7 @@ public final Integer getPriority() {
* class maintains an internal counter that is incremented each time the
* {@link #newThread(Runnable)} method is invoked.
*
- * @return the number of threads created by this factory.
+ * @return The number of threads created by this factory.
*/
public long getThreadCount() {
return threadCounter.get();
@@ -343,7 +343,7 @@ public long getThreadCount() {
* Gets the {@link UncaughtExceptionHandler} for the threads created by
* this factory. Result can be {@code null} if no handler was provided.
*
- * @return the {@link UncaughtExceptionHandler}.
+ * @return The {@link UncaughtExceptionHandler}.
*/
public final Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
return uncaughtExceptionHandler;
@@ -355,7 +355,7 @@ public final Thread.UncaughtExceptionHandler getUncaughtExceptionHandler() {
* {@link ThreadFactory} was passed when this object was created, a default
* thread factory is returned.
*
- * @return the wrapped {@link ThreadFactory}.
+ * @return The wrapped {@link ThreadFactory}.
*/
public final ThreadFactory getWrappedFactory() {
return wrappedFactory;
@@ -391,7 +391,7 @@ private void initializeThread(final Thread thread) {
* corresponding configuration options are set.
*
* @param runnable the {@link Runnable} to be executed by the new thread.
- * @return the newly created thread.
+ * @return The newly created thread.
*/
@Override
public Thread newThread(final Runnable runnable) {
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 a5ab64006..ec9cb82be 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
@@ -117,7 +117,7 @@ protected Exception getTypedException(final Exception e) {
/**
* Performs initialization in a background thread. This implementation delegates to the {@link Callable} passed at construction time of this object.
*
- * @return the result of the initialization.
+ * @return The result of the initialization.
* @throws Exception if an error occurs.
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
index 8eedc898b..799f3d48c 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/CircuitBreaker.java
@@ -72,7 +72,7 @@ public interface CircuitBreaker<T> {
* <strong>true</strong> means that the circuit breaker is currently closed. This
* means that everything is okay with the monitored subsystem.
*
- * @return the current closed state of this circuit breaker.
+ * @return The current closed state of this circuit breaker.
*/
boolean isClosed();
@@ -81,7 +81,7 @@ public interface CircuitBreaker<T> {
* <strong>true</strong> means that the circuit breaker is currently open indicating a
* problem in the monitored subsystem.
*
- * @return the current open state of this circuit breaker.
+ * @return The current open state of this circuit breaker.
*/
boolean isOpen();
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/Computable.java b/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
index 6ec1beb67..d051c272e 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/Computable.java
@@ -38,7 +38,7 @@ public interface Computable<I, O> {
*
* @param arg
* the argument for the calculation
- * @return the result of the calculation
+ * @return The result of the calculation
* @throws InterruptedException
* thrown if the calculation is interrupted
*/
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 446a4984d..7518fd519 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -146,7 +146,7 @@ public static <T> Future<T> constantFuture(final T value) {
* @param map the map to be modified
* @param key the key of the value to be added
* @param init the {@link ConcurrentInitializer} for creating the value
- * @return the value stored in the map after this operation; this may or may
+ * @return The value stored in the map after this operation; this may or may
* not be the object created by the {@link ConcurrentInitializer}
* @throws ConcurrentException if the initializer throws an exception
*/
@@ -174,7 +174,7 @@ public static <K, V> V createIfAbsent(final ConcurrentMap<K, V> map, final K key
* @param map the map to be modified
* @param key the key of the value to be added
* @param init the {@link ConcurrentInitializer} for creating the value
- * @return the value stored in the map after this operation; this may or may
+ * @return The value stored in the map after this operation; this may or may
* not be the object created by the {@link ConcurrentInitializer}
* @throws ConcurrentRuntimeException if the initializer throws an exception
*/
@@ -282,7 +282,7 @@ public static void handleCauseUnchecked(final ExecutionException ex) {
*
* @param <T> The type of the object produced by the initializer
* @param initializer the {@link ConcurrentInitializer} to be invoked
- * @return the object managed by the {@link ConcurrentInitializer}
+ * @return The object managed by the {@link ConcurrentInitializer}
* @throws ConcurrentException if the {@link ConcurrentInitializer} throws
* an exception
*/
@@ -301,7 +301,7 @@ public static <T> T initialize(final ConcurrentInitializer<T> initializer)
*
* @param <T> The type of the object produced by the initializer
* @param initializer the {@link ConcurrentInitializer} to be invoked
- * @return the object managed by the {@link ConcurrentInitializer}
+ * @return The object managed by the {@link ConcurrentInitializer}
* @throws ConcurrentRuntimeException if the initializer throws an exception
*/
public static <T> T initializeUnchecked(final ConcurrentInitializer<T> initializer) {
@@ -342,7 +342,7 @@ public static <T> T initializeUnchecked(final ConcurrentInitializer<T> initializ
* @param map the map to be modified
* @param key the key of the value to be added
* @param value the value to be added
- * @return the value stored in the map after this operation
+ * @return The value stored in the map after this operation
*/
public static <K, V> V putIfAbsent(final ConcurrentMap<K, V> map, final K key, final V value) {
if (map == null) {
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
index 15aebdb86..b471e330c 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
@@ -83,7 +83,7 @@ public boolean equals(final Object obj) {
* Gets the object managed by this initializer. This implementation just
* returns the object passed to the constructor.
*
- * @return the object managed by this initializer
+ * @return The object managed by this initializer
* @throws ConcurrentException if an error occurs
*/
@Override
@@ -96,7 +96,7 @@ public T get() throws ConcurrentException {
* the same object as returned by {@code get()}. However, this method does
* not declare that it throws an exception.
*
- * @return the object managed by this initializer
+ * @return The object managed by this initializer
*/
public final T getObject() {
return object;
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 c40f919a5..08c32dc92 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java
@@ -150,7 +150,7 @@ private abstract static class AbstractStateStrategy {
* {@link CircuitBreaker}.
*
* @param breaker the {@link CircuitBreaker}
- * @return the check interval to be applied
+ * @return The check interval to be applied
*/
protected abstract long fetchCheckInterval(EventCountCircuitBreaker breaker);
@@ -208,7 +208,7 @@ private static final class CheckIntervalData {
/**
* Gets the start time of the current check interval.
*
- * @return the check interval start time
+ * @return The check interval start time
*/
public long getCheckIntervalStart() {
return checkIntervalStart;
@@ -217,7 +217,7 @@ public long getCheckIntervalStart() {
/**
* Gets the event counter.
*
- * @return the number of received events
+ * @return The number of received events
*/
public int getEventCount() {
return eventCount;
@@ -228,7 +228,7 @@ public int getEventCount() {
* incremented by the given delta. If the delta is 0, this object is returned.
*
* @param delta the delta
- * @return the updated instance
+ * @return The updated instance
*/
public CheckIntervalData increment(final int delta) {
return delta == 0 ? this : new CheckIntervalData(getEventCount() + delta,
@@ -291,7 +291,7 @@ public boolean isStateTransition(final EventCountCircuitBreaker breaker,
* Creates the map with strategy objects. It allows access for a strategy for a given
* state.
*
- * @return the strategy map
+ * @return The strategy map
*/
private static Map<State, AbstractStateStrategy> createStrategyMap() {
final Map<State, AbstractStateStrategy> map = new EnumMap<>(State.class);
@@ -304,7 +304,7 @@ private static Map<State, AbstractStateStrategy> createStrategyMap() {
* Returns the {@link AbstractStateStrategy} object responsible for the given state.
*
* @param state the state
- * @return the corresponding {@link AbstractStateStrategy}
+ * @return The corresponding {@link AbstractStateStrategy}
* @throws CircuitBreakingException if the strategy cannot be resolved
*/
private static AbstractStateStrategy stateStrategy(final State state) {
@@ -427,7 +427,7 @@ public void close() {
/**
* Gets the interval (in nanoseconds) for checking for the closing threshold.
*
- * @return the opening check interval
+ * @return The opening check interval
*/
public long getClosingInterval() {
return closingInterval;
@@ -438,7 +438,7 @@ public long getClosingInterval() {
* events received in the time span determined by the closing interval goes below this
* threshold, the circuit breaker is closed again.
*
- * @return the closing threshold
+ * @return The closing threshold
*/
public int getClosingThreshold() {
return closingThreshold;
@@ -447,7 +447,7 @@ public int getClosingThreshold() {
/**
* Gets the interval (in nanoseconds) for checking for the opening threshold.
*
- * @return the opening check interval
+ * @return The opening check interval
*/
public long getOpeningInterval() {
return openingInterval;
@@ -458,7 +458,7 @@ public long getOpeningInterval() {
* events is received in the time span determined by the opening interval, the circuit
* breaker is opened.
*
- * @return the opening threshold
+ * @return The opening threshold
*/
public int getOpeningThreshold() {
return openingThreshold;
@@ -488,7 +488,7 @@ public boolean incrementAndCheckState(final Integer increment) {
* Returns the current time in nanoseconds. This method is used to obtain the current
* time. This is needed to calculate the check intervals correctly.
*
- * @return the current time in nanoseconds
+ * @return The current time in nanoseconds
*/
long nanoTime() {
return System.nanoTime();
@@ -503,7 +503,7 @@ long nanoTime() {
* @param currentData the current check data object
* @param currentState the current state of the circuit breaker
* @param time the current time
- * @return the updated {@link CheckIntervalData} object
+ * @return The updated {@link CheckIntervalData} object
*/
private CheckIntervalData nextCheckIntervalData(final int increment,
final CheckIntervalData currentData, final State currentState, final long time) {
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 75d66de63..9806b4a0d 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/LazyInitializer.java
@@ -135,7 +135,7 @@ private LazyInitializer(final FailableSupplier<T, ConcurrentException> initializ
/**
* Gets the object wrapped by this instance. On first access the object is created. After that it is cached and can be accessed pretty fast.
*
- * @return the object initialized by this {@link LazyInitializer}.
+ * @return The object initialized by this {@link LazyInitializer}.
* @throws ConcurrentException if an error occurred during initialization of the object.
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java b/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
index d0ecf86eb..cbae0c931 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/Memoizer.java
@@ -116,7 +116,7 @@ public Memoizer(final Function<I, O> function, final boolean recalculate) {
* </p>
*
* @param arg the argument for the calculation
- * @return the result of the calculation
+ * @return The result of the calculation
* @throws InterruptedException thrown if the calculation is interrupted
*/
@Override
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 733d86352..fe90b20de 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
@@ -137,7 +137,7 @@ private MultiBackgroundInitializerResults(final Map<String, BackgroundInitialize
* is returned.
*
* @param name the name to check.
- * @return the initializer with this name.
+ * @return The initializer with this name.
* @throws NoSuchElementException if the name is unknown.
*/
private BackgroundInitializer<?> checkName(final String name) {
@@ -155,7 +155,7 @@ private BackgroundInitializer<?> checkName(final String name) {
* {@code null}. If the name cannot be resolved, an exception is thrown.
*
* @param name the name of the {@link BackgroundInitializer}.
- * @return the exception thrown by this initializer.
+ * @return The exception thrown by this initializer.
* @throws NoSuchElementException if the name cannot be resolved.
*/
public ConcurrentException getException(final String name) {
@@ -168,7 +168,7 @@ public ConcurrentException getException(final String name) {
* name cannot be resolved, an exception is thrown.
*
* @param name the name of the {@link BackgroundInitializer}.
- * @return the {@link BackgroundInitializer} with this name.
+ * @return The {@link BackgroundInitializer} with this name.
* @throws NoSuchElementException if the name cannot be resolved.
*/
public BackgroundInitializer<?> getInitializer(final String name) {
@@ -181,7 +181,7 @@ public BackgroundInitializer<?> getInitializer(final String name) {
* {@link BackgroundInitializer} caused an exception, {@code null} is returned. If the name cannot be resolved, an exception is thrown.
*
* @param name the name of the {@link BackgroundInitializer}.
- * @return the result object produced by this {@code BackgroundInitializer}.
+ * @return The result object produced by this {@code BackgroundInitializer}.
* @throws NoSuchElementException if the name cannot be resolved.
*/
public Object getResultObject(final String name) {
@@ -300,7 +300,7 @@ public void close() throws ConcurrentException {
* ). Then it adds 1 for the control task that waits for the completion of
* the children.
*
- * @return the number of tasks required for background processing.
+ * @return The number of tasks required for background processing.
*/
@Override
protected int getTaskCount() {
@@ -314,7 +314,7 @@ protected int getTaskCount() {
* data. If a child initializer throws a checked exceptions, it is added to
* the results object. Unchecked exceptions are propagated.
*
- * @return the results object.
+ * @return The results object.
* @throws Exception if an error occurs.
*/
@Override
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 6b7d8719c..f444d3e45 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ThresholdCircuitBreaker.java
@@ -99,7 +99,7 @@ public void close() {
/**
* Gets the threshold.
*
- * @return the threshold
+ * @return The threshold
*/
public long getThreshold() {
return threshold;
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java b/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java
index b389f33bf..b77a89c43 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java
@@ -333,7 +333,7 @@ synchronized void endOfPeriod() {
/**
* Gets the number of invocations of the {@link #acquire()} method for the current period. This may be useful for testing or debugging purposes.
*
- * @return the current number of {@link #acquire()} invocations.
+ * @return The current number of {@link #acquire()} invocations.
*/
public synchronized int getAcquireCount() {
return acquireCount;
@@ -344,7 +344,7 @@ public synchronized int getAcquireCount() {
* indication whether it is safe to call the {@link #acquire()} method without risking to be suspended. However, there is no guarantee that a subsequent
* call to {@link #acquire()} actually is not-blocking because in the meantime other threads may have invoked the semaphore.
*
- * @return the current number of available {@link #acquire()} calls in the current period.
+ * @return The current number of available {@link #acquire()} calls in the current period.
*/
public synchronized int getAvailablePermits() {
return getLimit() - getAcquireCount();
@@ -354,7 +354,7 @@ public synchronized int getAvailablePermits() {
* Gets the average number of successful (i.e. non-blocking) {@link #acquire()} invocations for the entire life-time of this {@code
* TimedSemaphore}. This method can be used for instance for statistical calculations.
*
- * @return the average number of {@link #acquire()} invocations per time unit.
+ * @return The average number of {@link #acquire()} invocations per time unit.
*/
public synchronized double getAverageCallsPerPeriod() {
return periodCount == 0 ? 0 : (double) totalAcquireCount / (double) periodCount;
@@ -363,7 +363,7 @@ public synchronized double getAverageCallsPerPeriod() {
/**
* Gets the executor service used by this instance.
*
- * @return the executor service.
+ * @return The executor service.
*/
protected ScheduledExecutorService getExecutorService() {
return executorService;
@@ -374,7 +374,7 @@ protected ScheduledExecutorService getExecutorService() {
* blocking. This can be useful for testing or debugging purposes or to determine a meaningful threshold value. If a limit is set, the value returned by
* this method won't be greater than this limit.
*
- * @return the number of non-blocking invocations of the {@link #acquire()} method.
+ * @return The number of non-blocking invocations of the {@link #acquire()} method.
*/
public synchronized int getLastAcquiresPerPeriod() {
return lastCallsPerPeriod;
@@ -383,7 +383,7 @@ public synchronized int getLastAcquiresPerPeriod() {
/**
* Gets the limit enforced by this semaphore. The limit determines how many invocations of {@link #acquire()} are allowed within the monitored period.
*
- * @return the limit.
+ * @return The limit.
*/
public final synchronized int getLimit() {
return limit;
@@ -393,7 +393,7 @@ public final synchronized int getLimit() {
* Gets the time period. This is the time monitored by this semaphore. Only a given number of invocations of the {@link #acquire()} method is possible in
* this period.
*
- * @return the time period.
+ * @return The time period.
*/
public long getPeriod() {
return period;
@@ -402,7 +402,7 @@ public long getPeriod() {
/**
* Gets the time unit. This is the unit used by {@link #getPeriod()}.
*
- * @return the time unit.
+ * @return The time unit.
*/
public TimeUnit getUnit() {
return unit;
diff --git a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
index 3f6f77b16..b55c04e2a 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/locks/LockingVisitors.java
@@ -401,7 +401,7 @@ public <T> T applyWriteLocked(final FailableFunction<O, T, ?> function) {
/**
* Gets the lock.
*
- * @return the lock.
+ * @return The lock.
*/
public L getLock() {
return lock;
@@ -410,7 +410,7 @@ public L getLock() {
/**
* Gets the guarded object.
*
- * @return the object.
+ * @return The object.
*/
public O getObject() {
return object;
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 a4e69b367..77970ca76 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventListenerSupport.java
@@ -113,7 +113,7 @@ protected void handle(final Throwable t) throws IllegalAccessException, IllegalA
* @param unusedProxy the proxy object representing a listener on which the invocation was called; not used
* @param method the listener method that will be called on all of the listeners.
* @param args event arguments to propagate to the listeners.
- * @return the result of the method call
+ * @return The result of the method call
* @throws InvocationTargetException if an error occurs
* @throws IllegalArgumentException if an error occurs
* @throws IllegalAccessException if an error occurs
@@ -282,7 +282,7 @@ public L fire() {
/**
* Gets the number of registered listeners.
*
- * @return the number of registered listeners.
+ * @return The number of registered listeners.
*/
int getListenerCount() {
return listeners.size();
diff --git a/src/main/java/org/apache/commons/lang3/event/EventUtils.java b/src/main/java/org/apache/commons/lang3/event/EventUtils.java
index 717be028c..43eba439f 100644
--- a/src/main/java/org/apache/commons/lang3/event/EventUtils.java
+++ b/src/main/java/org/apache/commons/lang3/event/EventUtils.java
@@ -67,7 +67,7 @@ private boolean hasMatchingParametersMethod(final Method method) {
* @param proxy the proxy instance.
* @param method the method to be invoked.
* @param parameters the parameters for the method invocation.
- * @return the result of the method call.
+ * @return The result of the method call.
* @throws SecurityException if an underlying accessible object's method denies the request.
* @see SecurityManager#checkPermission
* @throws Throwable if an error occurs
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 ad6b6dcfa..35815880c 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ContextedException.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ContextedException.java
@@ -215,7 +215,7 @@ public String getFormattedExceptionMessage(final String baseMessage) {
* Provides the message explaining the exception, including the contextual data.
*
* @see Throwable#getMessage()
- * @return the message, never null
+ * @return The message, never null
*/
@Override
public String getMessage() {
@@ -226,7 +226,7 @@ public String getMessage() {
* Provides the message explaining the exception without the contextual data.
*
* @see Throwable#getMessage()
- * @return the message
+ * @return The message
* @since 3.0.1
*/
public String getRawMessage() {
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 550276268..949ce1097 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ContextedRuntimeException.java
@@ -215,7 +215,7 @@ public String getFormattedExceptionMessage(final String baseMessage) {
* Provides the message explaining the exception, including the contextual data.
*
* @see Throwable#getMessage()
- * @return the message, never null
+ * @return The message, never null
*/
@Override
public String getMessage() {
@@ -226,7 +226,7 @@ public String getMessage() {
* Provides the message explaining the exception without the contextual data.
*
* @see Throwable#getMessage()
- * @return the message
+ * @return The message
* @since 3.0.1
*/
public String getRawMessage() {
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 0fd7467fc..1e37437ca 100644
--- a/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
+++ b/src/main/java/org/apache/commons/lang3/exception/DefaultExceptionContext.java
@@ -99,7 +99,7 @@ public Object getFirstContextValue(final String label) {
* Builds the message containing the contextual information.
*
* @param baseMessage the base exception message <strong>without</strong> context information appended
- * @return the exception message <strong>with</strong> context information appended, never null
+ * @return The exception message <strong>with</strong> context information appended, never null
*/
@Override
public String getFormattedExceptionMessage(final String baseMessage) {
diff --git a/src/main/java/org/apache/commons/lang3/exception/ExceptionContext.java b/src/main/java/org/apache/commons/lang3/exception/ExceptionContext.java
index 0d6943424..9e52c8646 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionContext.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionContext.java
@@ -51,14 +51,14 @@ public interface ExceptionContext {
/**
* Gets the full list of label-value pairs defined in the contextual data.
*
- * @return the list of pairs, not {@code null}
+ * @return The list of pairs, not {@code null}
*/
List<Pair<String, Object>> getContextEntries();
/**
* Gets the full set of labels defined in the contextual data.
*
- * @return the set of labels, not {@code null}
+ * @return The set of labels, not {@code null}
*/
Set<String> getContextLabels();
@@ -66,7 +66,7 @@ public interface ExceptionContext {
* Gets all the contextual data values associated with the label.
*
* @param label the label to get the contextual values for, may be {@code null}
- * @return the contextual values associated with the label, never {@code null}
+ * @return The contextual values associated with the label, never {@code null}
*/
List<Object> getContextValues(String label);
@@ -74,7 +74,7 @@ public interface ExceptionContext {
* Gets the first available contextual data value associated with the label.
*
* @param label the label to get the contextual value for, may be {@code null}
- * @return the first contextual value associated with the label, may be {@code null}
+ * @return The first contextual value associated with the label, may be {@code null}
*/
Object getFirstContextValue(String label);
@@ -83,7 +83,7 @@ public interface ExceptionContext {
* This will add the context label-value pairs to the message.
*
* @param baseMessage the base exception message <strong>without</strong> context information appended
- * @return the exception message <strong>with</strong> context information appended, not {@code null}
+ * @return The exception message <strong>with</strong> context information appended, not {@code null}
*/
String getFormattedExceptionMessage(String baseMessage);
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 1ea737f24..f51a4be9f 100644
--- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
+++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java
@@ -206,7 +206,7 @@ public static void forEach(final Throwable throwable, final Consumer<Throwable>
* </p>
*
* @param throwable the throwable to introspect for a cause, may be null.
- * @return the cause of the {@link Throwable}, {@code null} if none found or null throwable input.
+ * @return The cause of the {@link Throwable}, {@code null} if none found or null throwable input.
* @since 1.0
* @deprecated This feature will be removed in Lang 4, use {@link Throwable#getCause} instead.
*/
@@ -224,7 +224,7 @@ public static Throwable getCause(final Throwable throwable) {
*
* @param throwable the throwable to introspect for a cause, may be null.
* @param methodNames the method names, null treated as default set.
- * @return the cause of the {@link Throwable}, {@code null} if none found or null throwable input.
+ * @return The cause of the {@link Throwable}, {@code null} if none found or null throwable input.
* @since 1.0
* @deprecated This feature will be removed in Lang 4, use {@link Throwable#getCause} instead.
*/
@@ -248,7 +248,7 @@ public static Throwable getCause(final Throwable throwable, String[] methodNames
*
* @param throwable the exception to examine.
* @param methodName the name of the method to find and invoke.
- * @return the wrapped exception, or {@code null} if not found.
+ * @return The wrapped exception, or {@code null} if not found.
*/
// TODO: Remove in Lang 4
private static Throwable getCauseUsingMethodName(final Throwable throwable, final String methodName) {
@@ -287,7 +287,7 @@ public static String[] getDefaultCauseMethodNames() {
* </p>
*
* @param th the throwable to get a message for, null returns empty string.
- * @return the message, non-null.
+ * @return The message, non-null.
* @since 2.2
*/
public static String getMessage(final Throwable th) {
@@ -311,7 +311,7 @@ public static String getMessage(final Throwable th) {
* processed. If we detect a loop, then return the element before the loop.</p>
*
* @param throwable the throwable to get the root cause for, may be null.
- * @return the root cause of the {@link Throwable},
+ * @return The root cause of the {@link Throwable},
* {@code null} if null throwable input.
*/
public static Throwable getRootCause(final Throwable throwable) {
@@ -327,7 +327,7 @@ public static Throwable getRootCause(final Throwable throwable) {
* </p>
*
* @param throwable the throwable to get a message for, null returns empty string.
- * @return the message, non-null.
+ * @return The message, non-null.
* @since 2.2
*/
public static String getRootCauseMessage(final Throwable throwable) {
@@ -460,7 +460,7 @@ public static String[] getStackFrames(final Throwable throwable) {
* </p>
*
* @param throwable the {@link Throwable} to be examined, may be null.
- * @return the stack trace as generated by the exception's
+ * @return The stack trace as generated by the exception's
* {@code printStackTrace(PrintWriter)} method, or an empty String if {@code null} input.
*/
public static String getStackTrace(final Throwable throwable) {
@@ -486,7 +486,7 @@ public static String getStackTrace(final Throwable throwable) {
* chain is already in the result.</p>
*
* @param throwable the throwable to inspect, may be null.
- * @return the count of throwables, zero on null input.
+ * @return The count of throwables, zero on null input.
*/
public static int getThrowableCount(final Throwable throwable) {
return getThrowableList(throwable).size();
@@ -508,7 +508,7 @@ public static int getThrowableCount(final Throwable throwable) {
* in the result list.</p>
*
* @param throwable the throwable to inspect, may be null.
- * @return the list of throwables, never null.
+ * @return The list of throwables, never null.
* @since 2.2
*/
public static List<Throwable> getThrowableList(Throwable throwable) {
@@ -536,7 +536,7 @@ public static List<Throwable> getThrowableList(Throwable throwable) {
* chain is already in the result array.</p>
*
* @param throwable the throwable to inspect, may be null.
- * @return the array of throwables, never null.
+ * @return The array of throwables, never null.
* @see #getThrowableList(Throwable)
*/
public static Throwable[] getThrowables(final Throwable throwable) {
@@ -612,7 +612,7 @@ private static int indexOf(final Throwable throwable, final Class<? extends Thro
*
* @param throwable the throwable to inspect, may be null.
* @param clazz the class to search for, subclasses do not match, null returns -1.
- * @return the index into the throwable chain, -1 if no match or null input.
+ * @return The index into the throwable chain, -1 if no match or null input.
*/
public static int indexOfThrowable(final Throwable throwable, final Class<? extends Throwable> clazz) {
return indexOf(throwable, clazz, 0, false);
@@ -630,7 +630,7 @@ public static int indexOfThrowable(final Throwable throwable, final Class<? exte
* @param throwable the throwable to inspect, may be null.
* @param clazz the class to search for, subclasses do not match, null returns -1.
* @param fromIndex the (zero-based) index of the starting position, negative treated as zero, larger than chain size returns -1.
- * @return the index into the throwable chain, -1 if no match or null input.
+ * @return The index into the throwable chain, -1 if no match or null input.
*/
public static int indexOfThrowable(final Throwable throwable, final Class<? extends Throwable> clazz, final int fromIndex) {
return indexOf(throwable, clazz, fromIndex, false);
@@ -648,7 +648,7 @@ public static int indexOfThrowable(final Throwable throwable, final Class<? exte
*
* @param throwable the throwable to inspect, may be null.
* @param type the type to search for, subclasses match, null returns -1.
- * @return the index into the throwable chain, -1 if no match or null input.
+ * @return The index into the throwable chain, -1 if no match or null input.
* @since 2.1
*/
public static int indexOfType(final Throwable throwable, final Class<? extends Throwable> type) {
@@ -667,7 +667,7 @@ public static int indexOfType(final Throwable throwable, final Class<? extends T
* @param throwable the throwable to inspect, may be null.
* @param type the type to search for, subclasses match, null returns -1.
* @param fromIndex the (zero-based) index of the starting position, negative treated as zero, larger than chain size returns -1.
- * @return the index into the throwable chain, -1 if no match or null input.
+ * @return The index into the throwable chain, -1 if no match or null input.
* @since 2.1
*/
public static int indexOfType(final Throwable throwable, final Class<? extends Throwable> type, final int fromIndex) {
@@ -949,7 +949,7 @@ private static <T extends Throwable> T throwableOf(final Throwable throwable, fi
* @param <T> The type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null.
* @param clazz the class to search for, subclasses do not match, null returns null.
- * @return the first matching throwable from the throwable chain, null if no match or null input.
+ * @return The first matching throwable from the throwable chain, null if no match or null input.
* @since 3.10
*/
public static <T extends Throwable> T throwableOfThrowable(final Throwable throwable, final Class<T> clazz) {
@@ -969,7 +969,7 @@ public static <T extends Throwable> T throwableOfThrowable(final Throwable throw
* @param throwable the throwable to inspect, may be null.
* @param clazz the class to search for, subclasses do not match, null returns null.
* @param fromIndex the (zero-based) index of the starting position, negative treated as zero, larger than chain size returns null.
- * @return the first matching throwable from the throwable chain, null if no match or null input.
+ * @return The first matching throwable from the throwable chain, null if no match or null input.
* @since 3.10
*/
public static <T extends Throwable> T throwableOfThrowable(final Throwable throwable, final Class<T> clazz, final int fromIndex) {
@@ -989,7 +989,7 @@ public static <T extends Throwable> T throwableOfThrowable(final Throwable throw
* @param <T> The type of Throwable you are searching.
* @param throwable the throwable to inspect, may be null.
* @param type the type to search for, subclasses match, null returns null.
- * @return the first matching throwable from the throwable chain, null if no match or null input.
+ * @return The first matching throwable from the throwable chain, null if no match or null input.
* @since 3.10
*/
public static <T extends Throwable> T throwableOfType(final Throwable throwable, final Class<T> type) {
@@ -1009,7 +1009,7 @@ public static <T extends Throwable> T throwableOfType(final Throwable throwable,
* @param throwable the throwable to inspect, may be null.
* @param type the type to search for, subclasses match, null returns null.
* @param fromIndex the (zero-based) index of the starting position, negative treated as zero, larger than chain size returns null.
- * @return the first matching throwable from the throwable chain, null if no match or null input.
+ * @return The first matching throwable from the throwable chain, null if no match or null input.
* @since 3.10
*/
public static <T extends Throwable> T throwableOfType(final Throwable throwable, final Class<T> type, final int fromIndex) {
@@ -1021,7 +1021,7 @@ public static <T extends Throwable> T throwableOfType(final Throwable throwable,
*
* @param <T> The Throwable type.
* @param throwable the throwable to test and throw or return.
- * @return the given throwable.
+ * @return The given throwable.
* @since 3.13.0
* @deprecated Use {@link #throwUnchecked(Throwable)}.
*/
@@ -1041,7 +1041,7 @@ public static <T> T throwUnchecked(final T throwable) {
*
* @param <T> The Throwable type.
* @param throwable the throwable to test and throw or return.
- * @return the given throwable.
+ * @return The given throwable.
* @since 3.14.0
*/
public static <T extends Throwable> T throwUnchecked(final T throwable) {
diff --git a/src/main/java/org/apache/commons/lang3/function/Consumers.java b/src/main/java/org/apache/commons/lang3/function/Consumers.java
index d27747d67..2a9e67d0a 100644
--- a/src/main/java/org/apache/commons/lang3/function/Consumers.java
+++ b/src/main/java/org/apache/commons/lang3/function/Consumers.java
@@ -49,7 +49,7 @@ public static <T> void accept(final Consumer<T> consumer, final T object) {
* Gets the NOP Consumer singleton.
*
* @param <T> type type to consume.
- * @return the NOP Consumer singleton.
+ * @return The NOP Consumer singleton.
*/
@SuppressWarnings("unchecked")
public static <T> Consumer<T> nop() {
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 f0b710d98..4bacf6a17 100644
--- a/src/main/java/org/apache/commons/lang3/function/Failable.java
+++ b/src/main/java/org/apache/commons/lang3/function/Failable.java
@@ -142,7 +142,7 @@ public static <E extends Throwable> void accept(final FailableLongConsumer<E> co
* @param <U> The type of the second argument the function accepts
* @param <R> The return type of the function
* @param <E> The type of checked exception the function may throw
- * @return the value returned from the function
+ * @return The value returned from the function
*/
public static <T, U, R, E extends Throwable> R apply(final FailableBiFunction<T, U, R, E> function, final T input1,
final U input2) {
@@ -157,7 +157,7 @@ public static <T, U, R, E extends Throwable> R apply(final FailableBiFunction<T,
* @param <T> The type of the argument the function accepts
* @param <R> The return type of the function
* @param <E> The type of checked exception the function may throw
- * @return the value returned from the function
+ * @return The value returned from the function
*/
public static <T, R, E extends Throwable> R apply(final FailableFunction<T, R, E> function, final T input) {
return get(() -> function.apply(input));
@@ -170,7 +170,7 @@ public static <T, R, E extends Throwable> R apply(final FailableFunction<T, R, E
* @param left the first input to apply {@code function} on
* @param right the second input to apply {@code function} on
* @param <E> The type of checked exception the function may throw
- * @return the value returned from the function
+ * @return The value returned from the function
*/
public static <E extends Throwable> double applyAsDouble(final FailableDoubleBinaryOperator<E> function,
final double left, final double right) {
@@ -391,7 +391,7 @@ public static <T> Supplier<T> asSupplier(final FailableSupplier<T, ?> supplier)
* @param callable the callable to call
* @param <V> The return type of the callable
* @param <E> The type of checked exception the callable may throw
- * @return the value returned from the callable
+ * @return The value returned from the callable
*/
public static <V, E extends Throwable> V call(final FailableCallable<V, E> callable) {
return get(callable::call);
@@ -587,7 +587,7 @@ public static <T> FailableStream<T> stream(final Stream<T> stream) {
* @param <T> The type of the first argument the predicate tests
* @param <U> The type of the second argument the predicate tests
* @param <E> The type of checked exception the predicate may throw
- * @return the boolean value returned by the predicate
+ * @return The boolean value returned by the predicate
*/
public static <T, U, E extends Throwable> boolean test(final FailableBiPredicate<T, U, E> predicate,
final T object1, final U object2) {
@@ -601,7 +601,7 @@ public static <T, U, E extends Throwable> boolean test(final FailableBiPredicate
* @param object the input to test by {@code predicate}
* @param <T> The type of argument the predicate tests
* @param <E> The type of checked exception the predicate may throw
- * @return the boolean value returned by the predicate
+ * @return The boolean value returned by the predicate
*/
public static <T, E extends Throwable> boolean test(final FailablePredicate<T, E> predicate, final T object) {
return getAsBoolean(() -> predicate.test(object));
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java
index dd23d60be..6f7e3d7fc 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableBiFunction.java
@@ -69,7 +69,7 @@ default <V> FailableBiFunction<T, U, V, E> andThen(final FailableFunction<? supe
*
* @param input1 the first input for the function
* @param input2 the second input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws E Thrown when the function fails.
*/
R apply(T input1, U input2) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java
index 1c94facd2..ec20b6bc9 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableBiPredicate.java
@@ -103,7 +103,7 @@ default FailableBiPredicate<T, U, E> or(final FailableBiPredicate<? super T, ? s
*
* @param object1 the first object to test the predicate on
* @param object2 the second object to test the predicate on
- * @return the predicate's evaluation
+ * @return The predicate's evaluation
* @throws E Thrown when this predicate fails.
*/
boolean test(T object1, U object2) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java
index 61d380541..608b9f505 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleBinaryOperator.java
@@ -33,7 +33,7 @@ public interface FailableDoubleBinaryOperator<E extends Throwable> {
*
* @param left the first operand
* @param right the second operand
- * @return the operator result
+ * @return The operator result
* @throws E if the operation fails
*/
double applyAsDouble(double left, double right) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java
index a07435d81..83073e8e0 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleFunction.java
@@ -49,7 +49,7 @@ static <R, E extends Throwable> FailableDoubleFunction<R, E> nop() {
* Applies this function.
*
* @param input the input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws E Thrown when the function fails.
*/
R apply(double input) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java
index 8da6b5583..6894b073b 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToIntFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableDoubleToIntFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
int applyAsInt(double value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java
index 35d58c0d0..dcb789280 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleToLongFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableDoubleToLongFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E if the operation fails
*/
int applyAsLong(double value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java
index b0da6ee3c..43c160681 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableDoubleUnaryOperator.java
@@ -72,7 +72,7 @@ default FailableDoubleUnaryOperator<E> andThen(final FailableDoubleUnaryOperator
* Applies this operator to the given operand.
*
* @param operand the operand
- * @return the operator result
+ * @return The operator result
* @throws E Thrown when a consumer fails.
*/
double applyAsDouble(double operand) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableFunction.java
index c9252b91a..98c77a008 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableFunction.java
@@ -42,7 +42,7 @@ public interface FailableFunction<T, R, E extends Throwable> {
* @param <R> Return type.
* @param <E> The type of thrown exception or error.
* @param function the argument to return.
- * @return the argument
+ * @return The argument
* @since 3.14.0
*/
static <T, R, E extends Throwable> FailableFunction<T, R, E> function(final FailableFunction<T, R, E> function) {
@@ -90,7 +90,7 @@ default <V> FailableFunction<T, V, E> andThen(final FailableFunction<? super R,
* Applies this function.
*
* @param input the input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws E Thrown when the function fails.
*/
R apply(T input) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java
index f24e4018d..e6e25aa1a 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntBinaryOperator.java
@@ -33,7 +33,7 @@ public interface FailableIntBinaryOperator<E extends Throwable> {
*
* @param left the first operand
* @param right the second operand
- * @return the operator result
+ * @return The operator result
* @throws E if the operation fails
*/
int applyAsInt(int left, int right) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java
index 0cf1c3107..e0a22ec01 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntFunction.java
@@ -49,7 +49,7 @@ static <R, E extends Throwable> FailableIntFunction<R, E> nop() {
* Applies this function.
*
* @param input the input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws E Thrown when the function fails.
*/
R apply(int input) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java
index 179697f8a..615d2da5d 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntToDoubleFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableIntToDoubleFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
double applyAsDouble(int value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntToFloatFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntToFloatFunction.java
index 0115556fd..278bfa361 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntToFloatFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntToFloatFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableIntToFloatFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
float applyAsFloat(int value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java
index 4b9912e08..a363a100d 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntToLongFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableIntToLongFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
long applyAsLong(int value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java
index 21d6b2dcd..eadf56ceb 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableIntUnaryOperator.java
@@ -70,7 +70,7 @@ default FailableIntUnaryOperator<E> andThen(final FailableIntUnaryOperator<E> af
* Applies this operator to the given operand.
*
* @param operand the operand
- * @return the operator result
+ * @return The operator result
* @throws E Thrown when a consumer fails.
*/
int applyAsInt(int operand) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java
index d0688f8f5..a7754707d 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongBinaryOperator.java
@@ -33,7 +33,7 @@ public interface FailableLongBinaryOperator<E extends Throwable> {
*
* @param left the first operand
* @param right the second operand
- * @return the operator result
+ * @return The operator result
* @throws E if the operation fails
*/
long applyAsLong(long left, long right) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java
index 6752841b4..441e094f4 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongFunction.java
@@ -49,7 +49,7 @@ static <R, E extends Throwable> FailableLongFunction<R, E> nop() {
* Applies this function.
*
* @param input the input for the function
- * @return the result of the function
+ * @return The result of the function
* @throws E Thrown when the function fails.
*/
R apply(long input) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java
index 67bb96d37..a1856ba2a 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongToDoubleFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableLongToDoubleFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
double applyAsDouble(long value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java
index f5904ad15..898b884b2 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongToIntFunction.java
@@ -47,7 +47,7 @@ static <E extends Throwable> FailableLongToIntFunction<E> nop() {
* Applies this function to the given argument.
*
* @param value the function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
int applyAsInt(long value) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java b/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java
index f56391e89..5a593c59b 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongUnaryOperator.java
@@ -70,7 +70,7 @@ default FailableLongUnaryOperator<E> andThen(final FailableLongUnaryOperator<E>
* Applies this operator to the given operand.
*
* @param operand the operand
- * @return the operator result
+ * @return The operator result
* @throws E Thrown when a consumer fails.
*/
long applyAsLong(long operand) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java b/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java
index 565ff6e96..b56d4d230 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailablePredicate.java
@@ -99,7 +99,7 @@ default FailablePredicate<T, E> or(final FailablePredicate<? super T, E> other)
* Tests the predicate.
*
* @param object the object to test the predicate on
- * @return the predicate's evaluation
+ * @return The predicate's evaluation
* @throws E if the predicate fails
*/
boolean test(T object) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
index 6f6d49b72..f1cf3de90 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToBooleanFunction.java
@@ -47,7 +47,7 @@ static <T, E extends Throwable> FailableToBooleanFunction<T, E> nop() {
* Applies this function to the given arguments.
*
* @param t the first function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
boolean applyAsBoolean(T t) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java
index f2ea2ce8e..290e44e5e 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleBiFunction.java
@@ -52,7 +52,7 @@ static <T, U, E extends Throwable> FailableToDoubleBiFunction<T, U, E> nop() {
*
* @param t the first function argument
* @param u the second function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
double applyAsDouble(T t, U u) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java
index fafc88c0e..34d34301f 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToDoubleFunction.java
@@ -49,7 +49,7 @@ static <T, E extends Throwable> FailableToDoubleFunction<T, E> nop() {
* Applies this function to the given arguments.
*
* @param t the first function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
double applyAsDouble(T t) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java
index 77f3ea3ac..cf81758ae 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToIntBiFunction.java
@@ -52,7 +52,7 @@ static <T, U, E extends Throwable> FailableToIntBiFunction<T, U, E> nop() {
*
* @param t the first function argument
* @param u the second function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
int applyAsInt(T t, U u) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java
index ec17296e9..edaf8299a 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToIntFunction.java
@@ -49,7 +49,7 @@ static <T, E extends Throwable> FailableToIntFunction<T, E> nop() {
* Applies this function to the given arguments.
*
* @param t the first function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
int applyAsInt(T t) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
index 1d36998bd..9ecf0772e 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
@@ -52,7 +52,7 @@ static <T, U, E extends Throwable> FailableToLongBiFunction<T, U, E> nop() {
*
* @param t the first function argument
* @param u the second function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
long applyAsLong(T t, U u) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java
index a19a64ac8..203ffe258 100644
--- a/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/FailableToLongFunction.java
@@ -49,7 +49,7 @@ static <T, E extends Throwable> FailableToLongFunction<T, E> nop() {
* Applies this function to the given arguments.
*
* @param t the first function argument
- * @return the function result
+ * @return The function result
* @throws E Thrown when the function fails.
*/
long applyAsLong(T t) throws E;
diff --git a/src/main/java/org/apache/commons/lang3/function/Functions.java b/src/main/java/org/apache/commons/lang3/function/Functions.java
index e5d87dfd9..cd1ae270b 100644
--- a/src/main/java/org/apache/commons/lang3/function/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/function/Functions.java
@@ -35,7 +35,7 @@ public final class Functions {
* @param object the object to apply the function.
* @param <T> the type of the argument the function applies.
* @param <R> the type of the result the function returns.
- * @return the value the function returns if the function is not {@code null}; {@code null} otherwise.
+ * @return The value the function returns if the function is not {@code null}; {@code null} otherwise.
* @since 3.15.0
*/
public static <T, R> R apply(final Function<T, R> function, final T object) {
@@ -139,7 +139,7 @@ public static <T, U, V, R> R applyNonNull(final T value1, final Function<? super
* @param <T> Input type.
* @param <R> Return type.
* @param function the argument to return.
- * @return the argument
+ * @return The argument
*/
public static <T, R> Function<T, R> function(final Function<T, R> function) {
return function;
diff --git a/src/main/java/org/apache/commons/lang3/function/IntToCharFunction.java b/src/main/java/org/apache/commons/lang3/function/IntToCharFunction.java
index dcc9c4c0c..3a40f60a5 100644
--- a/src/main/java/org/apache/commons/lang3/function/IntToCharFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/IntToCharFunction.java
@@ -37,7 +37,7 @@ public interface IntToCharFunction {
* Applies this function to the given argument.
*
* @param value the function argument.
- * @return the function result.
+ * @return The function result.
*/
char applyAsChar(int value);
}
diff --git a/src/main/java/org/apache/commons/lang3/function/Predicates.java b/src/main/java/org/apache/commons/lang3/function/Predicates.java
index 6e6659822..1c178ee60 100644
--- a/src/main/java/org/apache/commons/lang3/function/Predicates.java
+++ b/src/main/java/org/apache/commons/lang3/function/Predicates.java
@@ -33,7 +33,7 @@ public class Predicates {
* Gets the Predicate singleton that always returns false.
*
* @param <T> The type of the input to the predicate.
- * @return the Predicate singleton.
+ * @return The Predicate singleton.
*/
@SuppressWarnings("unchecked")
// method name cannot be "false".
@@ -45,7 +45,7 @@ public static <T> Predicate<T> falsePredicate() {
* Gets the Predicate singleton that always returns true.
*
* @param <T> The type of the input to the predicate.
- * @return the Predicate singleton.
+ * @return The Predicate singleton.
*/
@SuppressWarnings("unchecked")
// method name cannot be "true".
diff --git a/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java b/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
index 601687ee3..d858958c1 100644
--- a/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/ToBooleanBiFunction.java
@@ -36,7 +36,7 @@ public interface ToBooleanBiFunction<T, U> {
*
* @param t the first function argument.
* @param u the second function argument.
- * @return the function result.
+ * @return The function result.
*/
boolean applyAsBoolean(T t, U u);
}
diff --git a/src/main/java/org/apache/commons/lang3/function/TriFunction.java b/src/main/java/org/apache/commons/lang3/function/TriFunction.java
index 89541eda8..f861295f5 100644
--- a/src/main/java/org/apache/commons/lang3/function/TriFunction.java
+++ b/src/main/java/org/apache/commons/lang3/function/TriFunction.java
@@ -59,7 +59,7 @@ default <W> TriFunction<T, U, V, W> andThen(final Function<? super R, ? extends
* @param t the first function argument
* @param u the second function argument
* @param v the third function argument
- * @return the function result
+ * @return The function result
*/
R apply(T t, U u, V v);
}
diff --git a/src/main/java/org/apache/commons/lang3/math/Fraction.java b/src/main/java/org/apache/commons/lang3/math/Fraction.java
index 5864a5d74..799d6138c 100644
--- a/src/main/java/org/apache/commons/lang3/math/Fraction.java
+++ b/src/main/java/org/apache/commons/lang3/math/Fraction.java
@@ -254,7 +254,7 @@ public static Fraction getFraction(final int whole, final int numerator, final i
* </p>
*
* @param str the string to parse, must not be {@code null}
- * @return the new {@link Fraction} instance
+ * @return The new {@link Fraction} instance
* @throws NullPointerException if the string is {@code null}
* @throws NumberFormatException if the number format is invalid
*/
@@ -338,7 +338,7 @@ public static Fraction getReducedFraction(int numerator, int denominator) {
*
* @param u a non-zero number
* @param v a non-zero number
- * @return the greatest common divisor, never zero
+ * @return The greatest common divisor, never zero
*/
private static int greatestCommonDivisor(int u, int v) {
// From Commons Math:
@@ -406,7 +406,7 @@ private static int hash(final int value1, final int value2) {
*
* @param x a factor
* @param y a factor
- * @return the product {@code x*y}
+ * @return The product {@code x*y}
* @throws ArithmeticException if the result cannot be represented as
* an int
*/
@@ -423,7 +423,7 @@ private static int mulAndCheck(final int x, final int y) {
*
* @param x a non-negative factor
* @param y a non-negative factor
- * @return the product {@code x*y}
+ * @return The product {@code x*y}
* @throws ArithmeticException if the result cannot be represented as
* an int
*/
@@ -606,7 +606,7 @@ public Fraction divideBy(final Fraction fraction) {
* Gets the fraction as a {@code double}. This calculates the fraction
* as the numerator divided by denominator.
*
- * @return the fraction as a {@code double}
+ * @return The fraction as a {@code double}
*/
@Override
public double doubleValue() {
@@ -638,7 +638,7 @@ public boolean equals(final Object obj) {
* Gets the fraction as a {@code float}. This calculates the fraction
* as the numerator divided by denominator.
*
- * @return the fraction as a {@code float}
+ * @return The fraction as a {@code float}
*/
@Override
public float floatValue() {
@@ -648,7 +648,7 @@ public float floatValue() {
/**
* Gets the denominator part of the fraction.
*
- * @return the denominator fraction part
+ * @return The denominator fraction part
*/
public int getDenominator() {
return denominator;
@@ -660,7 +660,7 @@ public int getDenominator() {
* This method may return a value greater than the denominator, an improper fraction, such as the seven in 7/4.
* </p>
*
- * @return the numerator fraction part
+ * @return The numerator fraction part
*/
public int getNumerator() {
return numerator;
@@ -676,7 +676,7 @@ public int getNumerator() {
* If the fraction is negative such as -7/4, it can be resolved into -1 3/4, so this method returns the positive proper numerator, 3.
* </p>
*
- * @return the numerator fraction part of a proper fraction, always positive
+ * @return The numerator fraction part of a proper fraction, always positive
*/
public int getProperNumerator() {
return Math.abs(numerator % denominator);
@@ -692,7 +692,7 @@ public int getProperNumerator() {
* If the fraction is negative such as -7/4, it can be resolved into -1 3/4, so this method returns the positive whole part -1.
* </p>
*
- * @return the whole fraction part of a proper fraction, that includes the sign
+ * @return The whole fraction part of a proper fraction, that includes the sign
*/
public int getProperWhole() {
return numerator / denominator;
@@ -712,7 +712,7 @@ public int hashCode() {
* Gets the fraction as an {@code int}. This returns the whole number
* part of the fraction.
*
- * @return the whole number fraction part
+ * @return The whole number fraction part
*/
@Override
public int intValue() {
@@ -745,7 +745,7 @@ public Fraction invert() {
* Gets the fraction as a {@code long}. This returns the whole number
* part of the fraction.
*
- * @return the whole number fraction part
+ * @return The whole number fraction part
*/
@Override
public long longValue() {
diff --git a/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java b/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
index 1b261e6a3..73bec9693 100644
--- a/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
+++ b/src/main/java/org/apache/commons/lang3/math/IEEE754rUtils.java
@@ -33,7 +33,7 @@ public class IEEE754rUtils {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(double[]) to max(double...)
@@ -88,7 +88,7 @@ public static double max(final double a, final double b, final double c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(float[]) to max(float...)
@@ -143,7 +143,7 @@ public static float max(final float a, final float b, final float c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(double[]) to min(double...).
@@ -198,7 +198,7 @@ public static double min(final double a, final double b, final double c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(float[]) to min(float...).
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 84b954bfd..78a079b84 100644
--- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
+++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
@@ -118,7 +118,7 @@ private static <T> boolean accept(final Consumer<T> consumer, final T obj) {
*
* @param x the first {@code byte} to compare.
* @param y the second {@code byte} to compare.
- * @return the value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
+ * @return The value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
* @since 3.4
* @deprecated Use {@link Byte#compare(byte, byte)}.
*/
@@ -132,7 +132,7 @@ public static int compare(final byte x, final byte y) {
*
* @param x the first {@code int} to compare.
* @param y the second {@code int} to compare.
- * @return the value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
+ * @return The value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
* @since 3.4
* @deprecated Use {@link Integer#compare(int, int)}.
*/
@@ -146,7 +146,7 @@ public static int compare(final int x, final int y) {
*
* @param x the first {@code long} to compare.
* @param y the second {@code long} to compare.
- * @return the value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
+ * @return The value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
* @since 3.4
* @deprecated Use {@link Long#compare(long, long)}.
*/
@@ -160,7 +160,7 @@ public static int compare(final long x, final long y) {
*
* @param x the first {@code short} to compare.
* @param y the second {@code short} to compare.
- * @return the value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
+ * @return The value {@code 0} if {@code x == y}; a value less than {@code 0} if {@code x < y}; and a value greater than {@code 0} if {@code x > y}.
* @since 3.4
* @deprecated Use {@link Short#compare(short, short)}.
*/
@@ -709,7 +709,7 @@ private static boolean isZero(final String mant, final String dec) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(byte[]) to max(byte...).
@@ -733,7 +733,7 @@ public static byte max(final byte... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
*/
public static byte max(byte a, final byte b, final byte c) {
if (b > a) {
@@ -749,7 +749,7 @@ public static byte max(byte a, final byte b, final byte c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @see IEEE754rUtils#max(double[]) IEEE754rUtils for a version of this method that handles NaN differently.
@@ -776,7 +776,7 @@ public static double max(final double... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
* @see IEEE754rUtils#max(double, double, double) for a version of this method that handles NaN differently.
*/
public static double max(final double a, final double b, final double c) {
@@ -787,7 +787,7 @@ public static double max(final double a, final double b, final double c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @see IEEE754rUtils#max(float[]) IEEE754rUtils for a version of this method that handles NaN differently.
@@ -848,7 +848,7 @@ public static float max(final float... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
* @see IEEE754rUtils#max(float, float, float) for a version of this method that handles NaN differently.
*/
public static float max(final float a, final float b, final float c) {
@@ -859,7 +859,7 @@ public static float max(final float a, final float b, final float c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(int[]) to max(int...).
@@ -883,7 +883,7 @@ public static int max(final int... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
*/
public static int max(int a, final int b, final int c) {
if (b > a) {
@@ -899,7 +899,7 @@ public static int max(int a, final int b, final int c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(long[]) to max(long...).
@@ -924,7 +924,7 @@ public static long max(final long... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
*/
public static long max(long a, final long b, final long c) {
if (b > a) {
@@ -940,7 +940,7 @@ public static long max(long a, final long b, final long c) {
* Returns the maximum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the maximum value in the array.
+ * @return The maximum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from max(short[]) to max(short...).
@@ -964,7 +964,7 @@ public static short max(final short... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the largest of the values.
+ * @return The largest of the values.
*/
public static short max(short a, final short b, final short c) {
if (b > a) {
@@ -980,7 +980,7 @@ public static short max(short a, final short b, final short c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(byte[]) to min(byte...).
@@ -1004,7 +1004,7 @@ public static byte min(final byte... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
*/
public static byte min(byte a, final byte b, final byte c) {
if (b < a) {
@@ -1020,7 +1020,7 @@ public static byte min(byte a, final byte b, final byte c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @see IEEE754rUtils#min(double[]) IEEE754rUtils for a version of this method that handles NaN differently.
@@ -1047,7 +1047,7 @@ public static double min(final double... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
* @see IEEE754rUtils#min(double, double, double) for a version of this method that handles NaN differently.
*/
public static double min(final double a, final double b, final double c) {
@@ -1058,7 +1058,7 @@ public static double min(final double a, final double b, final double c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @see IEEE754rUtils#min(float[]) IEEE754rUtils for a version of this method that handles NaN differently.
@@ -1085,7 +1085,7 @@ public static float min(final float... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
* @see IEEE754rUtils#min(float, float, float) for a version of this method that handles NaN differently.
*/
public static float min(final float a, final float b, final float c) {
@@ -1096,7 +1096,7 @@ public static float min(final float a, final float b, final float c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(int[]) to min(int...).
@@ -1120,7 +1120,7 @@ public static int min(final int... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
*/
public static int min(int a, final int b, final int c) {
if (b < a) {
@@ -1136,7 +1136,7 @@ public static int min(int a, final int b, final int c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(long[]) to min(long...).
@@ -1161,7 +1161,7 @@ public static long min(final long... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
*/
public static long min(long a, final long b, final long c) {
if (b < a) {
@@ -1177,7 +1177,7 @@ public static long min(long a, final long b, final long c) {
* Returns the minimum value in an array.
*
* @param array an array, must not be null or empty.
- * @return the minimum value in the array.
+ * @return The minimum value in the array.
* @throws NullPointerException if {@code array} is {@code null}.
* @throws IllegalArgumentException if {@code array} is empty.
* @since 3.4 Changed signature from min(short[]) to min(short...).
@@ -1201,7 +1201,7 @@ public static short min(final short... array) {
* @param a value 1.
* @param b value 2.
* @param c value 3.
- * @return the smallest of the values.
+ * @return The smallest of the values.
*/
public static short min(short a, final short b, final short c) {
if (b < a) {
@@ -1227,7 +1227,7 @@ public static short min(short a, final short b, final short c) {
* </pre>
*
* @param str the string to convert, may be null.
- * @return the byte represented by the string, or {@code zero} if conversion fails.
+ * @return The byte represented by the string, or {@code zero} if conversion fails.
* @since 2.5
*/
public static byte toByte(final String str) {
@@ -1249,7 +1249,7 @@ public static byte toByte(final String str) {
*
* @param str the string to convert, may be null.
* @param defaultValue the default value.
- * @return the byte represented by the string, or the default if conversion fails.
+ * @return The byte represented by the string, or the default if conversion fails.
* @since 2.5
*/
public static byte toByte(final String str, final byte defaultValue) {
@@ -1273,7 +1273,7 @@ public static byte toByte(final String str, final byte defaultValue) {
* </pre>
*
* @param value the {@link BigDecimal} to convert, may be {@code null}.
- * @return the double represented by the {@link BigDecimal} or {@code 0.0d} if the {@link BigDecimal} is {@code null}.
+ * @return The double represented by the {@link BigDecimal} or {@code 0.0d} if the {@link BigDecimal} is {@code null}.
* @since 3.8
*/
public static double toDouble(final BigDecimal value) {
@@ -1294,7 +1294,7 @@ public static double toDouble(final BigDecimal value) {
*
* @param value the {@link BigDecimal} to convert, may be {@code null}.
* @param defaultValue the default value.
- * @return the double represented by the {@link BigDecimal} or the defaultValue if the {@link BigDecimal} is {@code null}.
+ * @return The double represented by the {@link BigDecimal} or the defaultValue if the {@link BigDecimal} is {@code null}.
* @since 3.8
*/
public static double toDouble(final BigDecimal value, final double defaultValue) {
@@ -1315,7 +1315,7 @@ public static double toDouble(final BigDecimal value, final double defaultValue)
* </pre>
*
* @param str the string to convert, may be {@code null}.
- * @return the double represented by the string, or {@code 0.0d} if conversion fails.
+ * @return The double represented by the string, or {@code 0.0d} if conversion fails.
* @since 2.1
*/
public static double toDouble(final String str) {
@@ -1337,7 +1337,7 @@ public static double toDouble(final String str) {
*
* @param str the string to convert, may be {@code null}
* @param defaultValue the default value.
- * @return the double represented by the string, or defaultValue if conversion fails.
+ * @return The double represented by the string, or defaultValue if conversion fails.
* @since 2.1
*/
public static double toDouble(final String str, final double defaultValue) {
@@ -1362,7 +1362,7 @@ public static double toDouble(final String str, final double defaultValue) {
* </pre>
*
* @param str the string to convert, may be {@code null}.
- * @return the float represented by the string, or {@code 0.0f} if conversion fails.
+ * @return The float represented by the string, or {@code 0.0f} if conversion fails.
* @since 2.1
*/
public static float toFloat(final String str) {
@@ -1384,7 +1384,7 @@ public static float toFloat(final String str) {
*
* @param str the string to convert, may be {@code null}.
* @param defaultValue the default value.
- * @return the float represented by the string, or defaultValue if conversion fails.
+ * @return The float represented by the string, or defaultValue if conversion fails.
* @since 2.1
*/
public static float toFloat(final String str, final float defaultValue) {
@@ -1409,7 +1409,7 @@ public static float toFloat(final String str, final float defaultValue) {
* </pre>
*
* @param str the string to convert, may be null.
- * @return the int represented by the string, or {@code zero} if conversion fails.
+ * @return The int represented by the string, or {@code zero} if conversion fails.
* @since 2.1
*/
public static int toInt(final String str) {
@@ -1431,7 +1431,7 @@ public static int toInt(final String str) {
*
* @param str the string to convert, may be null.
* @param defaultValue the default value.
- * @return the int represented by the string, or the default if conversion fails.
+ * @return The int represented by the string, or the default if conversion fails.
* @since 2.1
*/
public static int toInt(final String str, final int defaultValue) {
@@ -1456,7 +1456,7 @@ public static int toInt(final String str, final int defaultValue) {
* </pre>
*
* @param str the string to convert, may be null.
- * @return the long represented by the string, or {@code 0} if conversion fails.
+ * @return The long represented by the string, or {@code 0} if conversion fails.
* @since 2.1
*/
public static long toLong(final String str) {
@@ -1478,7 +1478,7 @@ public static long toLong(final String str) {
*
* @param str the string to convert, may be null.
* @param defaultValue the default value.
- * @return the long represented by the string, or the default if conver sion fails.
+ * @return The long represented by the string, or the default if conver sion fails.
* @since 2.1
*/
public static long toLong(final String str, final long defaultValue) {
@@ -1498,7 +1498,7 @@ public static long toLong(final String str, final long defaultValue) {
* </p>
*
* @param value the {@link BigDecimal} to convert, may be null.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final BigDecimal value) {
@@ -1512,7 +1512,7 @@ public static BigDecimal toScaledBigDecimal(final BigDecimal value) {
* @param value the {@link BigDecimal} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of discarding precision.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final BigDecimal value, final int scale, final RoundingMode roundingMode) {
@@ -1531,7 +1531,7 @@ public static BigDecimal toScaledBigDecimal(final BigDecimal value, final int sc
* </p>
*
* @param value the {@link Double} to convert, may be null.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Double value) {
@@ -1545,7 +1545,7 @@ public static BigDecimal toScaledBigDecimal(final Double value) {
* @param value the {@link Double} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of discarding precision.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Double value, final int scale, final RoundingMode roundingMode) {
@@ -1564,7 +1564,7 @@ public static BigDecimal toScaledBigDecimal(final Double value, final int scale,
* </p>
*
* @param value the {@link Float} to convert, may be null.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Float value) {
@@ -1578,7 +1578,7 @@ public static BigDecimal toScaledBigDecimal(final Float value) {
* @param value the {@link Float} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of discarding precision.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final Float value, final int scale, final RoundingMode roundingMode) {
@@ -1597,7 +1597,7 @@ public static BigDecimal toScaledBigDecimal(final Float value, final int scale,
* </p>
*
* @param value the {@link String} to convert, may be null.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final String value) {
@@ -1611,7 +1611,7 @@ public static BigDecimal toScaledBigDecimal(final String value) {
* @param value the {@link String} to convert, may be null.
* @param scale the number of digits to the right of the decimal point.
* @param roundingMode a rounding behavior for numerical operations capable of discarding precision.
- * @return the scaled, with appropriate rounding, {@link BigDecimal}.
+ * @return The scaled, with appropriate rounding, {@link BigDecimal}.
* @since 3.8
*/
public static BigDecimal toScaledBigDecimal(final String value, final int scale, final RoundingMode roundingMode) {
@@ -1635,7 +1635,7 @@ public static BigDecimal toScaledBigDecimal(final String value, final int scale,
* </pre>
*
* @param str the string to convert, may be null.
- * @return the short represented by the string, or {@code zero} if conversion fails.
+ * @return The short represented by the string, or {@code zero} if conversion fails.
* @since 2.5
*/
public static short toShort(final String str) {
@@ -1657,7 +1657,7 @@ public static short toShort(final String str) {
*
* @param str the string to convert, may be null.
* @param defaultValue the default value.
- * @return the short represented by the string, or the default if conversion fails.
+ * @return The short represented by the string, or the default if conversion fails.
* @since 2.5
*/
public static short toShort(final String str, final short defaultValue) {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
index 7f88e7d8e..1dd3e04ce 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java
@@ -38,7 +38,7 @@ public interface Mutable<T> extends Supplier<T> {
/**
* Gets the value of this mutable.
*
- * @return the stored value.
+ * @return The stored value.
* @since 3.18.0
*/
@Override
@@ -49,7 +49,7 @@ default T get() {
/**
* Gets the value of this mutable.
*
- * @return the stored value.
+ * @return The stored value.
* @deprecated Use {@link #get()}.
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java b/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
index ec093afef..a821bd2db 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java
@@ -75,7 +75,7 @@ public MutableBoolean(final Boolean value) {
/**
* Returns the value of this MutableBoolean as a boolean.
*
- * @return the boolean value represented by this object.
+ * @return The boolean value represented by this object.
*/
public boolean booleanValue() {
return value;
@@ -112,7 +112,7 @@ public boolean equals(final Object obj) {
/**
* Gets the value as a Boolean instance.
*
- * @return the value as a Boolean, never null.
+ * @return The value as a Boolean, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -124,7 +124,7 @@ public Boolean getValue() {
/**
* Returns a suitable hash code for this mutable.
*
- * @return the hash code returned by {@code Boolean.TRUE} or {@code Boolean.FALSE}
+ * @return The hash code returned by {@code Boolean.TRUE} or {@code Boolean.FALSE}
*/
@Override
public int hashCode() {
@@ -202,7 +202,7 @@ public Boolean toBoolean() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string
+ * @return The mutable value as a string
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
index 9e5da5fff..cb7918548 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java
@@ -105,7 +105,7 @@ public void add(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public byte addAndGet(final byte operand) {
@@ -119,7 +119,7 @@ public byte addAndGet(final byte operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public byte addAndGet(final Number operand) {
@@ -131,7 +131,7 @@ public byte addAndGet(final Number operand) {
/**
* Returns the value of this MutableByte as a byte.
*
- * @return the numeric value represented by this object after conversion to type byte.
+ * @return The numeric value represented by this object after conversion to type byte.
*/
@Override
public byte byteValue() {
@@ -162,7 +162,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public byte decrementAndGet() {
@@ -173,7 +173,7 @@ public byte decrementAndGet() {
/**
* Returns the value of this MutableByte as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -199,7 +199,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableByte as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -211,7 +211,7 @@ public float floatValue() {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public byte getAndAdd(final byte operand) {
@@ -226,7 +226,7 @@ public byte getAndAdd(final byte operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public byte getAndAdd(final Number operand) {
@@ -239,7 +239,7 @@ public byte getAndAdd(final Number operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public byte getAndDecrement() {
@@ -252,7 +252,7 @@ public byte getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public byte getAndIncrement() {
@@ -264,7 +264,7 @@ public byte getAndIncrement() {
/**
* Gets the value as a Byte instance.
*
- * @return the value as a Byte, never null.
+ * @return The value as a Byte, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -296,7 +296,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public byte incrementAndGet() {
@@ -307,7 +307,7 @@ public byte incrementAndGet() {
/**
* Returns the value of this MutableByte as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -317,7 +317,7 @@ public int intValue() {
/**
* Returns the value of this MutableByte as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -377,7 +377,7 @@ public Byte toByte() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
index 9a54a0431..ba0b9e39a 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java
@@ -107,7 +107,7 @@ public void add(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public double addAndGet(final double operand) {
@@ -121,7 +121,7 @@ public double addAndGet(final double operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public double addAndGet(final Number operand) {
@@ -153,7 +153,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public double decrementAndGet() {
@@ -164,7 +164,7 @@ public double decrementAndGet() {
/**
* Returns the value of this MutableDouble as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -205,7 +205,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableDouble as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -217,7 +217,7 @@ public float floatValue() {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public double getAndAdd(final double operand) {
@@ -232,7 +232,7 @@ public double getAndAdd(final double operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public double getAndAdd(final Number operand) {
@@ -245,7 +245,7 @@ public double getAndAdd(final Number operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public double getAndDecrement() {
@@ -258,7 +258,7 @@ public double getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public double getAndIncrement() {
@@ -270,7 +270,7 @@ public double getAndIncrement() {
/**
* Gets the value as a Double instance.
*
- * @return the value as a Double, never null.
+ * @return The value as a Double, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -303,7 +303,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public double incrementAndGet() {
@@ -315,7 +315,7 @@ public double incrementAndGet() {
/**
* Returns the value of this MutableDouble as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -343,7 +343,7 @@ public boolean isNaN() {
/**
* Returns the value of this MutableDouble as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -403,7 +403,7 @@ public Double toDouble() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
index 1038fca8c..cf142ea41 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java
@@ -107,7 +107,7 @@ public void add(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public float addAndGet(final float operand) {
@@ -121,7 +121,7 @@ public float addAndGet(final float operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public float addAndGet(final Number operand) {
@@ -153,7 +153,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public float decrementAndGet() {
@@ -164,7 +164,7 @@ public float decrementAndGet() {
/**
* Returns the value of this MutableFloat as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -209,7 +209,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableFloat as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -221,7 +221,7 @@ public float floatValue() {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public float getAndAdd(final float operand) {
@@ -236,7 +236,7 @@ public float getAndAdd(final float operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public float getAndAdd(final Number operand) {
@@ -249,7 +249,7 @@ public float getAndAdd(final Number operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public float getAndDecrement() {
@@ -262,7 +262,7 @@ public float getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public float getAndIncrement() {
@@ -274,7 +274,7 @@ public float getAndIncrement() {
/**
* Gets the value as a Float instance.
*
- * @return the value as a Float, never null.
+ * @return The value as a Float, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -306,7 +306,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public float incrementAndGet() {
@@ -318,7 +318,7 @@ public float incrementAndGet() {
/**
* Returns the value of this MutableFloat as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -346,7 +346,7 @@ public boolean isNaN() {
/**
* Returns the value of this MutableFloat as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -406,7 +406,7 @@ public Float toFloat() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
index 15d23ef6f..19a67f778 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java
@@ -105,7 +105,7 @@ public void add(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public int addAndGet(final int operand) {
@@ -119,7 +119,7 @@ public int addAndGet(final int operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public int addAndGet(final Number operand) {
@@ -151,7 +151,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public int decrementAndGet() {
@@ -162,7 +162,7 @@ public int decrementAndGet() {
/**
* Returns the value of this MutableInt as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -188,7 +188,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableInt as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -200,7 +200,7 @@ public float floatValue() {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public int getAndAdd(final int operand) {
@@ -215,7 +215,7 @@ public int getAndAdd(final int operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public int getAndAdd(final Number operand) {
@@ -228,7 +228,7 @@ public int getAndAdd(final Number operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public int getAndDecrement() {
@@ -241,7 +241,7 @@ public int getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public int getAndIncrement() {
@@ -253,7 +253,7 @@ public int getAndIncrement() {
/**
* Gets the value as a Integer instance.
*
- * @return the value as a Integer, never null.
+ * @return The value as a Integer, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -285,7 +285,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public int incrementAndGet() {
@@ -297,7 +297,7 @@ public int incrementAndGet() {
/**
* Returns the value of this MutableInt as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -307,7 +307,7 @@ public int intValue() {
/**
* Returns the value of this MutableInt as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -367,7 +367,7 @@ public Integer toInteger() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java b/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
index 86b497a94..a5e3e2fd6 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java
@@ -105,7 +105,7 @@ public void add(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public long addAndGet(final long operand) {
@@ -119,7 +119,7 @@ public long addAndGet(final long operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public long addAndGet(final Number operand) {
@@ -151,7 +151,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public long decrementAndGet() {
@@ -162,7 +162,7 @@ public long decrementAndGet() {
/**
* Returns the value of this MutableLong as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -188,7 +188,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableLong as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -200,7 +200,7 @@ public float floatValue() {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public long getAndAdd(final long operand) {
@@ -215,7 +215,7 @@ public long getAndAdd(final long operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public long getAndAdd(final Number operand) {
@@ -228,7 +228,7 @@ public long getAndAdd(final Number operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public long getAndDecrement() {
@@ -241,7 +241,7 @@ public long getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public long getAndIncrement() {
@@ -253,7 +253,7 @@ public long getAndIncrement() {
/**
* Gets the value as a Long instance.
*
- * @return the value as a Long, never null.
+ * @return The value as a Long, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -285,7 +285,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public long incrementAndGet() {
@@ -297,7 +297,7 @@ public long incrementAndGet() {
/**
* Returns the value of this MutableLong as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -307,7 +307,7 @@ public int intValue() {
/**
* Returns the value of this MutableLong as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -367,7 +367,7 @@ public Long toLong() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
index f6379e2b3..acbe826ec 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableObject.java
@@ -86,7 +86,7 @@ public boolean equals(final Object obj) {
/**
* Gets the value.
*
- * @return the value, may be null.
+ * @return The value, may be null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -98,7 +98,7 @@ public T getValue() {
/**
* Returns the value's hash code or {@code 0} if the value is {@code null}.
*
- * @return the value's hash code or {@code 0} if the value is {@code null}.
+ * @return The value's hash code or {@code 0} if the value is {@code null}.
*/
@Override
public int hashCode() {
@@ -118,7 +118,7 @@ public void setValue(final T value) {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java b/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
index 2b2594cd6..4786526aa 100644
--- a/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
+++ b/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java
@@ -106,7 +106,7 @@ public void add(final short operand) {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public short addAndGet(final Number operand) {
@@ -119,7 +119,7 @@ public short addAndGet(final Number operand) {
* immediately after the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance after adding the operand.
+ * @return The value associated with this instance after adding the operand.
* @since 3.5
*/
public short addAndGet(final short operand) {
@@ -151,7 +151,7 @@ public void decrement() {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately after the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is decremented.
+ * @return The value associated with the instance after it is decremented.
* @since 3.5
*/
public short decrementAndGet() {
@@ -162,7 +162,7 @@ public short decrementAndGet() {
/**
* Returns the value of this MutableShort as a double.
*
- * @return the numeric value represented by this object after conversion to type double.
+ * @return The numeric value represented by this object after conversion to type double.
*/
@Override
public double doubleValue() {
@@ -188,7 +188,7 @@ public boolean equals(final Object obj) {
/**
* Returns the value of this MutableShort as a float.
*
- * @return the numeric value represented by this object after conversion to type float.
+ * @return The numeric value represented by this object after conversion to type float.
*/
@Override
public float floatValue() {
@@ -201,7 +201,7 @@ public float floatValue() {
*
* @param operand the quantity to add, not null.
* @throws NullPointerException if {@code operand} is null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public short getAndAdd(final Number operand) {
@@ -215,7 +215,7 @@ public short getAndAdd(final Number operand) {
* immediately prior to the addition operation. This method is not thread safe.
*
* @param operand the quantity to add, not null.
- * @return the value associated with this instance immediately before the operand was added.
+ * @return The value associated with this instance immediately before the operand was added.
* @since 3.5
*/
public short getAndAdd(final short operand) {
@@ -228,7 +228,7 @@ public short getAndAdd(final short operand) {
* Decrements this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the decrement operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was decremented.
+ * @return The value associated with the instance before it was decremented.
* @since 3.5
*/
public short getAndDecrement() {
@@ -241,7 +241,7 @@ public short getAndDecrement() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately prior to the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance before it was incremented.
+ * @return The value associated with the instance before it was incremented.
* @since 3.5
*/
public short getAndIncrement() {
@@ -253,7 +253,7 @@ public short getAndIncrement() {
/**
* Gets the value as a Short instance.
*
- * @return the value as a Short, never null.
+ * @return The value as a Short, never null.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -285,7 +285,7 @@ public void increment() {
* Increments this instance's value by 1; this method returns the value associated with the instance
* immediately after the increment operation. This method is not thread safe.
*
- * @return the value associated with the instance after it is incremented.
+ * @return The value associated with the instance after it is incremented.
* @since 3.5
*/
public short incrementAndGet() {
@@ -296,7 +296,7 @@ public short incrementAndGet() {
/**
* Returns the value of this MutableShort as an int.
*
- * @return the numeric value represented by this object after conversion to type int.
+ * @return The numeric value represented by this object after conversion to type int.
*/
@Override
public int intValue() {
@@ -306,7 +306,7 @@ public int intValue() {
/**
* Returns the value of this MutableShort as a long.
*
- * @return the numeric value represented by this object after conversion to type long.
+ * @return The numeric value represented by this object after conversion to type long.
*/
@Override
public long longValue() {
@@ -337,7 +337,7 @@ public void setValue(final short value) {
/**
* Returns the value of this MutableShort as a short.
*
- * @return the numeric value represented by this object after conversion to type short.
+ * @return The numeric value represented by this object after conversion to type short.
*/
@Override
public short shortValue() {
@@ -377,7 +377,7 @@ public Short toShort() {
/**
* Returns the String value of this mutable.
*
- * @return the mutable value as a string.
+ * @return The mutable value as a string.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
index 2fb8660ef..8d1ff6006 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java
@@ -54,7 +54,7 @@ public class ConstructorUtils {
* @param <T> the constructor type.
* @param cls the class to find a constructor for, not {@code null}.
* @param parameterTypes the array of parameter types, {@code null} treated as empty.
- * @return the constructor, {@code null} if no matching accessible constructor found.
+ * @return The constructor, {@code null} if no matching accessible constructor found.
* @throws NullPointerException if {@code cls} is {@code null}
* @throws SecurityException Thrown if a security manager is present and the caller's class loader is not the same as or an ancestor of the class loader
* for the class and invocation of {@link SecurityManager#checkPackageAccess(String)} denies access to the package of the
@@ -80,7 +80,7 @@ public static <T> Constructor<T> getAccessibleConstructor(final Class<T> cls, fi
*
* @param <T> the constructor type.
* @param ctor the prototype constructor object, not {@code null}.
- * @return the constructor, {@code null} if no matching accessible constructor found.
+ * @return The constructor, {@code null} if no matching accessible constructor found.
* @see SecurityManager
* @throws NullPointerException if {@code ctor} is {@code null}
* @throws SecurityException Thrown if a security manager is present and a caller's class loader is not the same as or an ancestor of the class loader
@@ -106,7 +106,7 @@ public static <T> Constructor<T> getAccessibleConstructor(final Constructor<T> c
* @param <T> the constructor type.
* @param cls the class to find a constructor for, not {@code null}.
* @param parameterTypes find method with compatible parameters.
- * @return the constructor, null if no matching accessible constructor found.
+ * @return The constructor, null if no matching accessible constructor found.
* @throws NullPointerException Thrown if {@code cls} is {@code null}
* @throws SecurityException Thrown if a security manager is present and the caller's class loader is not the same as or an ancestor of the class loader for the
* class and invocation of {@link SecurityManager#checkPackageAccess(String)} denies access to the package of the class.
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 c2f075710..a9126a027 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
@@ -87,7 +87,7 @@ public static List<Field> getAllFieldsList(final Class<?> cls) {
* the {@link Class} to reflect, must not be {@code null}
* @param fieldName
* the field name to obtain.
- * @return the Field object.
+ * @return The Field object.
* @throws NullPointerException
* if the class is {@code null}.
* @throws IllegalArgumentException
@@ -111,7 +111,7 @@ public static Field getDeclaredField(final Class<?> cls, final String fieldName)
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match {@code public} fields.
- * @return the Field object
+ * @return The Field object
* @throws NullPointerException
* if the class is {@code null}.
* @throws IllegalArgumentException
@@ -145,7 +145,7 @@ public static Field getDeclaredField(final Class<?> cls, final String fieldName,
* the {@link Class} to reflect, must not be {@code null}.
* @param fieldName
* the field name to obtain.
- * @return the Field object.
+ * @return The Field object.
* @throws NullPointerException
* if the class is {@code null}.
* @throws IllegalArgumentException
@@ -169,7 +169,7 @@ public static Field getField(final Class<?> cls, final String fieldName) {
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match {@code public} fields.
- * @return the Field object.
+ * @return The Field object.
* @throws NullPointerException if the class is {@code null}.
* @throws IllegalArgumentException if the field name is blank or empty or is matched at multiple places
* in the inheritance hierarchy.
@@ -267,7 +267,7 @@ public static Field[] getFieldsWithAnnotation(final Class<?> cls, final Class<?
* the object to reflect, must not be {@code null}.
* @param fieldName
* the field name to obtain.
- * @return the value of the field.
+ * @return The value of the field.
* @throws NullPointerException
* if {@code target} is {@code null}.
* @throws IllegalArgumentException
@@ -292,7 +292,7 @@ public static Object readDeclaredField(final Object target, final String fieldNa
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match public fields.
- * @return the Field object.
+ * @return The Field object.
* @throws NullPointerException
* if {@code target} is {@code null}.
* @throws IllegalArgumentException
@@ -319,7 +319,7 @@ public static Object readDeclaredField(final Object target, final String fieldNa
* the {@link Class} to reflect, must not be {@code null}.
* @param fieldName
* the field name to obtain.
- * @return the value of the field.
+ * @return The value of the field.
* @throws NullPointerException
* if the class is {@code null}, or the field could not be found.
* @throws IllegalArgumentException
@@ -344,7 +344,7 @@ public static Object readDeclaredStaticField(final Class<?> cls, final String fi
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match {@code public} fields.
- * @return the Field object
+ * @return The Field object
* @throws NullPointerException
* if the class is {@code null}, or the field could not be found.
* @throws IllegalArgumentException
@@ -368,7 +368,7 @@ public static Object readDeclaredStaticField(final Class<?> cls, final String fi
* the field to use.
* @param target
* the object to call on, may be {@code null} for {@code static} fields.
- * @return the field value
+ * @return The field value
* @throws NullPointerException
* if the field is {@code null}.
* @throws IllegalAccessException
@@ -390,7 +390,7 @@ public static Object readField(final Field field, final Object target) throws Il
* @param forceAccess
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method.
- * @return the field value
+ * @return The field value
* @throws NullPointerException
* if the field is {@code null}.
* @throws IllegalAccessException
@@ -412,7 +412,7 @@ public static Object readField(final Field field, final Object target, final boo
* the object to reflect, must not be {@code null}.
* @param fieldName
* the field name to obtain.
- * @return the value of the field.
+ * @return The value of the field.
* @throws NullPointerException
* if the target is {@code null}.
* @throws IllegalArgumentException
@@ -437,7 +437,7 @@ public static Object readField(final Object target, final String fieldName) thro
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match {@code public} fields.
- * @return the field value
+ * @return The field value
* @throws NullPointerException
* if {@code target} is {@code null}.
* @throws IllegalArgumentException
@@ -463,7 +463,7 @@ public static Object readField(final Object target, final String fieldName, fina
* the {@link Class} to reflect, must not be {@code null}.
* @param fieldName
* the field name to obtain.
- * @return the value of the field.
+ * @return The value of the field.
* @throws NullPointerException
* if the class is {@code null}, or the field could not be found.
* @throws IllegalArgumentException
@@ -488,7 +488,7 @@ public static Object readStaticField(final Class<?> cls, final String fieldName)
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method. {@code false} will only
* match {@code public} fields.
- * @return the Field object.
+ * @return The Field object.
* @throws NullPointerException
* if the class is {@code null}, or the field could not be found.
* @throws IllegalArgumentException
@@ -510,7 +510,7 @@ public static Object readStaticField(final Class<?> cls, final String fieldName,
*
* @param field
* to read.
- * @return the field value.
+ * @return The field value.
* @throws NullPointerException
* if the field is {@code null}.
* @throws IllegalArgumentException
@@ -532,7 +532,7 @@ public static Object readStaticField(final Field field) throws IllegalAccessExce
* @param forceAccess
* whether to break scope restrictions using the
* {@link AccessibleObject#setAccessible(boolean)} method.
- * @return the field value.
+ * @return The field value.
* @throws NullPointerException
* if the field is {@code null}.
* @throws IllegalArgumentException
diff --git a/src/main/java/org/apache/commons/lang3/reflect/InheritanceUtils.java b/src/main/java/org/apache/commons/lang3/reflect/InheritanceUtils.java
index 01b7881c6..876d92b24 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/InheritanceUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/InheritanceUtils.java
@@ -30,7 +30,7 @@ public class InheritanceUtils {
*
* @param child the child class, may be {@code null}
* @param parent the parent class, may be {@code null}
- * @return the number of generations between the child and parent; 0 if the same class;
+ * @return The number of generations between the child and parent; 0 if the same class;
* -1 if the classes are not related as child and parent (includes where either class is null)
* @since 3.2
*/
diff --git a/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java b/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
index a7bd60f67..860e2fb8f 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java
@@ -75,7 +75,7 @@ public class MethodUtils {
*
* @param fromClassArray the Class array to calculate the distance from.
* @param toClassArray the Class array to calculate the distance to.
- * @return the aggregate number of inheritance hops between assignable argument class types.
+ * @return The aggregate number of inheritance hops between assignable argument class types.
*/
private static int distance(final Class<?>[] fromClassArray, final Class<?>[] toClassArray) {
int answer = 0;
@@ -167,7 +167,7 @@ public static Method getAccessibleMethod(final Method method) {
* @param cls Parent class for the interfaces to be checked.
* @param methodName Method name of the method we wish to call.
* @param parameterTypes The parameter type signatures.
- * @return the accessible method or {@code null} if not found.
+ * @return The accessible method or {@code null} if not found.
*/
private static Method getAccessibleMethodFromInterfaceNest(Class<?> cls, final String methodName, final Class<?>... parameterTypes) {
// Search up the superclass chain
@@ -205,7 +205,7 @@ private static Method getAccessibleMethodFromInterfaceNest(Class<?> cls, final S
* @param cls Class to be checked.
* @param methodName Method name of the method we wish to call.
* @param parameterTypes The parameter type signatures.
- * @return the accessible method or {@code null} if not found.
+ * @return The accessible method or {@code null} if not found.
*/
private static Method getAccessibleMethodFromSuperclass(final Class<?> cls, final String methodName, final Class<?>... parameterTypes) {
Class<?> parentClass = cls.getSuperclass();
@@ -223,7 +223,7 @@ private static Method getAccessibleMethodFromSuperclass(final Class<?> cls, fina
* interfaces, and so on in a breadth first way.
*
* @param cls the class to look up, may be {@code null}.
- * @return the combined {@link List} of superclasses and interfaces in order going up from this one {@code null} if null input.
+ * @return The combined {@link List} of superclasses and interfaces in order going up from this one {@code null} if null input.
*/
private static List<Class<?>> getAllSuperclassesAndInterfaces(final Class<?> cls) {
if (cls == null) {
@@ -261,7 +261,7 @@ private static List<Class<?>> getAllSuperclassesAndInterfaces(final Class<?> cls
* @param searchSupers determines if a lookup in the entire inheritance hierarchy of the given class is performed if the annotation was not directly
* present.
* @param ignoreAccess determines if underlying method has to be accessible.
- * @return the first matching annotation, or {@code null} if not found.
+ * @return The first matching annotation, or {@code null} if not found.
* @throws NullPointerException if either the method or annotation class is {@code null}.
* @throws SecurityException if an underlying accessible object's method denies the request.
* @see SecurityManager#checkPermission
diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
index ee045ab1c..c0bd93e3d 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java
@@ -606,7 +606,7 @@ public static Type getArrayComponentType(final Type type) {
*
* @param cls the class in question.
* @param superClass the super class.
- * @return the closes parent type.
+ * @return The closes parent type.
*/
private static Type getClosestParentType(final Class<?> cls, final Class<?> superClass) {
// only look at the interfaces if the super class is also an interface
@@ -683,7 +683,7 @@ public static Type[] getImplicitUpperBounds(final WildcardType wildcardType) {
* Transforms the passed in type to a {@link Class} object. Type-checking method of convenience.
*
* @param parameterizedType the type to be converted.
- * @return the corresponding {@link Class} object.
+ * @return The corresponding {@link Class} object.
* @throws IllegalStateException if the conversion fails.
*/
private static Class<?> getRawType(final ParameterizedType parameterizedType) {
@@ -706,7 +706,7 @@ private static Class<?> getRawType(final ParameterizedType parameterizedType) {
*
* @param type to resolve.
* @param assigningType type to be resolved against.
- * @return the resolved {@link Class} object or {@code null} if the type could not be resolved.
+ * @return The resolved {@link Class} object or {@code null} if the type could not be resolved.
*/
public static Class<?> getRawType(final Type type, final Type assigningType) {
if (type instanceof Class<?>) {
@@ -763,7 +763,7 @@ public static Class<?> getRawType(final Type type, final Type assigningType) {
* @param cls the class in question.
* @param toClass the context class.
* @param subtypeVarAssigns a map with type variables.
- * @return the {@link Map} with type arguments.
+ * @return The {@link Map} with type arguments.
*/
private static Map<TypeVariable<?>, Type> getTypeArguments(Class<?> cls, final Class<?> toClass, final Map<TypeVariable<?>, Type> subtypeVarAssigns) {
// make sure they're assignable
@@ -808,7 +808,7 @@ public static Map<TypeVariable<?>, Type> getTypeArguments(final ParameterizedTyp
* @param parameterizedType the parameterized type.
* @param toClass the class.
* @param subtypeVarAssigns a map with type variables.
- * @return the {@link Map} with type arguments.
+ * @return The {@link Map} with type arguments.
*/
private static Map<TypeVariable<?>, Type> getTypeArguments(final ParameterizedType parameterizedType, final Class<?> toClass,
final Map<TypeVariable<?>, Type> subtypeVarAssigns) {
@@ -891,7 +891,7 @@ public static Map<TypeVariable<?>, Type> getTypeArguments(final Type type, final
* @param type the type in question.
* @param toClass the class.
* @param subtypeVarAssigns a map with type variables.
- * @return the {@link Map} with type arguments.
+ * @return The {@link Map} with type arguments.
*/
private static Map<TypeVariable<?>, Type> getTypeArguments(final Type type, final Class<?> toClass, final Map<TypeVariable<?>, Type> subtypeVarAssigns) {
if (type instanceof Class<?>) {
@@ -1505,7 +1505,7 @@ public static final ParameterizedType parameterizeWithOwner(final Type owner, fi
*
* @param type the type to be replaced.
* @param typeVarAssigns the map with type variables.
- * @return the replaced type.
+ * @return The replaced type.
* @throws IllegalArgumentException if the type cannot be substituted.
*/
private static Type substituteTypeVariables(final Type type, final Map<TypeVariable<?>, Type> typeVarAssigns) {
diff --git a/src/main/java/org/apache/commons/lang3/stream/IntStreams.java b/src/main/java/org/apache/commons/lang3/stream/IntStreams.java
index 9ed97b48e..ad8d2e72b 100644
--- a/src/main/java/org/apache/commons/lang3/stream/IntStreams.java
+++ b/src/main/java/org/apache/commons/lang3/stream/IntStreams.java
@@ -32,7 +32,7 @@ public class IntStreams {
* Null-safe version of {@link IntStream#of(int[])}.
*
* @param values the elements of the new stream, may be {@code null}.
- * @return the new stream on {@code values} or {@link IntStream#empty()}.
+ * @return The new stream on {@code values} or {@link IntStream#empty()}.
* @since 3.18.0
*/
@SafeVarargs // Creating a stream from an array is safe
diff --git a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
index 17dd345ec..37ff4abdd 100644
--- a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
+++ b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java
@@ -101,7 +101,7 @@ public Supplier<A> supplier() {
* @param <A> the intermediate accumulation type of the {@code Collector}.
* @param collector the {@code Collector} describing the reduction.
* @param array The array, assumed to be unmodified during use, a null array treated as an empty array.
- * @return the result of the reduction
+ * @return The result of the reduction
* @see Stream#collect(Collector)
* @see Arrays#stream(Object[])
* @see Collectors
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 a1f9b6285..8fd57c3cf 100644
--- a/src/main/java/org/apache/commons/lang3/stream/Streams.java
+++ b/src/main/java/org/apache/commons/lang3/stream/Streams.java
@@ -289,7 +289,7 @@ protected void assertNotTerminated() {
* @param <R> The type of the result
* @param <A> The intermediate accumulation type of the {@link Collector}
* @param collector the {@link Collector} describing the reduction
- * @return the result of the reduction
+ * @return The result of the reduction
* @see #collect(Supplier, BiConsumer, BiConsumer)
* @see Collectors
*/
@@ -358,7 +358,7 @@ public <A, R> R collect(final Supplier<R> supplier, final BiConsumer<R, ? super
*
* @param predicate a non-interfering, stateless predicate to apply to each element to determine if it should be
* included.
- * @return the new stream
+ * @return The new stream
*/
public FailableStream<T> filter(final FailablePredicate<T, ?> predicate) {
assertNotTerminated();
@@ -404,7 +404,7 @@ protected void makeTerminated() {
*
* @param <R> The element type of the new stream
* @param mapper A non-interfering, stateless function to apply to each element
- * @return the new stream
+ * @return The new stream
*/
public <R> FailableStream<R> map(final FailableFunction<T, R, ?> mapper) {
assertNotTerminated();
@@ -461,7 +461,7 @@ public <R> FailableStream<R> map(final FailableFunction<T, R, ?> mapper) {
*
* @param identity the identity value for the accumulating function
* @param accumulator an associative, non-interfering, stateless function for combining two values
- * @return the result of the reduction
+ * @return The result of the reduction
*/
public T reduce(final T identity, final BinaryOperator<T> accumulator) {
makeTerminated();
@@ -571,7 +571,7 @@ public static <T> FailableStream<T> failableStream(final Stream<T> stream) {
*
* @param <T> The type of stream elements.
* @param value the single element of the new stream, may be {@code null}.
- * @return the new FailableStream on {@code value} or an empty stream.
+ * @return The new FailableStream on {@code value} or an empty stream.
* @since 3.15.0
*/
public static <T> FailableStream<T> failableStream(final T value) {
@@ -583,7 +583,7 @@ public static <T> FailableStream<T> failableStream(final T value) {
*
* @param <T> The type of stream elements.
* @param values the elements of the new stream, may be {@code null}.
- * @return the new FailableStream on {@code values} or an empty stream.
+ * @return The new FailableStream on {@code values} or an empty stream.
* @since 3.14.0
*/
@SafeVarargs // Creating a stream from an array is safe
@@ -717,7 +717,7 @@ public static <E> Stream<E> of(final Iterator<E> iterator) {
*
* @param <E> The type of elements in the collection.
* @param stream the stream to stream or null.
- * @return the stream or {@link Stream#empty()} if the stream is null.
+ * @return The stream or {@link Stream#empty()} if the stream is null.
* @since 3.13.0
*/
private static <E> Stream<E> of(final Stream<E> stream) {
@@ -729,7 +729,7 @@ private static <E> Stream<E> of(final Stream<E> stream) {
*
* @param <T> The type of stream elements.
* @param values the elements of the new stream, may be {@code null}.
- * @return the new stream on {@code values} or {@link Stream#empty()}.
+ * @return The new stream on {@code values} or {@link Stream#empty()}.
* @since 3.13.0
*/
@SafeVarargs // Creating a stream from an array is safe
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 fdfe382f6..f94171fc8 100644
--- a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
+++ b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java
@@ -98,7 +98,7 @@ public Format getParser() {
* @param pos the ParsePosition containing the position to parse from, will
* be updated according to parsing success (index) or failure
* (error index)
- * @return the parsed Object
+ * @return The parsed Object
* @see Format#parseObject(String, ParsePosition)
*/
@Override
diff --git a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
index a94232293..c00e99d89 100644
--- a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
+++ b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java
@@ -54,7 +54,7 @@ public class FormattableUtils {
* @param flags the flags for formatting, see {@link Formattable}.
* @param width the width of the output, see {@link Formattable}.
* @param precision the precision of the output, see {@link Formattable}.
- * @return the {@code formatter} instance, not null.
+ * @return The {@code formatter} instance, not null.
*/
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width,
final int precision) {
@@ -71,7 +71,7 @@ public static Formatter append(final CharSequence seq, final Formatter formatter
* @param width the width of the output, see {@link Formattable}.
* @param precision the precision of the output, see {@link Formattable}.
* @param padChar the pad character to use.
- * @return the {@code formatter} instance, not null.
+ * @return The {@code formatter} instance, not null.
*/
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width,
final int precision, final char padChar) {
@@ -89,7 +89,7 @@ public static Formatter append(final CharSequence seq, final Formatter formatter
* @param padChar the pad character to use.
* @param ellipsis the ellipsis to use when precision dictates truncation, null or
* empty causes a hard truncation.
- * @return the {@code formatter} instance, not null.
+ * @return The {@code formatter} instance, not null.
*/
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width,
final int precision, final char padChar, final CharSequence ellipsis) {
@@ -118,7 +118,7 @@ public static Formatter append(final CharSequence seq, final Formatter formatter
* @param precision the precision of the output, see {@link Formattable}.
* @param ellipsis the ellipsis to use when precision dictates truncation, null or
* empty causes a hard truncation.
- * @return the {@code formatter} instance, not null.
+ * @return The {@code formatter} instance, not null.
*/
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width,
final int precision, final CharSequence ellipsis) {
@@ -130,7 +130,7 @@ public static Formatter append(final CharSequence seq, final Formatter formatter
* {@link Formattable}.
*
* @param formattable the instance to convert to a string, not null.
- * @return the resulting string, not null.
+ * @return The resulting string, not null.
*/
public static String toString(final Formattable formattable) {
return String.format(SIMPLEST_FORMAT, formattable);
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 97456ef82..c33966c6a 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java
@@ -1568,7 +1568,7 @@ public Writer asWriter() {
/**
* Implement the {@link Builder} interface.
*
- * @return the builder as a String
+ * @return The builder as a String
* @since 3.2
* @see #toString()
*/
@@ -1580,7 +1580,7 @@ public String build() {
/**
* Gets the current size of the internal character array buffer.
*
- * @return the capacity.
+ * @return The capacity.
*/
public int capacity() {
return buffer.length;
@@ -1590,7 +1590,7 @@ public int capacity() {
* Gets the character at the specified index.
*
* @param index the index to retrieve, must be valid.
- * @return the character at the index.
+ * @return The character at the index.
* @throws IndexOutOfBoundsException if the index is invalid.
* @see #setCharAt(int, char)
* @see #deleteCharAt(int)
@@ -1926,7 +1926,7 @@ public boolean equalsIgnoreCase(final StrBuilder other) {
/**
* Gets the internal buffer for testing.
*
- * @return the internal buffer.
+ * @return The internal buffer.
*/
char[] getBuffer() {
return buffer;
@@ -1936,7 +1936,7 @@ char[] getBuffer() {
* Copies the character array into the specified array.
*
* @param destination the destination array, null will cause an array to be created.
- * @return the input array, unless that was null or too small.
+ * @return The input array, unless that was null or too small.
*/
public char[] getChars(char[] destination) {
final int len = length();
@@ -1981,7 +1981,7 @@ public String getNewLineText() {
/**
* Gets the text to be appended when null is added.
*
- * @return the null text, null means no append.
+ * @return The null text, null means no append.
*/
public String getNullText() {
return nullText;
@@ -2006,7 +2006,7 @@ public int hashCode() {
* Searches the string builder to find the first reference to the specified char.
*
* @param ch the character to find.
- * @return the first index of the character, or -1 if not found.
+ * @return The first index of the character, or -1 if not found.
*/
public int indexOf(final char ch) {
return indexOf(ch, 0);
@@ -2017,7 +2017,7 @@ public int indexOf(final char ch) {
*
* @param ch the character to find.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the first index of the character, or -1 if not found.
+ * @return The first index of the character, or -1 if not found.
*/
public int indexOf(final char ch, int startIndex) {
startIndex = Math.max(startIndex, 0);
@@ -2040,7 +2040,7 @@ public int indexOf(final char ch, int startIndex) {
* </p>
*
* @param str the string to find, null returns -1.
- * @return the first index of the string, or -1 if not found.
+ * @return The first index of the string, or -1 if not found.
*/
public int indexOf(final String str) {
return indexOf(str, 0);
@@ -2055,7 +2055,7 @@ public int indexOf(final String str) {
*
* @param str the string to find, null returns -1.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the first index of the string, or -1 if not found.
+ * @return The first index of the string, or -1 if not found.
*/
public int indexOf(final String str, final int startIndex) {
return Strings.CS.indexOf(this, str, startIndex);
@@ -2070,7 +2070,7 @@ public int indexOf(final String str, final int startIndex) {
* </p>
*
* @param matcher the matcher to use, null returns -1.
- * @return the first index matched, or -1 if not found.
+ * @return The first index matched, or -1 if not found.
*/
public int indexOf(final StrMatcher matcher) {
return indexOf(matcher, 0);
@@ -2087,7 +2087,7 @@ public int indexOf(final StrMatcher matcher) {
*
* @param matcher the matcher to use, null returns -1.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the first index matched, or -1 if not found.
+ * @return The first index matched, or -1 if not found.
*/
public int indexOf(final StrMatcher matcher, int startIndex) {
startIndex = Math.max(startIndex, 0);
@@ -2329,7 +2329,7 @@ public boolean isNotEmpty() {
* Searches the string builder to find the last reference to the specified char.
*
* @param ch the character to find.
- * @return the last index of the character, or -1 if not found.
+ * @return The last index of the character, or -1 if not found.
*/
public int lastIndexOf(final char ch) {
return lastIndexOf(ch, size - 1);
@@ -2340,7 +2340,7 @@ public int lastIndexOf(final char ch) {
*
* @param ch the character to find.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the last index of the character, or -1 if not found.
+ * @return The last index of the character, or -1 if not found.
*/
public int lastIndexOf(final char ch, int startIndex) {
startIndex = startIndex >= size ? size - 1 : startIndex;
@@ -2362,7 +2362,7 @@ public int lastIndexOf(final char ch, int startIndex) {
* </p>
*
* @param str the string to find, null returns -1.
- * @return the last index of the string, or -1 if not found.
+ * @return The last index of the string, or -1 if not found.
*/
public int lastIndexOf(final String str) {
return lastIndexOf(str, size - 1);
@@ -2377,7 +2377,7 @@ public int lastIndexOf(final String str) {
*
* @param str the string to find, null returns -1.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the last index of the string, or -1 if not found.
+ * @return The last index of the string, or -1 if not found.
*/
public int lastIndexOf(final String str, final int startIndex) {
return Strings.CS.lastIndexOf(this, str, startIndex);
@@ -2392,7 +2392,7 @@ public int lastIndexOf(final String str, final int startIndex) {
* </p>
*
* @param matcher the matcher to use, null returns -1.
- * @return the last index matched, or -1 if not found.
+ * @return The last index matched, or -1 if not found.
*/
public int lastIndexOf(final StrMatcher matcher) {
return lastIndexOf(matcher, size);
@@ -2409,7 +2409,7 @@ public int lastIndexOf(final StrMatcher matcher) {
*
* @param matcher the matcher to use, null returns -1.
* @param startIndex the index to start at, invalid index rounded to edge.
- * @return the last index matched, or -1 if not found.
+ * @return The last index matched, or -1 if not found.
*/
public int lastIndexOf(final StrMatcher matcher, int startIndex) {
startIndex = startIndex >= size ? size - 1 : startIndex;
@@ -2437,7 +2437,7 @@ public int lastIndexOf(final StrMatcher matcher, int startIndex) {
* </p>
*
* @param length the number of characters to extract, negative returns empty string.
- * @return the new string.
+ * @return The new string.
*/
public String leftString(final int length) {
if (length <= 0) {
@@ -2452,7 +2452,7 @@ public String leftString(final int length) {
/**
* Gets the length of the string builder.
*
- * @return the length
+ * @return The length
*/
@Override
public int length() {
@@ -2474,7 +2474,7 @@ public int length() {
*
* @param index the index to start at, negative means zero.
* @param length the number of characters to extract, negative returns empty string.
- * @return the new string.
+ * @return The new string.
*/
public String midString(int index, final int length) {
if (index < 0) {
@@ -2506,7 +2506,7 @@ public StrBuilder minimizeCapacity() {
* character buffer without making extra copies.
*
* @param readable object to read from.
- * @return the number of characters read.
+ * @return The number of characters read.
* @throws IOException if an I/O error occurs.
* @since 3.4
* @see #appendTo(Appendable)
@@ -2796,7 +2796,7 @@ public StrBuilder reverse() {
* </p>
*
* @param length the number of characters to extract, negative returns empty string.
- * @return the new string.
+ * @return The new string.
*/
public String rightString(final int length) {
if (length <= 0) {
@@ -2880,7 +2880,7 @@ public StrBuilder setNullText(String nullText) {
* API of Collections.
* </p>
*
- * @return the length.
+ * @return The length.
*/
public int size() {
return size;
@@ -2937,7 +2937,7 @@ public CharSequence subSequence(final int startIndex, final int endIndex) {
* Extracts a portion of this string builder as a string.
*
* @param start the start index, inclusive, must be valid.
- * @return the new string.
+ * @return The new string.
* @throws IndexOutOfBoundsException if the index is invalid.
*/
public String substring(final int start) {
@@ -2953,7 +2953,7 @@ public String substring(final int start) {
*
* @param startIndex the start index, inclusive, must be valid.
* @param endIndex the end index, exclusive, must be valid except that if too large it is treated as end of string.
- * @return the new string.
+ * @return The new string.
* @throws IndexOutOfBoundsException if the index is invalid.
*/
public String substring(final int startIndex, int endIndex) {
@@ -2998,7 +2998,7 @@ public char[] toCharArray(final int startIndex, int endIndex) {
* independent of the string builder.
* </p>
*
- * @return the builder as a String.
+ * @return The builder as a String.
*/
@Override
public String toString() {
@@ -3009,7 +3009,7 @@ public String toString() {
* Gets a StringBuffer version of the string builder, creating a
* new instance each time the method is called.
*
- * @return the builder as a StringBuffer.
+ * @return The builder as a StringBuffer.
*/
public StringBuffer toStringBuffer() {
return new StringBuffer(size).append(buffer, 0, size);
@@ -3019,7 +3019,7 @@ public StringBuffer toStringBuffer() {
* Gets a StringBuilder version of the string builder, creating a
* new instance each time the method is called.
*
- * @return the builder as a StringBuilder.
+ * @return The builder as a StringBuilder.
* @since 3.2
*/
public StringBuilder toStringBuilder() {
@@ -3071,7 +3071,7 @@ protected void validateIndex(final int index) {
*
* @param startIndex the start index, inclusive, must be valid.
* @param endIndex the end index, exclusive, must be valid except that if too large it is treated as end of string.
- * @return the new string.
+ * @return The new string.
* @throws IndexOutOfBoundsException if the index is invalid.
*/
protected int validateRange(final int startIndex, int endIndex) {
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 f0135e94a..013c26be1 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrLookup.java
@@ -73,7 +73,7 @@ private static final class MapStrLookup<V> extends StrLookup<V> {
* </p>
*
* @param key the key to be looked up, may be null.
- * @return the matching value, null if no match.
+ * @return The matching value, null if no match.
*/
@Override
public String lookup(final String key) {
@@ -180,7 +180,7 @@ protected StrLookup() {
* }</pre>
*
* @param key the key to be looked up, may be null.
- * @return the matching value, null if no match.
+ * @return The matching value, null if no match.
*/
public abstract String lookup(String key);
}
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 f455e079f..60c9c7744 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java
@@ -62,7 +62,7 @@ static final class CharMatcher extends StrMatcher {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
@Override
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) {
@@ -94,7 +94,7 @@ static final class CharSetMatcher extends StrMatcher {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
@Override
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) {
@@ -120,7 +120,7 @@ static final class NoMatcher extends StrMatcher {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
@Override
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) {
@@ -152,7 +152,7 @@ static final class StringMatcher extends StrMatcher {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
@Override
public int isMatch(final char[] buffer, int pos, final int bufferStart, final int bufferEnd) {
@@ -193,7 +193,7 @@ static final class TrimMatcher extends StrMatcher {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
@Override
public int isMatch(final char[] buffer, final int pos, final int bufferStart, final int bufferEnd) {
@@ -292,7 +292,7 @@ public static StrMatcher charSetMatcher(final String chars) {
/**
* Gets the matcher for the comma character.
*
- * @return the matcher for a comma.
+ * @return The matcher for a comma.
*/
public static StrMatcher commaMatcher() {
return COMMA_MATCHER;
@@ -301,7 +301,7 @@ public static StrMatcher commaMatcher() {
/**
* Gets the matcher for the double quote character.
*
- * @return the matcher for a double quote.
+ * @return The matcher for a double quote.
*/
public static StrMatcher doubleQuoteMatcher() {
return DOUBLE_QUOTE_MATCHER;
@@ -310,7 +310,7 @@ public static StrMatcher doubleQuoteMatcher() {
/**
* Gets the matcher for no characters.
*
- * @return the matcher that matches nothing.
+ * @return The matcher that matches nothing.
*/
public static StrMatcher noneMatcher() {
return NONE_MATCHER;
@@ -319,7 +319,7 @@ public static StrMatcher noneMatcher() {
/**
* Gets the matcher for the single or double quote character.
*
- * @return the matcher for a single or double quote.
+ * @return The matcher for a single or double quote.
*/
public static StrMatcher quoteMatcher() {
return QUOTE_MATCHER;
@@ -328,7 +328,7 @@ public static StrMatcher quoteMatcher() {
/**
* Gets the matcher for the single quote character.
*
- * @return the matcher for a single quote.
+ * @return The matcher for a single quote.
*/
public static StrMatcher singleQuoteMatcher() {
return SINGLE_QUOTE_MATCHER;
@@ -337,7 +337,7 @@ public static StrMatcher singleQuoteMatcher() {
/**
* Gets the matcher for the space character.
*
- * @return the matcher for a space.
+ * @return The matcher for a space.
*/
public static StrMatcher spaceMatcher() {
return SPACE_MATCHER;
@@ -347,7 +347,7 @@ public static StrMatcher spaceMatcher() {
* Gets the matcher for the same characters as StringTokenizer,
* namely space, tab, newline and form-feed.
*
- * @return the split matcher.
+ * @return The split matcher.
*/
public static StrMatcher splitMatcher() {
return SPLIT_MATCHER;
@@ -369,7 +369,7 @@ public static StrMatcher stringMatcher(final String str) {
/**
* Gets the matcher for the tab character.
*
- * @return the matcher for a tab.
+ * @return The matcher for a tab.
*/
public static StrMatcher tabMatcher() {
return TAB_MATCHER;
@@ -378,7 +378,7 @@ public static StrMatcher tabMatcher() {
/**
* Gets the matcher to String trim() whitespace characters.
*
- * @return the trim matcher.
+ * @return The trim matcher.
*/
public static StrMatcher trimMatcher() {
return TRIM_MATCHER;
@@ -410,7 +410,7 @@ protected StrMatcher() {
*
* @param buffer the text content to match against, do not change.
* @param pos the starting position for the match, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
* @since 2.4
*/
public int isMatch(final char[] buffer, final int pos) {
@@ -444,7 +444,7 @@ public int isMatch(final char[] buffer, final int pos) {
* @param pos the starting position for the match, valid for buffer.
* @param bufferStart the first active index in the buffer, valid for buffer.
* @param bufferEnd the end index (exclusive) of the active buffer, valid for buffer.
- * @return the number of matching characters, zero for no match.
+ * @return The number of matching characters, zero for no match.
*/
public abstract int isMatch(char[] buffer, int pos, int bufferStart, int bufferEnd);
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 3fcc6a0d8..8af09a1ed 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
@@ -177,7 +177,7 @@ public class StrSubstitutor {
* @param <V> The type of the values in the map.
* @param source the source text containing the variables to substitute, null returns null.
* @param valueMap the map with the values, may be null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public static <V> String replace(final Object source, final Map<String, V> valueMap) {
return new StrSubstitutor(valueMap).replace(source);
@@ -193,7 +193,7 @@ public static <V> String replace(final Object source, final Map<String, V> value
* @param valueMap the map with the values, may be null.
* @param prefix the prefix of variables, not null.
* @param suffix the suffix of variables, not null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
* @throws IllegalArgumentException if the prefix or suffix is null.
*/
public static <V> String replace(final Object source, final Map<String, V> valueMap, final String prefix, final String suffix) {
@@ -206,7 +206,7 @@ public static <V> String replace(final Object source, final Map<String, V> value
*
* @param source the source text containing the variables to substitute, null returns null.
* @param valueProperties the properties with values, may be null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public static String replace(final Object source, final Properties valueProperties) {
if (valueProperties == null) {
@@ -227,7 +227,7 @@ public static String replace(final Object source, final Properties valueProperti
* their matching values from the system properties.
*
* @param source the source text containing the variables to substitute, null returns null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public static String replaceSystemProperties(final Object source) {
return new StrSubstitutor(StrLookup.systemPropertiesLookup()).replace(source);
@@ -429,7 +429,7 @@ private void checkCyclicSubstitution(final String varName, final List<String> pr
/**
* Gets the escape character.
*
- * @return the character used for escaping variable references
+ * @return The character used for escaping variable references
*/
public char getEscapeChar() {
return this.escapeChar;
@@ -446,7 +446,7 @@ public char getEscapeChar() {
* If it returns null, then the variable default value resolution is disabled.
* </p>
*
- * @return the variable default value delimiter matcher in use, may be null.
+ * @return The variable default value delimiter matcher in use, may be null.
* @since 3.2
*/
public StrMatcher getValueDelimiterMatcher() {
@@ -461,7 +461,7 @@ public StrMatcher getValueDelimiterMatcher() {
* allowing advanced prefix matches.
* </p>
*
- * @return the prefix matcher in use.
+ * @return The prefix matcher in use.
*/
public StrMatcher getVariablePrefixMatcher() {
return prefixMatcher;
@@ -470,7 +470,7 @@ public StrMatcher getVariablePrefixMatcher() {
/**
* Gets the VariableResolver that is used to lookup variables.
*
- * @return the VariableResolver.
+ * @return The VariableResolver.
*/
public StrLookup<?> getVariableResolver() {
return this.variableResolver;
@@ -484,7 +484,7 @@ public StrLookup<?> getVariableResolver() {
* allowing advanced suffix matches.
* </p>
*
- * @return the suffix matcher in use.
+ * @return The suffix matcher in use.
*/
public StrMatcher getVariableSuffixMatcher() {
return suffixMatcher;
@@ -493,7 +493,7 @@ public StrMatcher getVariableSuffixMatcher() {
/**
* Tests whether substitution is done in variable names.
*
- * @return the substitution in variable names flag.
+ * @return The substitution in variable names flag.
* @since 3.0
*/
public boolean isEnableSubstitutionInVariables() {
@@ -503,7 +503,7 @@ public boolean isEnableSubstitutionInVariables() {
/**
* Tests whether escapes are preserved during substitution.
*
- * @return the preserve escape flag.
+ * @return The preserve escape flag.
* @since 3.5
*/
public boolean isPreserveEscapes() {
@@ -516,7 +516,7 @@ public boolean isPreserveEscapes() {
* The array is not altered by this method.
*
* @param source the character array to replace in, not altered, null returns null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public String replace(final char[] source) {
if (source == null) {
@@ -539,7 +539,7 @@ public String replace(final char[] source) {
* @param source the character array to replace in, not altered, null returns null.
* @param offset the start offset within the array, must be valid.
* @param length the length within the array to be processed, must be valid.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public String replace(final char[] source, final int offset, final int length) {
if (source == null) {
@@ -556,7 +556,7 @@ public String replace(final char[] source, final int offset, final int length) {
* The source is not altered by this method.
*
* @param source the buffer to use as a template, not changed, null returns null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
* @since 3.2
*/
public String replace(final CharSequence source) {
@@ -578,7 +578,7 @@ public String replace(final CharSequence source) {
* @param source the buffer to use as a template, not changed, null returns null.
* @param offset the start offset within the array, must be valid.
* @param length the length within the array to be processed, must be valid.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
* @since 3.2
*/
public String replace(final CharSequence source, final int offset, final int length) {
@@ -596,7 +596,7 @@ public String replace(final CharSequence source, final int offset, final int len
* converted to a string using {@code toString} and is not altered.
*
* @param source the source to replace in, null returns null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
public String replace(final Object source) {
if (source == null) {
@@ -613,7 +613,7 @@ public String replace(final Object source) {
* The builder is not altered by this method.
*
* @param source the builder to use as a template, not changed, null returns null.
- * @return the result of the replace operation.
+ * @return The result of the replace operation.
*/
... 2061 lines suppressed ...
(commons-lang) 01/02: Match String case folding in StrBuilder.equalsIgnoreCase (#1745).
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
commit 7515777a2dbc8b7e3622f62e760e303b1f72ad4d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Jul 11 08:31:43 2026 -0400
Match String case folding in StrBuilder.equalsIgnoreCase (#1745).
---
src/changes/changes.xml | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index b713ec600..64a317c66 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -222,6 +222,7 @@ java.lang.NullPointerException: Cannot invoke
<action type="fix" dev="ggregory" due-to="alhudz, Gary Gregory">Keep FastDateParser numeric parse from throwing on int overflow (#1741).</action>
<action type="fix" dev="ggregory" due-to="alhudz, Gary Gregory">Keep FastDateParser.parse error message intact for Japanese imperial locale (#1743).</action>
<action type="fix" dev="ggregory" due-to="alhudz, Gary Gregory">Keep ExtendedMessageFormat from rejecting a quoted format style (#1744).</action>
+ <action type="fix" dev="ggregory" due-to="alhudz, Gary Gregory">Match String case folding in StrBuilder.equalsIgnoreCase (#1745).</action>
<!-- ADD -->
<action type="add" dev="ggregory" due-to="Gary Gregory">Add JavaVersion.JAVA_27.</action>
<action type="add" dev="ggregory" due-to="Gary Gregory">Add SystemUtils.IS_JAVA_27.</action>