(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new a6e112c3a Javadoc a6e112c3a is described below commit a6e112c3a7bda61d8e965c50282b98bb55fb0cbb Author: Gary Gregory AuthorDate: Fri Oct 11 11:43:00 2024 -0400 Javadoc --- .../org/apache/commons/lang3/builder/AbstractSupplier.java | 10 -- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java index cf21560c0..16532191d 100644 --- a/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java +++ b/src/main/java/org/apache/commons/lang3/builder/AbstractSupplier.java @@ -37,9 +37,15 @@ public abstract class AbstractSupplier, E } /** - * Returns this instance typed as the proper subclass type. + * Returns this instance typed as the subclass type {@code B}. + * + * This is the same as the expression: + * + * + * (B) this + * * - * @return this instance typed as the proper subclass type. + * @return this instance typed as the subclass type {@code B}. */ @SuppressWarnings("unchecked") protected B asThis() {
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 1461cc32e Javadoc 1461cc32e is described below commit 1461cc32e024816683f824273f6adee8415b0b35 Author: Gary Gregory AuthorDate: Thu Sep 26 17:05:51 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/Strings.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/Strings.java b/src/main/java/org/apache/commons/lang3/Strings.java index d9428e3d4..0817482d1 100644 --- a/src/main/java/org/apache/commons/lang3/Strings.java +++ b/src/main/java/org/apache/commons/lang3/Strings.java @@ -308,7 +308,7 @@ public abstract class Strings { /** * Tests for equality in a null-safe manner. * - * JDK-8015417. + * See JDK-8015417. */ private static boolean eq(final Object o1, final Object o2) { return o1 == null ? o2 == null : o1.equals(o2);
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 31c7c5bde Javadoc 31c7c5bde is described below commit 31c7c5bde17819783ca84acb78344d2efd5d19fd Author: Gary Gregory AuthorDate: Sat Sep 21 21:49:19 2024 -0400 Javadoc Proper instance initialization --- .../java/org/apache/commons/lang3/StringUtils.java | 6 +- .../java/org/apache/commons/lang3/Strings.java | 593 - 2 files changed, 470 insertions(+), 129 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java index 0f16d63f3..6284bc11b 100644 --- a/src/main/java/org/apache/commons/lang3/StringUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringUtils.java @@ -2529,7 +2529,7 @@ public class StringUtils { */ @Deprecated public static int indexOf(final CharSequence seq, final CharSequence searchSeq) { -return Strings.CS.indexOf(seq, searchSeq, 0); +return Strings.CS.indexOf(seq, searchSeq); } /** @@ -2564,7 +2564,7 @@ public class StringUtils { * -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) Strings.CS.indexOf(CharSequence, CharSequence)} + * @deprecated Use {@link Strings#indexOf(CharSequence, CharSequence, int) Strings.CS.indexOf(CharSequence, CharSequence, int)} */ @Deprecated public static int indexOf(final CharSequence seq, final CharSequence searchSeq, final int startPos) { @@ -3061,7 +3061,7 @@ public class StringUtils { */ @Deprecated public static int indexOfIgnoreCase(final CharSequence str, final CharSequence searchStr) { -return Strings.CI.indexOf(str, searchStr, 0); +return Strings.CI.indexOf(str, searchStr); } /** diff --git a/src/main/java/org/apache/commons/lang3/Strings.java b/src/main/java/org/apache/commons/lang3/Strings.java index c5614ba9d..edca2c0a2 100644 --- a/src/main/java/org/apache/commons/lang3/Strings.java +++ b/src/main/java/org/apache/commons/lang3/Strings.java @@ -31,6 +31,9 @@ import org.apache.commons.lang3.function.ToBooleanBiFunction; */ public abstract class Strings { +/** + * Builds {@link Strings} instances. + */ public static class Builder extends AbstractSupplier { /** @@ -43,24 +46,31 @@ public abstract class Strings { */ private boolean nullIsLess; +/** + * Gets a new {@link Strings} instance. + */ @Override public Strings get() { -return ignoreCase ? new CiStrings(ignoreCase) : new CsStrings(ignoreCase); -} - -protected boolean isIgnoreCase() { -return ignoreCase; -} - -protected boolean isNullIsLess() { -return nullIsLess; +return ignoreCase ? new CiStrings(nullIsLess) : new CsStrings(nullIsLess); } +/** + * Sets the ignoreCase property for new Strings instances. + * + * @param ignoreCase the ignoreCase property for new Strings instances. + * @return this instance. + */ public Builder setIgnoreCase(final boolean ignoreCase) { this.ignoreCase = ignoreCase; return asThis(); } +/** + * Sets the nullIsLess property for new Strings instances. + * + * @param nullIsLess the nullIsLess property for new Strings instances. + * @return this instance. + */ public Builder setNullIsLess(final boolean nullIsLess) { this.nullIsLess = nullIsLess; return asThis(); @@ -92,29 +102,6 @@ public abstract class Strings { return s1.compareToIgnoreCase(s2); } -/** - * Tests if CharSequence contains a search CharSequence irrespective of case, handling {@code null}. Case-insensitivity is defined as by - * {@link String#equalsIgnoreCase(String)}. - * - * - * A {@code null} CharSequence will return {@code false}. - * - * - * - * StringUtils.containsIgnoreCase(null, *)= false - * StringUtils.containsIgnoreCase(*, null)= false - * StringUtils.containsIgnoreCase("", "") = true - * StringUtils.containsIgnoreCase("abc", "") = true - * StringUtils.containsIgnoreCase("abc", "a") = true - * StringUtils.containsIgnoreCase("abc", "z") = false - * StringUtils.containsIgnoreCase("abc", "A") = true - * StringUtils.containsIgnoreCase("abc", "Z") = false -
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 586358fb0 Javadoc 586358fb0 is described below commit 586358fb0eb34a76015f252afffe7c347bf229eb Author: Gary Gregory AuthorDate: Wed Sep 4 10:05:19 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/tuple/Pair.java | 11 ++- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/tuple/Pair.java b/src/main/java/org/apache/commons/lang3/tuple/Pair.java index 059304c6a..6be6316fe 100644 --- a/src/main/java/org/apache/commons/lang3/tuple/Pair.java +++ b/src/main/java/org/apache/commons/lang3/tuple/Pair.java @@ -253,13 +253,14 @@ public abstract class Pair implements Map.Entry, ComparableThis uses {@link java.util.Formattable} to perform the formatting. Two variables may - * be used to embed the left and right elements. Use {@code %1$s} for the left - * element (key) and {@code %2$s} for the right element (value). - * The default format used by {@code toString()} is {@code (%1$s,%2$s)}. + * + * This uses {@link String#format(String, Object...)} to the format. Two variables may be used to embed the left and right elements. Use {@code %1$s} for + * the left element (key) and {@code %2$s} for the right element (value). + * * - * @param format the format string, optionally containing {@code %1$s} and {@code %2$s}, not null + * @param format the format string, optionally containing {@code %1$s} and {@code %2$s}, not null. * @return the formatted string, not null + * @see String#format(String, Object...) */ public String toString(final String format) { return String.format(format, getLeft(), getRight());
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 5d3c26919 Javadoc 5d3c26919 is described below commit 5d3c269193614161daae75946b3f632c65a6d8a8 Author: Gary Gregory AuthorDate: Thu Aug 22 15:50:24 2024 -0400 Javadoc --- .../org/apache/commons/lang3/RandomStringUtils.java| 18 +- .../java/org/apache/commons/lang3/RandomUtils.java | 18 +- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java index ec10f3581..ca2f4a107 100644 --- a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java @@ -25,15 +25,17 @@ import java.util.function.Supplier; /** * Generates random {@link String}s. * - * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator (RNG) - * implementing the default random number algorithm. + * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator implementing the + * default random number algorithm. * * - * Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified in - * the {@code securerandom.strongAlgorithms} {@link Security} property. + * Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an instance that was selected by using + * the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property. * * - * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()}; which is not cryptographically secure. + * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} which is not cryptographically secure. In addition, + * instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to + * {@code true}. * * * Starting in version 3.17.0, the method {@link #secure()} uses {@link SecureRandom#SecureRandom()} instead of {@link SecureRandom#getInstanceStrong()}, and @@ -67,6 +69,12 @@ import java.util.function.Supplier; * #ThreadSafe# * * + * @see #secure() + * @see #secureStrong() + * @see #insecure() + * @see SecureRandom#SecureRandom() + * @see SecureRandom#getInstanceStrong() + * @see ThreadLocalRandom#current() * @see RandomUtils * @since 1.0 */ diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java index 554748362..570831a3b 100644 --- a/src/main/java/org/apache/commons/lang3/RandomUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java @@ -28,15 +28,17 @@ import org.apache.commons.lang3.exception.UncheckedException; /** * Supplements the standard {@link Random} class. * - * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator (RNG) - * implementing the default random number algorithm. + * Use {@link #secure()} to get the singleton instance based on {@link SecureRandom#SecureRandom()} which uses a secure random number generator implementing the + * default random number algorithm. * * - * Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an algorithms/providers specified in - * the {@code securerandom.strongAlgorithms} {@link Security} property. + * Use {@link #secureStrong()} to get the singleton instance based on {@link SecureRandom#getInstanceStrong()} which uses an instance that was selected by using + * the algorithms/providers specified in the {@code securerandom.strongAlgorithms} {@link Security} property. * * - * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()}; which is not cryptographically secure. + * Use {@link #insecure()} to get the singleton instance based on {@link ThreadLocalRandom#current()} which is not cryptographically secure. In addition, + * instances do not use a cryptographically random seed unless the {@linkplain System#getProperty system property} {@code java.util.secureRandomSeed} is set to + * {@code true}. * * * Starting in version 3.17.0, the method {@link #secure()} uses {@link SecureRandom#SecureRandom()} instead of {@link SecureRandom#getInstanceStrong()}, and @@ -57,6 +59,12 @@ imp
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 07dd0ca54 Javadoc 07dd0ca54 is described below commit 07dd0ca548790ff1431b8a0d24718948fa2a1f50 Author: Gary Gregory AuthorDate: Tue Aug 13 14:01:38 2024 -0400 Javadoc Longer line --- .../java/org/apache/commons/lang3/function/Failable.java | 15 +++ 1 file changed, 7 insertions(+), 8 deletions(-) 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 ebffe7266..b3edcd241 100644 --- a/src/main/java/org/apache/commons/lang3/function/Failable.java +++ b/src/main/java/org/apache/commons/lang3/function/Failable.java @@ -496,10 +496,10 @@ public class Failable { * If either the original action, or any of the resource action fails, then the first failure (AKA * {@link Throwable}) is rethrown. Example use: * - * + * {@code * final FileInputStream fis = new FileInputStream("my.file"); - * Functions.tryWithResources(useInputStream(fis), null, () -> fis.close()); - * + * Functions.tryWithResources(useInputStream(fis), null, () -> fis.close()); + * } * * @param action The action to execute. This object will always be invoked. * @param errorHandler An optional error handler, which will be invoked finally, if any error occurred. The error @@ -552,10 +552,10 @@ public class Failable { * If either the original action, or any of the resource action fails, then the first failure (AKA * {@link Throwable}) is rethrown. Example use: * - * + * {@code * final FileInputStream fis = new FileInputStream("my.file"); - * Functions.tryWithResources(useInputStream(fis), () -> fis.close()); - * + * Functions.tryWithResources(useInputStream(fis), () -> fis.close()); + * } * * @param action The action to execute. This object will always be invoked. * @param resources The resource actions to execute. All resource actions will be invoked, in the given @@ -563,8 +563,7 @@ public class Failable { * @see #tryWithResources(FailableRunnable, FailableConsumer, FailableRunnable...) */ @SafeVarargs -public static void tryWithResources(final FailableRunnable action, -final FailableRunnable... resources) { +public static void tryWithResources(final FailableRunnable action, final FailableRunnable... resources) { tryWithResources(action, null, resources); }
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 0d9bda896 Javadoc 0d9bda896 is described below commit 0d9bda8967905c657dafc0a051eb72e10c623c45 Author: Gary Gregory AuthorDate: Wed Aug 7 20:32:12 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/RandomUtils.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java index 219afa5a9..96ae715ed 100644 --- a/src/main/java/org/apache/commons/lang3/RandomUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java @@ -74,7 +74,6 @@ public class RandomUtils { * Gets the singleton instance based on {@link ThreadLocalRandom#current()}; which is not cryptographically * secure; use {@link #secure()} to use an algorithms/providers specified in the * {@code securerandom.strongAlgorithms} {@link Security} property. - * * * The method {@link ThreadLocalRandom#current()} is called on-demand. *
(commons-lang) branch master updated: Javadoc fix
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9345437e0 Javadoc fix 9345437e0 is described below commit 9345437e0f6bdc7232b8fa9eea46b705693dd447 Author: Gary Gregory AuthorDate: Mon Jul 29 19:35:39 2024 -0400 Javadoc fix --- src/main/java/org/apache/commons/lang3/Streams.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Streams.java b/src/main/java/org/apache/commons/lang3/Streams.java index 6a7883f8a..1776b829a 100644 --- a/src/main/java/org/apache/commons/lang3/Streams.java +++ b/src/main/java/org/apache/commons/lang3/Streams.java @@ -52,9 +52,9 @@ import org.apache.commons.lang3.Functions.FailablePredicate; *stream.forEach(consumer); * } * Using a {@link FailableStream}, this can be rewritten as follows: - * + * {@code * Streams.failable(stream).forEach((m) -> m.invoke(o, args)); - * + * } * Obviously, the second version is much more concise and the spirit of * Lambda expressions is met better than in the first version. *
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new b7be19dc9 Javadoc b7be19dc9 is described below commit b7be19dc9f26c86fba870a9d9dcb1391c51b053b Author: Gary Gregory AuthorDate: Sun Jul 21 11:40:50 2024 -0400 Javadoc Use HTML 'em' tag instead of 'i' tag --- .../org/apache/commons/lang3/BooleanUtils.java | 4 +-- .../apache/commons/lang3/CharSequenceUtils.java| 16 +-- .../java/org/apache/commons/lang3/CharSet.java | 2 +- src/main/java/org/apache/commons/lang3/Range.java | 2 +- .../java/org/apache/commons/lang3/StringUtils.java | 32 +++--- .../org/apache/commons/lang3/builder/Diffable.java | 2 +- .../commons/lang3/builder/HashCodeBuilder.java | 2 +- .../lang3/builder/ReflectionToStringBuilder.java | 2 +- .../org/apache/commons/lang3/math/Fraction.java| 6 ++-- .../commons/lang3/text/ExtendedMessageFormat.java | 10 +++ .../apache/commons/lang3/text/StrTokenizer.java| 10 +++ .../org/apache/commons/lang3/text/WordUtils.java | 2 +- 12 files changed, 45 insertions(+), 45 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java index f8f93fa75..dc5d142fc 100644 --- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java +++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java @@ -190,7 +190,7 @@ public class BooleanUtils { } /** - * Checks if a {@link Boolean} value is not {@code false}, + * Checks if a {@link Boolean} value is not {@code false}, * handling {@code null} by returning {@code true}. * * @@ -208,7 +208,7 @@ public class BooleanUtils { } /** - * Checks if a {@link Boolean} value is not {@code true}, + * Checks if a {@link Boolean} value is not {@code true}, * handling {@code null} by returning {@code true}. * * diff --git a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java index eaec29a0e..aa48d1207 100644 --- a/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java +++ b/src/main/java/org/apache/commons/lang3/CharSequenceUtils.java @@ -77,15 +77,15 @@ public class CharSequenceUtils { * object at an index no smaller than {@code start}, then * the index of the first such occurrence is returned. For values * of {@code searchChar} in the range from 0 to 0x (inclusive), - * this is the smallest value k such that: + * this is the smallest value k such that: * * - * (this.charAt(k) == searchChar) && (k >= start) + * (this.charAt(k) == searchChar) && (k >= start) * * is true. For other values of {@code searchChar}, it is the - * smallest value k such that: + * smallest value k such that: * - * (this.codePointAt(k) == searchChar) && (k >= start) + * (this.codePointAt(k) == searchChar) && (k >= start) * * * is true. In either case, if no such character occurs inm {@code cs} @@ -219,14 +219,14 @@ public class CharSequenceUtils { * the specified character, searching backward starting at the * specified index. For values of {@code searchChar} in the range * from 0 to 0x (inclusive), the index returned is the largest - * value k such that: + * value k such that: * - * (this.charAt(k) == searchChar) && (k <= start) + * (this.charAt(k) == searchChar) && (k <= start) * * is true. For other values of {@code searchChar}, it is the - * largest value k such that: + * largest value k such that: * - * (this.codePointAt(k) == searchChar) && (k <= start) + * (this.codePointAt(k) == searchChar) && (k <= start) * * is true. In either case, if no such character occurs in {@code cs} * at or before position {@code start}, then {@code -1} is returned. diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index 80aa2ef17..56c33607a 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -228,7 +228,7 @@ public class CharSet implements Serializable { * Compares two {@link CharSet} objects, returning true if they represent * exactly the same set of characters defined in the same way. * - * The two sets {@code abc} and {@code a-c} are not + * The two sets {@code abc} and {@code a-c} are not * equal according to this method. * * @param obj the object to compare to diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java index 1ceb8329e..e
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 32c93eb72 Javadoc new 69e3ba418 Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-lang.git 32c93eb72 is described below commit 32c93eb7283f3d1285b5a2fd74e94c03689b6ee8 Author: Gary Gregory AuthorDate: Sat Jul 20 09:04:09 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/time/DurationUtils.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/time/DurationUtils.java b/src/main/java/org/apache/commons/lang3/time/DurationUtils.java index a243f4153..9172c2c29 100644 --- a/src/main/java/org/apache/commons/lang3/time/DurationUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DurationUtils.java @@ -50,6 +50,7 @@ public class DurationUtils { * @param consumer Accepting function. * @param duration The duration to pick apart. * @throws T See the function signature. + * @see StopWatch */ @SuppressWarnings("boxing") // boxing unavoidable public static void accept(final FailableBiConsumer consumer, final Duration duration) @@ -119,6 +120,7 @@ public class DurationUtils { * @param consumer What to execute. * @return The Duration of execution. * @throws E thrown by the lambda. + * @see StopWatch * @since 3.13.0 */ public static Duration of(final FailableConsumer consumer) throws E { @@ -132,6 +134,7 @@ public class DurationUtils { * @param runnable What to execute. * @return The Duration of execution. * @throws E thrown by the lambda. + * @see StopWatch * @since 3.13.0 */ public static Duration of(final FailableRunnable runnable) throws E {
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new cb078c556 Javadoc cb078c556 is described below commit cb078c556ff430fae60ecd509a6498a2cc189cd6 Author: Gary Gregory AuthorDate: Thu Jul 11 14:04:48 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java b/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java index 06ab37ccf..4c9fd8a07 100644 --- a/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java +++ b/src/main/java/org/apache/commons/lang3/RuntimeEnvironment.java @@ -48,7 +48,6 @@ public class RuntimeEnvironment { * Tests whether we are running in a container like Docker or Podman. * * @return whether we are running in a container like Docker or Podman. - * @since 3.15.0. */ public static Boolean inContainer() { return inDocker() || inPodman();
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 5e07d873e Javadoc 5e07d873e is described below commit 5e07d873e6b45714d29bf47634adffa3b5aef098 Author: Gary Gregory AuthorDate: Tue Jun 18 09:21:03 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/SerializationUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java index 3185edfe4..bffc1c252 100644 --- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java +++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java @@ -46,7 +46,7 @@ import java.util.Objects; public class SerializationUtils { /** - * Custom specialization of the standard JDK {@link java.io.ObjectInputStream} + * Custom specialization of the standard JDK {@link ObjectInputStream} * that uses a custom {@link ClassLoader} to resolve a class. * If the specified {@link ClassLoader} is not able to resolve the class, * the context classloader of the current thread will be used.
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9babe58d8 Javadoc 9babe58d8 is described below commit 9babe58d895a0e4d6563268ca188794fbf066b38 Author: Gary Gregory AuthorDate: Sun May 26 13:39:18 2024 -0400 Javadoc --- .../java/org/apache/commons/lang3/CharUtils.java | 20 ++-- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharUtils.java b/src/main/java/org/apache/commons/lang3/CharUtils.java index c524f4cbc..2dbbae7ea 100644 --- a/src/main/java/org/apache/commons/lang3/CharUtils.java +++ b/src/main/java/org/apache/commons/lang3/CharUtils.java @@ -304,23 +304,15 @@ public class CharUtils { } /** - * Converts the character to a Character. + * Delegates to {@link Character#valueOf(char)}. * - * For ASCII 7 bit characters, this uses a cache that will return the - * same Character object each time. - * - * - * CharUtils.toCharacterObject(' ') = ' ' - * CharUtils.toCharacterObject('A') = 'A' - * - * - * @deprecated Java 5 introduced {@link Character#valueOf(char)} which caches chars 0 through 127. - * @param ch the character to convert - * @return a Character of the specified character + * @param c the character to convert + * @return a {@code Character} representing {@code c}. + * @deprecated Use {@link Character#valueOf(char)}. */ @Deprecated -public static Character toCharacterObject(final char ch) { -return Character.valueOf(ch); +public static Character toCharacterObject(final char c) { +return Character.valueOf(c); } /**
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 84abc1181 Javadoc 84abc1181 is described below commit 84abc1181c86d58e9e7cb3046271193311211dd3 Author: Gary Gregory AuthorDate: Thu May 23 09:31:51 2024 -0400 Javadoc --- .../apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 3ca7f5345..7769b38af 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializer.java @@ -25,7 +25,7 @@ import org.apache.commons.lang3.function.FailableConsumer; import org.apache.commons.lang3.function.FailableSupplier; /** - * Abstracts and defines operations for ConcurrentInitializer implementations. + * Abstracts and defines operations for {@link ConcurrentInitializer} implementations. * * @param the type of the object managed by this initializer class. * @param The exception type thrown by {@link #initialize()}.
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 30428e5f9 Javadoc 30428e5f9 is described below commit 30428e5f991f25c2b54db9cb887f179ab0a0eeaa Author: Gary Gregory AuthorDate: Thu May 23 09:14:30 2024 -0400 Javadoc --- .../commons/lang3/builder/CompareToBuilder.java| 42 +- .../apache/commons/lang3/builder/DiffBuilder.java | 48 +-- .../commons/lang3/builder/EqualsBuilder.java | 50 +-- .../commons/lang3/builder/HashCodeBuilder.java | 38 - .../lang3/builder/ReflectionDiffBuilder.java | 4 +- .../lang3/builder/ReflectionToStringBuilder.java | 2 +- .../commons/lang3/builder/ToStringBuilder.java | 98 +++--- .../concurrent/AbstractConcurrentInitializer.java | 4 +- .../lang3/concurrent/BackgroundInitializer.java| 2 +- .../org/apache/commons/lang3/text/StrBuilder.java | 4 +- .../apache/commons/lang3/util/FluentBitSet.java| 42 +- 11 files changed, 167 insertions(+), 167 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java index e8f7020e2..0782e04ad 100644 --- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java @@ -338,7 +338,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side value * @param rhs right-hand side value - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final boolean lhs, final boolean rhs) { if (comparison != 0) { @@ -368,7 +368,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side array * @param rhs right-hand side array - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final boolean[] lhs, final boolean[] rhs) { if (comparison != 0) { @@ -401,7 +401,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side value * @param rhs right-hand side value - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final byte lhs, final byte rhs) { if (comparison != 0) { @@ -424,7 +424,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side array * @param rhs right-hand side array - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final byte[] lhs, final byte[] rhs) { if (comparison != 0) { @@ -457,7 +457,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side value * @param rhs right-hand side value - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final char lhs, final char rhs) { if (comparison != 0) { @@ -480,7 +480,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side array * @param rhs right-hand side array - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final char[] lhs, final char[] rhs) { if (comparison != 0) { @@ -518,7 +518,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side value * @param rhs right-hand side value - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final double lhs, final double rhs) { if (comparison != 0) { @@ -541,7 +541,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side array * @param rhs right-hand side array - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final double[] lhs, final double[] rhs) { if (comparison != 0) { @@ -579,7 +579,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side value * @param rhs right-hand side value - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final float lhs, final float rhs) { if (comparison != 0) { @@ -602,7 +602,7 @@ public class CompareToBuilder implements Builder { * * @param lhs left-hand side array * @param rhs right-hand side array - * @return this + * @return {@code this} instance. */ public CompareToBuilder append(final float[] lhs, final float[] rhs) { if (comparison != 0) { @@ -635,7 +635,7 @@ public class CompareToBuilder implements Builder {
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 47f433f49 Javadoc 47f433f49 is described below commit 47f433f490bfd5da66f2717197995a7b16377625 Author: Gary Gregory AuthorDate: Sat May 18 09:53:44 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/CharSetUtils.java | 2 +- .../org/apache/commons/lang3/text/translate/CodePointTranslator.java | 2 +- .../commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSetUtils.java b/src/main/java/org/apache/commons/lang3/CharSetUtils.java index 376cdb916..fc5af2ab3 100644 --- a/src/main/java/org/apache/commons/lang3/CharSetUtils.java +++ b/src/main/java/org/apache/commons/lang3/CharSetUtils.java @@ -161,7 +161,7 @@ public class CharSetUtils { } /** - * Implementation of delete and keep + * Implements delete and keep. * * @param str String to modify characters within * @param set String[] set of characters to modify diff --git a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java index e315fad5b..ca8c743c2 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java @@ -32,7 +32,7 @@ import java.io.Writer; public abstract class CodePointTranslator extends CharSequenceTranslator { /** - * Implementation of translate that maps onto the abstract translate(int, Writer) method. + * Implements translate to map onto the abstract translate(int, Writer) method. * {@inheritDoc} */ @Override diff --git a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java index d054742f1..132e075d1 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java @@ -28,8 +28,9 @@ import java.io.Writer; */ @Deprecated public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator { + /** - * Implementation of translate that throws out unpaired surrogates. + * Implements translate that throws out unpaired surrogates. * {@inheritDoc} */ @Override
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new edc8dcfe8 Javadoc edc8dcfe8 is described below commit edc8dcfe85a83ea49d76e82190672e2896fb4f65 Author: Gary Gregory AuthorDate: Tue May 14 09:17:59 2024 -0400 Javadoc --- .../org/apache/commons/lang3/reflect/TypeUtilsTest.java | 13 +++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java b/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java index 9ec6c9a7c..38c7add81 100644 --- a/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java @@ -59,7 +59,7 @@ import org.junit.jupiter.api.Test; /** * Test fixture for https://issues.apache.org/jira/browse/LANG-1524 * - * @param Test fixture type. + * @param Test fixture type, unused type parameter for test. */ class Class { public static class Class { @@ -75,9 +75,18 @@ final class AAAClass extends AAClass { } } -@SuppressWarnings("unused") // Unused type parameter for test +/** + * Test fixture. + * + * @param Test fixture type, unused type parameter for test. + */ class AAClass { +/** + * Test fixture. + * + * @param Test fixture type, unused type parameter for test. + */ public class BBClass { // empty }
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 279d8f8d5 Javadoc 279d8f8d5 is described below commit 279d8f8d574a6c54c3ffb0a108fbdfc09030714e Author: Gary Gregory AuthorDate: Tue May 14 09:16:22 2024 -0400 Javadoc --- src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java b/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java index 50e629697..9ec6c9a7c 100644 --- a/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/reflect/TypeUtilsTest.java @@ -58,10 +58,13 @@ import org.junit.jupiter.api.Test; /** * Test fixture for https://issues.apache.org/jira/browse/LANG-1524 + * + * @param Test fixture type. */ class Class { public static class Class { public static class lass { +// empty } } }
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 2ecc5c048 Javadoc 2ecc5c048 is described below commit 2ecc5c048c6f17bd3e0ea29de51b93885cf76e13 Author: Gary Gregory AuthorDate: Thu May 2 15:42:20 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/JavaVersion.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java b/src/main/java/org/apache/commons/lang3/JavaVersion.java index 492919498..355b6ab6e 100644 --- a/src/main/java/org/apache/commons/lang3/JavaVersion.java +++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java @@ -330,7 +330,7 @@ public enum JavaVersion { } /** - * Whether this version of Java is at least the version of Java passed in. + * Tests whether this version of Java is at least the version of Java passed in. * * For example: * {@code myVersion.atLeast(JavaVersion.JAVA_1_4)} @@ -343,7 +343,7 @@ public enum JavaVersion { } /** - * Whether this version of Java is at most the version of Java passed in. + * Tests whether this version of Java is at most the version of Java passed in. * * For example: * {@code myVersion.atMost(JavaVersion.JAVA_1_4)}
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 7c99d624a Javadoc 7c99d624a is described below commit 7c99d624aa87ff8fa1424f41968cbb72bb6dfa0f Author: Gary Gregory AuthorDate: Thu Apr 25 08:40:06 2024 -0400 Javadoc --- .../commons/lang3/stream/LangCollectors.java | 23 +++--- 1 file changed, 11 insertions(+), 12 deletions(-) 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 0bcbfe22d..b52f8da84 100644 --- a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java +++ b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java @@ -162,28 +162,27 @@ public final class LangCollectors { } /** - * Returns a {@code Collector} that concatenates the input elements, separated by the specified delimiter, with the - * specified prefix and suffix, in encounter order. + * Returns a {@code Collector} that concatenates the input elements, separated by the specified delimiter, with the specified prefix and suffix, in + * encounter order. * - * This is a variation of {@link Collectors#joining(CharSequence, CharSequence, CharSequence)} that works with any - * element class, not just {@code CharSequence}. + * This is a variation of {@link Collectors#joining(CharSequence, CharSequence, CharSequence)} that works with any element class, not just + * {@code CharSequence}. * * * For example: * * - * + * {@code * Stream.of(Long.valueOf(1), null, Long.valueOf(3)) - * .collect(LangCollectors.joining("-", "[", "]", o -> Objects.toString(o, "NUL"))) + * .collect(LangCollectors.joining("-", "[", "]", o -> Objects.toString(o, "NUL"))) * returns "[1-NUL-3]" - * + * } * * @param delimiter the delimiter to be used between each element - * @param prefix the sequence of characters to be used at the beginning of the joined result - * @param suffix the sequence of characters to be used at the end of the joined result - * @param toString A function that takes an Object and returns a non-null String. - * @return A {@code Collector} which concatenates CharSequence elements, separated by the specified delimiter, in - * encounter order + * @param prefixthe sequence of characters to be used at the beginning of the joined result + * @param suffixthe sequence of characters to be used at the end of the joined result + * @param toString A function that takes an Object and returns a non-null String. + * @return A {@code Collector} which concatenates CharSequence elements, separated by the specified delimiter, in encounter order */ public static Collector joining(final CharSequence delimiter, final CharSequence prefix, final CharSequence suffix, final Function toString) {
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 0e1314c6b Javadoc 0e1314c6b is described below commit 0e1314c6b8849c094b13320a20d1658a5ddc2346 Author: Gary Gregory AuthorDate: Thu Apr 25 08:38:35 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/stream/LangCollectors.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 a5ba7fdbb..0bcbfe22d 100644 --- a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java +++ b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java @@ -174,7 +174,7 @@ public final class LangCollectors { * * * Stream.of(Long.valueOf(1), null, Long.valueOf(3)) - * .collect(LangCollectors.joining("-", "[", "]", o -> Objects.toString(o, "NUL"))) + * .collect(LangCollectors.joining("-", "[", "]", o -> Objects.toString(o, "NUL"))) * returns "[1-NUL-3]" * *
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 2dd72023e Javadoc 2dd72023e is described below commit 2dd72023e4f222dd58da8eb5b1de1f1550cbab3f Author: Gary Gregory AuthorDate: Thu Apr 25 08:05:25 2024 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/stream/LangCollectors.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 6abc27fdd..1363bda92 100644 --- a/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java +++ b/src/main/java/org/apache/commons/lang3/stream/LangCollectors.java @@ -31,7 +31,7 @@ import java.util.stream.Collectors; import org.apache.commons.lang3.StringUtils; /** - * Implementations of {@link Collector} that implement various useful reduction operations. + * Implementations of {@link Collector} that implement various reduction operations. * * This class is called {@code LangCollectors} instead of {@code Collectors} to avoid clashes with {@link Collectors}. *
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new b19c82a7c Javadoc b19c82a7c is described below commit b19c82a7ce42d1830321d5eafc3220fee8c2ca98 Author: Gary Gregory AuthorDate: Fri Apr 19 09:11:12 2024 -0400 Javadoc - No need to FQCN in link tag to the same package - Use longer lines --- .../org/apache/commons/lang3/ArrayUtilsTest.java | 2 +- .../org/apache/commons/lang3/CharRangeTest.java| 2 +- .../java/org/apache/commons/lang3/CharSetTest.java | 2 +- .../org/apache/commons/lang3/CharSetUtilsTest.java | 2 +- .../org/apache/commons/lang3/CharUtilsTest.java| 2 +- .../org/apache/commons/lang3/ClassUtilsTest.java | 2 +- .../org/apache/commons/lang3/JavaVersionTest.java | 2 +- .../commons/lang3/NotImplementedExceptionTest.java | 2 +- .../org/apache/commons/lang3/ObjectUtilsTest.java | 2 +- .../commons/lang3/RandomStringUtilsTest.java | 2 +- .../org/apache/commons/lang3/RegExUtilsTest.java | 2 +- .../commons/lang3/SerializationUtilsTest.java | 2 +- .../commons/lang3/StringUtilsContainsTest.java | 2 +- .../commons/lang3/StringUtilsEmptyBlankTest.java | 2 +- .../lang3/StringUtilsEqualsIndexOfTest.java| 2 +- .../apache/commons/lang3/StringUtilsIsTest.java| 2 +- .../lang3/StringUtilsStartsEndsWithTest.java | 2 +- .../commons/lang3/StringUtilsSubstringTest.java| 2 +- .../org/apache/commons/lang3/StringUtilsTest.java | 2 +- .../commons/lang3/StringUtilsTrimStripTest.java| 50 +- .../org/apache/commons/lang3/SystemUtilsTest.java | 2 +- .../org/apache/commons/lang3/ThreadUtilsTest.java | 2 +- 22 files changed, 42 insertions(+), 50 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java index bc0e2d7c7..cf3a2f176 100644 --- a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java @@ -40,7 +40,7 @@ import java.util.Random; import org.junit.jupiter.api.Test; /** - * Unit tests {@link org.apache.commons.lang3.ArrayUtils}. + * Unit tests {@link ArrayUtils}. */ @SuppressWarnings("deprecation") // deliberate use of deprecated code public class ArrayUtilsTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/CharRangeTest.java b/src/test/java/org/apache/commons/lang3/CharRangeTest.java index da207d83f..1d19d40b0 100644 --- a/src/test/java/org/apache/commons/lang3/CharRangeTest.java +++ b/src/test/java/org/apache/commons/lang3/CharRangeTest.java @@ -32,7 +32,7 @@ import java.util.NoSuchElementException; import org.junit.jupiter.api.Test; /** - * Unit tests {@link org.apache.commons.lang3.CharRange}. + * Unit tests {@link CharRange}. */ public class CharRangeTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/CharSetTest.java b/src/test/java/org/apache/commons/lang3/CharSetTest.java index 47fbda025..a4337a8d9 100644 --- a/src/test/java/org/apache/commons/lang3/CharSetTest.java +++ b/src/test/java/org/apache/commons/lang3/CharSetTest.java @@ -30,7 +30,7 @@ import java.lang.reflect.Modifier; import org.junit.jupiter.api.Test; /** - * Unit tests {@link org.apache.commons.lang3.CharSet}. + * Unit tests {@link CharSet}. */ public class CharSetTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/CharSetUtilsTest.java b/src/test/java/org/apache/commons/lang3/CharSetUtilsTest.java index 169b8bc0c..6d801838d 100644 --- a/src/test/java/org/apache/commons/lang3/CharSetUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/CharSetUtilsTest.java @@ -28,7 +28,7 @@ import java.lang.reflect.Modifier; import org.junit.jupiter.api.Test; /** - * Unit tests {@link org.apache.commons.lang3.CharSetUtils}. + * Unit tests {@link CharSetUtils}. */ public class CharSetUtilsTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/CharUtilsTest.java b/src/test/java/org/apache/commons/lang3/CharUtilsTest.java index dea0d0042..b3d351444 100644 --- a/src/test/java/org/apache/commons/lang3/CharUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/CharUtilsTest.java @@ -31,7 +31,7 @@ import java.lang.reflect.Modifier; import org.junit.jupiter.api.Test; /** - * Unit tests {@link org.apache.commons.lang3.CharUtils}. + * Unit tests {@link CharUtils}. */ public class CharUtilsTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java b/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java index e1c5ac93f..1921d0b9f 100644 --- a/src/test/java/org/apache/commons/lang3/ClassUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/Clas
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 58d5af480 Javadoc 58d5af480 is described below commit 58d5af480897b869f195f723d83e5a9a432b36b4 Author: Gary Gregory AuthorDate: Tue Mar 5 14:34:26 2024 -0500 Javadoc --- src/main/java/org/apache/commons/lang3/BooleanUtils.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java index f2fb9cd48..13585b299 100644 --- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java +++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java @@ -136,6 +136,7 @@ public class BooleanUtils { /** * Returns a new array of possible values (like an enum would). + * * @return a new array of possible values (like an enum would). * @since 3.12.0 */
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 7bb195000 Javadoc 7bb195000 is described below commit 7bb195000acb96ae9e0dd3a9b6f86ff13711ec60 Author: Gary Gregory AuthorDate: Fri Feb 23 18:33:45 2024 -0500 Javadoc Since tag not needed --- src/main/java/org/apache/commons/lang3/ArrayUtils.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index b429af993..93c95b71b 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -5293,7 +5293,6 @@ public class ArrayUtils { * @param array source * @param indices to remove * @return new array of same type minus elements specified by unique values of {@code indices} - * @since 3.0.1 */ // package protected for access by unit tests static Object removeAll(final Object array, final int... indices) {
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new d1ab96398 Javadoc d1ab96398 is described below commit d1ab9639845e1304575c4dea4d6f93ce9fdeed47 Author: Gary Gregory AuthorDate: Thu Jan 25 15:36:06 2024 -0500 Javadoc --- .../java/org/apache/commons/lang3/StringUtils.java | 234 ++--- 1 file changed, 117 insertions(+), 117 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java index 886eb97f8..a804076c3 100644 --- a/src/main/java/org/apache/commons/lang3/StringUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringUtils.java @@ -389,11 +389,11 @@ public class StringUtils { * * * - * StringUtils.abbreviateMiddle(null, null, 0) = null - * StringUtils.abbreviateMiddle("abc", null, 0) = "abc" - * StringUtils.abbreviateMiddle("abc", ".", 0) = "abc" - * StringUtils.abbreviateMiddle("abc", ".", 3) = "abc" - * StringUtils.abbreviateMiddle("abcdef", ".", 4) = "ab.f" + * StringUtils.abbreviateMiddle(null, null, 0)= null + * StringUtils.abbreviateMiddle("abc", null, 0) = "abc" + * StringUtils.abbreviateMiddle("abc", ".", 0)= "abc" + * StringUtils.abbreviateMiddle("abc", ".", 3)= "abc" + * StringUtils.abbreviateMiddle("abcdef", ".", 4) = "ab.f" * * * @param str the String to abbreviate, may be null @@ -446,21 +446,21 @@ public class StringUtils { * already end with any of the suffixes. * * - * StringUtils.appendIfMissing(null, null) = null - * StringUtils.appendIfMissing("abc", null) = "abc" - * StringUtils.appendIfMissing("", "xyz") = "xyz" - * StringUtils.appendIfMissing("abc", "xyz") = "abcxyz" + * StringUtils.appendIfMissing(null, null) = null + * StringUtils.appendIfMissing("abc", null) = "abc" + * StringUtils.appendIfMissing("", "xyz"= "xyz" + * StringUtils.appendIfMissing("abc", "xyz")= "abcxyz" * StringUtils.appendIfMissing("abcxyz", "xyz") = "abcxyz" * StringUtils.appendIfMissing("abcXYZ", "xyz") = "abcXYZxyz" * * With additional suffixes, * - * StringUtils.appendIfMissing(null, null, null) = null - * StringUtils.appendIfMissing("abc", null, null) = "abc" - * StringUtils.appendIfMissing("", "xyz", null) = "xyz" + * StringUtils.appendIfMissing(null, null, null) = null + * StringUtils.appendIfMissing("abc", null, null) = "abc" + * StringUtils.appendIfMissing("", "xyz", null)= "xyz" * StringUtils.appendIfMissing("abc", "xyz", new CharSequence[]{null}) = "abcxyz" - * StringUtils.appendIfMissing("abc", "xyz", "") = "abc" - * StringUtils.appendIfMissing("abc", "xyz", "mno") = "abcxyz" + * StringUtils.appendIfMissing("abc", "xyz", "") = "abc" + * StringUtils.appendIfMissing("abc", "xyz", "mno")= "abcxyz" * StringUtils.appendIfMissing("abcxyz", "xyz", "mno") = "abcxyz" * StringUtils.appendIfMissing("abcmno", "xyz", "mno") = "abcmno" * StringUtils.appendIfMissing("abcXYZ", "xyz", "mno") = "abcXYZxyz" @@ -484,21 +484,21 @@ public class StringUtils { * already end, case-insensitive, with any of the suffixes. * * - * StringUtils.appendIfMissingIgnoreCase(null, null) = null - * StringUtils.appendIfMissingIgnoreCase("abc", null) = "abc" - * StringUtils.appendIfMissingIgnoreCase("", "xyz") = "xyz" - * StringUtils.appendIfMissingIgnoreCase("abc", "xyz") = "abcxyz" + * StringUtils.appendIfMissingIgnoreCase(null, null) = null + * StringUtils.appendIfMissingIgnoreCase("abc", null) = "abc" + * StringUtils.appendIfMissingIgnoreCase("", "xyz") = "xyz" + * StringUtils.appendIfMissingIgnoreCase("abc", "xyz")= "abcxyz" * StringUtils.appendIfMissingIgnoreCase("abcxyz", "xyz") = "abcxyz" * StringUtils.appendIfMissingIgnoreCase("abcXYZ", "xyz") = "abcXYZ" * * With additional suffixes, * - * StringUtils.appendIfMissingIgnoreCase(null, null, null) = null - * StringUtils.appendIfMissingIgnoreCase("abc", null, null) = "abc" - * StringUtils.appendIfMissingIgnoreCase("", "xyz", null) = "xyz" + * StringUtils.appendIfMissingIgnoreCase(null, null, null) = null + * StringUtils.appendIfMissingIgnoreCase("abc", null, null) = "abc" + * StringUtils.appendIfMissingIgnoreCase("", "xyz", null)= "xyz" * StringUtils.appendIfMissingIgnoreCase("abc", "xyz", new CharSequence[]{null}) = "abcxyz" - * StringUtils.appendIfMissingIgnoreCase("abc", "xyz", "") = "abc" - * StringUtils.appendIfMissingIgnoreCase("abc", "xyz", "mno") = "abcxyz" + * StringUtils.appendIfMissingIgn
(commons-lang) branch master updated: Javadoc: Use an HTTPS URL to the Apache web site
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new a02e260a0 Javadoc: Use an HTTPS URL to the Apache web site a02e260a0 is described below commit a02e260a0a85f5c05cd821f2200ba8859578e442 Author: Gary Gregory AuthorDate: Sun Jan 14 10:35:55 2024 -0500 Javadoc: Use an HTTPS URL to the Apache web site --- src/main/java/org/apache/commons/lang3/text/WordUtils.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/text/WordUtils.java b/src/main/java/org/apache/commons/lang3/text/WordUtils.java index 5dc5ea258..0115150dd 100644 --- a/src/main/java/org/apache/commons/lang3/text/WordUtils.java +++ b/src/main/java/org/apache/commons/lang3/text/WordUtils.java @@ -523,7 +523,7 @@ public class WordUtils { * 20 * "\n" * true - * "Click here to jump\nto the commons\nwebsite -\nhttp://commons.apach\ne.org"; + * "Click here to jump\nto the commons\nwebsite -\nhttps://commons.apach\ne.org"; * * * @@ -608,7 +608,7 @@ public class WordUtils { * "\n" * true * " " - * "Click here to jump\nto the commons\nwebsite -\nhttp://commons.apach\ne.org"; + * "Click here to jump\nto the commons\nwebsite -\nhttps://commons.apach\ne.org"; * * * "flammable/inflammable"
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 02eac5e1a Javadoc 02eac5e1a is described below commit 02eac5e1a5ea9229111ec37b62ba98437fe3bf8f Author: Gary Gregory AuthorDate: Sat Jan 6 11:11:03 2024 -0500 Javadoc --- .../commons/lang3/exception/ExceptionUtils.java| 34 +++--- 1 file changed, 23 insertions(+), 11 deletions(-) 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 9ea769a62..cd355afca 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -72,21 +72,26 @@ public class ExceptionUtils { static final String WRAPPED_MARKER = " [wrapped] "; /** - * Use to throws a checked exception without adding the exception to the throws + * Throws the given (usually checked) exception without adding the exception to the throws * clause of the calling method. This method prevents throws clause - * pollution and reduces the clutter of "Caused by" exceptions in the + * inflation and reduces the clutter of "Caused by" exceptions in the * stack trace. * - * The use of this technique may be controversial, but exceedingly useful to - * library developers. + * The use of this technique may be controversial, but useful. * * - * public int propagateExample { // note that there is no throws clause + * // There is no throws clause in the method signature. + * public int propagateExample { * try { - * return invocation(); // throws IOException + * // Throws IOException + * invocation(); * } catch (Exception e) { - * return ExceptionUtils.rethrowRuntimeException(e); // propagates a checked exception + * // Propagates a checked exception. + * throw ExceptionUtils.asRuntimeException(e); * } + * // more processing + * ... + * return value; * } * * @@ -94,16 +99,23 @@ public class ExceptionUtils { * checked exception in a RuntimeException: * * - * public int wrapExample { // note that there is no throws clause + * // There is no throws clause in the method signature. + * public int wrapExample() { * try { - * return invocation(); // throws IOException + * // throws IOException. + * invocation(); * } catch (Error e) { * throw e; * } catch (RuntimeException e) { - * throw e; // wraps a checked exception + * // Throws an unchecked exception. + * throw e; * } catch (Exception e) { - * throw new UndeclaredThrowableException(e); // wraps a checked exception + * // Wraps a checked exception. + * throw new UndeclaredThrowableException(e); * } + * // more processing + * ... + * return value; * } * *
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new f0c63993b Javadoc f0c63993b is described below commit f0c63993bbe652614e8d05d0980d1f507cee0378 Author: Gary Gregory AuthorDate: Sat Jan 6 11:02:42 2024 -0500 Javadoc --- .../commons/lang3/exception/ExceptionUtils.java| 34 +- 1 file changed, 20 insertions(+), 14 deletions(-) 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 1b251218a..9ea769a62 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -814,20 +814,22 @@ public class ExceptionUtils { } /** - * Use to throw a checked exception without adding the exception to the throws + * Throws the given (usually checked) exception without adding the exception to the throws * clause of the calling method. This method prevents throws clause - * pollution and reduces the clutter of "Caused by" exceptions in the + * inflation and reduces the clutter of "Caused by" exceptions in the * stack trace. * - * The use of this technique may be controversial, but exceedingly useful to - * library developers. + * The use of this technique may be controversial, but useful. * * - * public int propagateExample { // note that there is no throws clause + * // There is no throws clause in the method signature. + * public int propagateExample() { * try { - * return invocation(); // throws IOException - * } catch (Exception e) { - * return ExceptionUtils.rethrow(e); // propagates a checked exception + * // throws SomeCheckedException. + * return invocation(); + * } catch (SomeCheckedException e) { + * // Propagates a checked exception and compiles to return an int. + * return ExceptionUtils.rethrow(e); * } * } * @@ -836,15 +838,19 @@ public class ExceptionUtils { * checked exception in a RuntimeException: * * - * public int wrapExample { // note that there is no throws clause + * // There is no throws clause in the method signature. + * public int wrapExample() { * try { - * return invocation(); // throws IOException + * // throws IOException. + * return invocation(); * } catch (Error e) { * throw e; * } catch (RuntimeException e) { - * throw e; // wraps a checked exception + * // Throws an unchecked exception. + * throw e; * } catch (Exception e) { - * throw new UndeclaredThrowableException(e); // wraps a checked exception + * // wraps a checked exception. + * throw new UndeclaredThrowableException(e); * } * } * @@ -863,8 +869,8 @@ public class ExceptionUtils { * * @param throwable *The throwable to rethrow. - * @param The type of the returned value. - * @return Never actually returned, this generic type matches any type + * @param The type of the return value. + * @return Never actually returns, this generic type matches any type * which the calling site requires. "Returning" the results of this * method, as done in the propagateExample above, will satisfy the * Java compiler requirement that all code paths return a value.
(commons-lang) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new d788e7d38 Javadoc spelling d788e7d38 is described below commit d788e7d389f8b40b565c5c1f83579e8178265bb3 Author: Gary Gregory AuthorDate: Fri Dec 29 15:44:32 2023 -0500 Javadoc spelling --- .../java/org/apache/commons/lang3/SystemUtils.java | 38 +++--- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java index 2c52cff7a..1a98e7238 100644 --- a/src/main/java/org/apache/commons/lang3/SystemUtils.java +++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java @@ -1216,7 +1216,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX = getOsMatchesName("Mac OS X"); /** - * Is {@code true} if this is Mac OS X Cheetah. + * Is {@code true} if this is macOS X Cheetah. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1230,7 +1230,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_CHEETAH = getOsMatches("Mac OS X", "10.0"); /** - * Is {@code true} if this is Mac OS X Puma. + * Is {@code true} if this is macOS X Puma. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1244,7 +1244,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_PUMA = getOsMatches("Mac OS X", "10.1"); /** - * Is {@code true} if this is Mac OS X Jaguar. + * Is {@code true} if this is macOS X Jaguar. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1258,7 +1258,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_JAGUAR = getOsMatches("Mac OS X", "10.2"); /** - * Is {@code true} if this is Mac OS X Panther. + * Is {@code true} if this is macOS X Panther. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1272,7 +1272,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_PANTHER = getOsMatches("Mac OS X", "10.3"); /** - * Is {@code true} if this is Mac OS X Tiger. + * Is {@code true} if this is macOS X Tiger. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1286,7 +1286,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_TIGER = getOsMatches("Mac OS X", "10.4"); /** - * Is {@code true} if this is Mac OS X Leopard. + * Is {@code true} if this is macOS X Leopard. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1300,7 +1300,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_LEOPARD = getOsMatches("Mac OS X", "10.5"); /** - * Is {@code true} if this is Mac OS X Snow Leopard. + * Is {@code true} if this is macOS X Snow Leopard. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1314,7 +1314,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_SNOW_LEOPARD = getOsMatches("Mac OS X", "10.6"); /** - * Is {@code true} if this is Mac OS X Lion. + * Is {@code true} if this is macOS X Lion. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1328,7 +1328,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_LION = getOsMatches("Mac OS X", "10.7"); /** - * Is {@code true} if this is Mac OS X Mountain Lion. + * Is {@code true} if this is macOS X Mountain Lion. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1342,7 +1342,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_MOUNTAIN_LION = getOsMatches("Mac OS X", "10.8"); /** - * Is {@code true} if this is Mac OS X Mavericks. + * Is {@code true} if this is macOS X Mavericks. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1356,7 +1356,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_MAVERICKS = getOsMatches("Mac OS X", "10.9"); /** - * Is {@code true} if this is Mac OS X Yosemite. + * Is {@code true} if this is macOS X Yosemite. * * * The field will return {@code false} if {@code OS_NAME} is {@code null}. @@ -1370,7 +1370,7 @@ public class SystemUtils { public static final boolean IS_OS_MAC_OSX_YOSEMITE = getOsMatches("Mac OS X", "10.10"); /** - * Is {@code true} if this is Mac OS X El Capitan. + * Is {@code tru
(commons-lang) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new a71a79e54 Javadoc spelling a71a79e54 is described below commit a71a79e54cfc7ad6beb0f107c54aebbb52c473b3 Author: Gary Gregory AuthorDate: Thu Dec 21 17:09:50 2023 -0500 Javadoc spelling --- src/main/java/org/apache/commons/lang3/Conversion.java | 8 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Conversion.java b/src/main/java/org/apache/commons/lang3/Conversion.java index c9723dbd3..6d261f97f 100644 --- a/src/main/java/org/apache/commons/lang3/Conversion.java +++ b/src/main/java/org/apache/commons/lang3/Conversion.java @@ -39,11 +39,11 @@ import java.util.UUID; * * * Endianness field: little-endian is the default, in this case the field is absent. In case of - * big endian, the field is "Be". Bit ordering: Lsb0 is the default, in this case the field + * big-endian, the field is "Be". Bit ordering: Lsb0 is the default, in this case the field * is absent. In case of Msb0, the field is "Msb0". * * - * Example: intBeMsb0ToHex convert an int with big endian byte order and Msb0 bit order into its + * Example: intBeMsb0ToHex convert an int with big-endian byte order and Msb0 bit order into its * hexadecimal string representation * * @@ -79,7 +79,7 @@ public class Conversion { private static final boolean[] = {false, false, false, false}; /** - * Converts the first 4 bits of a binary (represented as boolean array) in big endian Msb0 + * Converts the first 4 bits of a binary (represented as boolean array) in big-endian Msb0 * bit ordering to a hexadecimal digit. * * @@ -97,7 +97,7 @@ public class Conversion { } /** - * Converts a binary (represented as boolean array) in big endian Msb0 bit ordering to a + * Converts a binary (represented as boolean array) in big-endian Msb0 bit ordering to a * hexadecimal digit. * *
(commons-lang) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 7b547fb4e Javadoc spelling 7b547fb4e is described below commit 7b547fb4e4c9cefb89f052d9cc4a5cdc349c47d0 Author: Gary Gregory AuthorDate: Thu Dec 21 17:08:02 2023 -0500 Javadoc spelling --- .../java/org/apache/commons/lang3/Conversion.java | 56 +++--- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Conversion.java b/src/main/java/org/apache/commons/lang3/Conversion.java index 7da2975f5..c9723dbd3 100644 --- a/src/main/java/org/apache/commons/lang3/Conversion.java +++ b/src/main/java/org/apache/commons/lang3/Conversion.java @@ -38,7 +38,7 @@ import java.util.UUID; * uuid * * - * Endianness field: little endian is the default, in this case the field is absent. In case of + * Endianness field: little-endian is the default, in this case the field is absent. In case of * big endian, the field is "Be". Bit ordering: Lsb0 is the default, in this case the field * is absent. In case of Msb0, the field is "Msb0". * @@ -52,7 +52,7 @@ import java.util.UUID; * you should not need to use "Be" and "Msb0" methods. * * - * Development status: work on going, only a part of the little endian, Lsb0 methods implemented + * Development status: work on going, only a part of the little-endian, Lsb0 methods implemented * so far. * * @@ -404,7 +404,7 @@ public class Conversion { } /** - * Converts an array of byte into an int using the default (little endian, Lsb0) byte and bit + * Converts an array of byte into an int using the default (little-endian, Lsb0) byte and bit * ordering. * * @param src the byte array to convert @@ -437,7 +437,7 @@ public class Conversion { } /** - * Converts an array of byte into a long using the default (little endian, Lsb0) byte and + * Converts an array of byte into a long using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the byte array to convert @@ -470,7 +470,7 @@ public class Conversion { } /** - * Converts an array of byte into a short using the default (little endian, Lsb0) byte and + * Converts an array of byte into a short using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the byte array to convert @@ -503,7 +503,7 @@ public class Conversion { } /** - * Converts bytes from an array into a UUID using the default (little endian, Lsb0) byte and + * Converts bytes from an array into a UUID using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the byte array to convert @@ -521,7 +521,7 @@ public class Conversion { } /** - * Converts a byte into an array of boolean using the default (little endian, Lsb0) byte and + * Converts a byte into an array of boolean using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the byte to convert @@ -551,7 +551,7 @@ public class Conversion { } /** - * Converts a byte into an array of Char using the default (little endian, Lsb0) byte and + * Converts a byte into an array of Char using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the byte to convert @@ -777,7 +777,7 @@ public class Conversion { } /** - * Converts an array of Char into a byte using the default (little endian, Lsb0) byte and + * Converts an array of Char into a byte using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the hexadecimal string to convert @@ -808,7 +808,7 @@ public class Conversion { } /** - * Converts an array of Char into an int using the default (little endian, Lsb0) byte and bit + * Converts an array of Char into an int using the default (little-endian, Lsb0) byte and bit * ordering. * * @param src the hexadecimal string to convert @@ -838,7 +838,7 @@ public class Conversion { } /** - * Converts an array of Char into a long using the default (little endian, Lsb0) byte and + * Converts an array of Char into a long using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the hexadecimal string to convert @@ -869,7 +869,7 @@ public class Conversion { } /** - * Converts an array of Char into a short using the default (little endian, Lsb0) byte and + * Converts an array of Char into a short using the default (little-endian, Lsb0) byte and * bit ordering. * * @param src the hexadecimal string to convert @@ -900,7 +900,7 @@ public class Conversio
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new e5e54fa00 Javadoc e5e54fa00 is described below commit e5e54fa003d0ee45384a6191b7f9cdf5bab6debb Author: Gary Gregory AuthorDate: Sun Dec 17 14:38:39 2023 -0500 Javadoc --- .../java/org/apache/commons/lang3/builder/HashCodeBuilder.java| 2 +- .../commons/lang3/concurrent/CallableBackgroundInitializer.java | 2 +- .../java/org/apache/commons/lang3/concurrent/TimedSemaphore.java | 2 +- src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java | 4 ++-- src/main/java/org/apache/commons/lang3/stream/Streams.java| 2 +- src/main/java/org/apache/commons/lang3/stream/package-info.java | 2 +- .../java/org/apache/commons/lang3/text/ExtendedMessageFormat.java | 8 src/main/java/org/apache/commons/lang3/text/FormatFactory.java| 2 +- src/main/java/org/apache/commons/lang3/time/DateParser.java | 4 ++-- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java index a881f232e..3b17f5cec 100644 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java @@ -543,7 +543,7 @@ public class HashCodeBuilder implements Builder { * This adds {@code 1} when true, and {@code 0} when false to the {@code hashCode}. * * - * This is in contrast to the standard {@code java.lang.Boolean.hashCode} handling, which computes + * This is in contrast to the standard {@link Boolean#hashCode()} handling, which computes * a {@code hashCode} value of {@code 1231} for {@link Boolean} instances * that represent {@code true} or {@code 1237} for {@link Boolean} instances * that represent {@code false}. 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 13a08787f..b06789664 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java @@ -31,7 +31,7 @@ import java.util.concurrent.ExecutorService; * {@link Callable} is executed in the background thread. * * - * The {@code java.util.concurrent.Callable} interface is a standard mechanism + * The {@link java.util.concurrent.Callable} interface is a standard mechanism * of the JDK to define tasks to be executed by another thread. The {@code * CallableBackgroundInitializer} class allows combining this standard interface * with the background initializer API. 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 21e467486..540c33c45 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java @@ -28,7 +28,7 @@ import org.apache.commons.lang3.Validate; * permits in a given time frame. * * - * This class is similar to the {@code java.util.concurrent.Semaphore} class + * This class is similar to the {@link java.util.concurrent.Semaphore} class * provided by the JDK in that it manages a configurable number of permits. * Using the {@link #acquire()} method a permit can be requested by a thread. * However, there is an additional timing dimension: there is no {@code diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java index fc00dce57..6513918a7 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java +++ b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java @@ -41,7 +41,7 @@ import org.apache.commons.lang3.Validate; * * ListlistOfString = typesafe.obtain(List.class, ...); // could only give us a raw List * - * {@code java.lang.reflect.Type} might provide some value: + * {@link java.lang.reflect.Type} might provide some value: * * Type listOfStringType = ...; // firstly, how to obtain this? Doable, but not straightforward. * List listOfString = (List ) typesafe.obtain(listOfStringType, ...); // nongeneric Type would necessitate a cast @@ -57,7 +57,7 @@ import org.apache.commons.lang3.Validate; * List listOfString = typesafe.obtain(new TypeLiteral >() {}, ...); * * - * This has the effect of "jumping up" a level to tie a {@code java.lang.reflect.Type} + * This has the effect of "jumping up" a level to tie a {@link java.lang.reflect.Type}
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 5fce2eb84 Javadoc 5fce2eb84 is described below commit 5fce2eb84e6da7db9be5a9f64c6cc726d8fc2e8f Author: Gary Gregory AuthorDate: Thu Dec 14 13:58:16 2023 -0500 Javadoc --- src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java | 2 +- .../java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java index 83ac93245..cb9700754 100644 --- a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java @@ -789,7 +789,7 @@ public class DateUtilsTest extends AbstractLangTest { assertThrows(ClassCastException.class, () -> DateUtils.iterator("", DateUtils.RANGE_WEEK_CENTER)); } -/** https://issues.apache.org/jira/browse/LANG-530 */ +/** See https://issues.apache.org/jira/browse/LANG-530 */ @SuppressWarnings("deprecation") @Test public void testLang530() throws ParseException { diff --git a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java index 312812394..3f51aa1e1 100644 --- a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java @@ -126,7 +126,7 @@ public class DurationFormatUtilsTest extends AbstractLangTest { } -/** https://issues.apache.org/bugzilla/show_bug.cgi?id=38401 */ +/** See https://issues.apache.org/bugzilla/show_bug.cgi?id=38401 */ @Test public void testBugzilla38401() { assertEqualDuration("/00/30 16:00:00 000", new int[] { 2006, 0, 26, 18, 47, 34 },
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 3f6d449f5 Javadoc 3f6d449f5 is described below commit 3f6d449f511cd665f1dde56b68b7844528ae9f6a Author: Gary Gregory AuthorDate: Thu Dec 14 09:49:01 2023 -0500 Javadoc --- src/main/java/org/apache/commons/lang3/JavaVersion.java | 2 +- .../org/apache/commons/lang3/SerializationUtils.java | 2 +- src/main/java/org/apache/commons/lang3/Validate.java | 2 +- .../lang3/builder/MultilineRecursiveToStringStyle.java | 2 +- .../commons/lang3/builder/RecursiveToStringStyle.java| 2 +- .../commons/lang3/builder/StandardToStringStyle.java | 2 +- .../org/apache/commons/lang3/builder/ToStringStyle.java | 16 .../java/org/apache/commons/lang3/text/StrLookup.java| 2 +- .../java/org/apache/commons/lang3/text/StrMatcher.java | 2 +- .../java/org/apache/commons/lang3/time/StopWatch.java| 2 +- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java b/src/main/java/org/apache/commons/lang3/JavaVersion.java index fdd0eb119..4c7831fc6 100644 --- a/src/main/java/org/apache/commons/lang3/JavaVersion.java +++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java @@ -302,7 +302,7 @@ public enum JavaVersion { private final String name; /** - * Constructor. + * Constructs a new instance. * * @param value the float value * @param name the standard name, not null diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java index acad6f0a1..5afbb1091 100644 --- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java +++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java @@ -80,7 +80,7 @@ public class SerializationUtils { private final ClassLoader classLoader; /** - * Constructor. + * Constructs a new instance. * @param in The {@link InputStream}. * @param classLoader classloader to use * @throws IOException if an I/O error occurs while reading stream header. diff --git a/src/main/java/org/apache/commons/lang3/Validate.java b/src/main/java/org/apache/commons/lang3/Validate.java index 5950bd003..dd54c70e0 100644 --- a/src/main/java/org/apache/commons/lang3/Validate.java +++ b/src/main/java/org/apache/commons/lang3/Validate.java @@ -1248,7 +1248,7 @@ public class Validate { } /** - * Constructor. This class should not normally be instantiated. + * Constructs a new instance. This class should not normally be instantiated. */ public Validate() { } diff --git a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java index 285d3b791..3dacaea5d 100644 --- a/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/MultilineRecursiveToStringStyle.java @@ -76,7 +76,7 @@ public class MultilineRecursiveToStringStyle extends RecursiveToStringStyle { private int spaces = 2; /** - * Constructor. + * Constructs a new instance. */ public MultilineRecursiveToStringStyle() { resetIndent(); diff --git a/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java b/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java index f773848fc..5f2a73190 100644 --- a/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/RecursiveToStringStyle.java @@ -60,7 +60,7 @@ public class RecursiveToStringStyle extends ToStringStyle { private static final long serialVersionUID = 1L; /** - * Constructor. + * Constructs a new instance. */ public RecursiveToStringStyle() { } 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 de8fc28aa..758538303 100644 --- a/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/StandardToStringStyle.java @@ -41,7 +41,7 @@ public class StandardToStringStyle extends ToStringStyle { private static final long serialVersionUID = 1L; /** - * Constructor. + * Constructs a new instance. */ public StandardToStringStyle() { } 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 d395567c7..7c956c6cf 100644 --- a/src/main/
(commons-lang) branch master updated: Javadoc: Clarify adAll() methods
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 59f464d53 Javadoc: Clarify adAll() methods 59f464d53 is described below commit 59f464d533e39a7a93dcf4a6b18b73e46f40b884 Author: Gary Gregory AuthorDate: Sat Dec 9 11:47:08 2023 -0500 Javadoc: Clarify adAll() methods --- .../java/org/apache/commons/lang3/ArrayUtils.java | 25 +++--- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index 99dfb0498..c318a8a6b 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -835,11 +835,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new boolean[] array. + * @return The new boolean[] array or {@code null}. * @since 2.1 */ public static boolean[] addAll(final boolean[] array1, final boolean... array2) { @@ -866,11 +867,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new byte[] array. + * @return The new byte[] array or {@code null}. * @since 2.1 */ public static byte[] addAll(final byte[] array1, final byte... array2) { @@ -897,11 +899,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new char[] array. + * @return The new char[] array or {@code null}. * @since 2.1 */ public static char[] addAll(final char[] array1, final char... array2) { @@ -928,11 +931,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new double[] array. + * @return The new double[] array or {@code null}. * @since 2.1 */ public static double[] addAll(final double[] array1, final double... array2) { @@ -959,11 +963,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new float[] array. + * @return The new float[] array or {@code null}. * @since 2.1 */ public static float[] addAll(final float[] array1, final float... array2) { @@ -990,11 +995,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * ArrayUtils.addAll(null, array2) = cloned copy of array2 * ArrayUtils.addAll([], []) = [] + * ArrayUtils.addAll(null, null) = null * * * @param array1 the first array whose elements are added to the new array. * @param array2 the second array whose elements are added to the new array. - * @return The new int[] array. + * @return The new int[] array or {@code null}. * @since 2.1 */ public static int[] addAll(final int[] array1, final int... array2) { @@ -1021,11 +1027,12 @@ public class ArrayUtils { * ArrayUtils.addAll(array1, null) = cloned copy of array1 * A
(commons-lang) branch master updated: Javadoc: Clarify clone() methods
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 96438a1f5 Javadoc: Clarify clone() methods 96438a1f5 is described below commit 96438a1f56341e3bbcf30b83c666a7fb56f854d4 Author: Gary Gregory AuthorDate: Sat Dec 9 11:43:15 2023 -0500 Javadoc: Clarify clone() methods --- .../java/org/apache/commons/lang3/ArrayUtils.java | 50 +- 1 file changed, 20 insertions(+), 30 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index b7abff0ca..99dfb0498 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -1366,13 +1366,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static boolean[] clone(final boolean[] array) { @@ -1380,13 +1379,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static byte[] clone(final byte[] array) { @@ -1394,13 +1392,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static char[] clone(final char[] array) { @@ -1408,13 +1405,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static double[] clone(final double[] array) { @@ -1422,13 +1418,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static float[] clone(final float[] array) { @@ -1436,13 +1431,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static int[] clone(final int[] array) { @@ -1450,13 +1444,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or returns {@code null}. * * This method returns {@code null} for a {@code null} input array. * * - * @param array the array to clone, may be {@code null} + * @param array the array to clone, may be {@code null} * @return the cloned array, {@code null} if {@code null} input */ public static long[] clone(final long[] array) { @@ -1464,13 +1457,12 @@ public class ArrayUtils { } /** - * Clones an array returning a typecast result and handling - * {@code null}. + * Clones an array or r
(commons-lang) branch master updated: Javadoc: Remove redundant "java.lang" prefix
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 4c2224dd1 Javadoc: Remove redundant "java.lang" prefix 4c2224dd1 is described below commit 4c2224dd1b750efc8e890d7f6e4c8a237d570309 Author: Gary Gregory AuthorDate: Sat Dec 9 09:58:45 2023 -0500 Javadoc: Remove redundant "java.lang" prefix --- src/main/java/org/apache/commons/lang3/StringUtils.java | 2 +- src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java | 2 +- src/main/java/org/apache/commons/lang3/builder/package-info.java | 2 +- src/main/java/org/apache/commons/lang3/compare/package-info.java | 2 +- src/main/java/org/apache/commons/lang3/function/package-info.java| 2 +- src/main/java/org/apache/commons/lang3/math/package-info.java| 2 +- src/main/java/org/apache/commons/lang3/package-info.java | 4 ++-- src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java| 2 +- src/main/java/org/apache/commons/lang3/text/package-info.java| 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java index 6bd6bfa35..19f13c597 100644 --- a/src/main/java/org/apache/commons/lang3/StringUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringUtils.java @@ -36,7 +36,7 @@ import org.apache.commons.lang3.stream.LangCollectors; import org.apache.commons.lang3.stream.Streams; /** - * Operations on {@link java.lang.String} that are + * Operations on {@link String} that are * {@code null} safe. * * diff --git a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java index 3d411bb15..2c241c5e1 100644 --- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java @@ -27,7 +27,7 @@ import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.ObjectUtils; /** - * Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods. + * Assists in implementing {@link Comparable#compareTo(Object)} methods. * * It is consistent with {@code equals(Object)} and * {@code hashCode()} built with {@link EqualsBuilder} and diff --git a/src/main/java/org/apache/commons/lang3/builder/package-info.java b/src/main/java/org/apache/commons/lang3/builder/package-info.java index b8163b59b..910d72266 100644 --- a/src/main/java/org/apache/commons/lang3/builder/package-info.java +++ b/src/main/java/org/apache/commons/lang3/builder/package-info.java @@ -18,7 +18,7 @@ * Assists in creating consistent {@code equals(Object)}, {@code toString()}, {@code hashCode()}, and {@code compareTo(Object)} methods. * These classes are not thread-safe. * - * When you write a {@link java.lang.Object#hashCode() hashCode()}, do you check Bloch's Effective Java? No? + * When you write a {@link Object#hashCode() hashCode()}, do you check Bloch's Effective Java? No? * You just hack in a quick number? * Well {@link org.apache.commons.lang3.builder.HashCodeBuilder} will save your day. * It, and its buddies ({@link org.apache.commons.lang3.builder.EqualsBuilder}, {@link org.apache.commons.lang3.builder.CompareToBuilder}, {@link org.apache.commons.lang3.builder.ToStringBuilder}), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hash code. diff --git a/src/main/java/org/apache/commons/lang3/compare/package-info.java b/src/main/java/org/apache/commons/lang3/compare/package-info.java index 99136ede8..9eabaa348 100644 --- a/src/main/java/org/apache/commons/lang3/compare/package-info.java +++ b/src/main/java/org/apache/commons/lang3/compare/package-info.java @@ -16,7 +16,7 @@ */ /** - * Provides classes to work with the {@link java.lang.Comparable} and {@link java.util.Comparator} interfaces. + * Provides classes to work with the {@link Comparable} and {@link java.util.Comparator} interfaces. * * @since 3.10 */ diff --git a/src/main/java/org/apache/commons/lang3/function/package-info.java b/src/main/java/org/apache/commons/lang3/function/package-info.java index 330e7c78d..e9b9c9dea 100644 --- a/src/main/java/org/apache/commons/lang3/function/package-info.java +++ b/src/main/java/org/apache/commons/lang3/function/package-info.java @@ -20,7 +20,7 @@ * * * Contains failable functional interfaces that address the fact that lambdas are supposed not to throw Exceptions, at - * least not checked Exceptions, A.K.A. instances of {@link java.lang.Exception}. A failable functional interface + * least not checked Exceptions, A.K.A. instances of {@link Exception}. A failable functional interf
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 40fc3496b Javadoc 40fc3496b is described below commit 40fc3496bd9829a03f726fdbf88a3a2dd5ba8363 Author: Gary Gregory AuthorDate: Sat Dec 9 09:45:40 2023 -0500 Javadoc --- .../org/apache/commons/lang3/math/NumberUtils.java | 27 +- 1 file changed, 16 insertions(+), 11 deletions(-) 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 d908e639b..e5b23460c 100644 --- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java +++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java @@ -151,7 +151,7 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link BigDecimal}. + * Creates a {@link BigDecimal} from a {@link String}. * * Returns {@code null} if the string is {@code null}. * @@ -171,14 +171,16 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link BigInteger}; - * since 3.2 it handles hexadecimal (0x or #) and octal (0) notations. + * Creates a {@link BigInteger} from a {@link String}. + * + * Handles hexadecimal (0x or #) and octal (0) notations. * * Returns {@code null} if the string is {@code null}. * * @param str a {@link String} to convert, may be null * @return converted {@link BigInteger} (or null if the input is null) * @throws NumberFormatException if the value cannot be converted + * @since 3.2 */ public static BigInteger createBigInteger(final String str) { if (str == null) { @@ -213,7 +215,7 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link Double}. + * Creates a {@link Double} from a {@link String}. * * Returns {@code null} if the string is {@code null}. * @@ -229,7 +231,7 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link Float}. + * Creates a {@link Float} from a {@link String}. * * Returns {@code null} if the string is {@code null}. * @@ -245,8 +247,9 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link Integer}, handling - * hexadecimal (0x) and octal (0) notations. + * Creates an {@link Integer} from a {@link String}. + * + * Handles hexadecimal (0x) and octal (0) notations. * N.B. a leading zero means octal; spaces are not trimmed. * * Returns {@code null} if the string is {@code null}. @@ -264,8 +267,9 @@ public class NumberUtils { } /** - * Convert a {@link String} to a {@link Long}; - * since 3.1 it handles hexadecimal (0X) and octal (0ddd) notations. + * Creates a {@link Long} from a {@link String}. + * + * Handles hexadecimal (0X) and octal (0ddd) notations. * N.B. a leading zero means octal; spaces are not trimmed. * * Returns {@code null} if the string is {@code null}. @@ -273,6 +277,7 @@ public class NumberUtils { * @param str a {@link String} to convert, may be null * @return converted {@link Long} (or null if the input is null) * @throws NumberFormatException if the value cannot be converted + * @since 3.1 */ public static Long createLong(final String str) { if (str == null) { @@ -282,7 +287,7 @@ public class NumberUtils { } /** - * Turns a string value into a java.lang.Number. + * Creates a {@link Number} from a {@link String}. * * If the string starts with {@code 0x} or {@code -0x} (lower or upper case) or {@code #} or {@code -#}, it * will be interpreted as a hexadecimal Integer - or Long, if the number of digits after the @@ -485,7 +490,7 @@ public class NumberUtils { } /** - * Utility method for {@link #createNumber(java.lang.String)}. + * Utility method for {@link #createNumber(String)}. * * Returns mantissa of the given number. *
(commons-lang) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 66ddbc0c7 Javadoc spelling 66ddbc0c7 is described below commit 66ddbc0c770c60be4bf5a532684e2f547b04793c Author: Gary Gregory AuthorDate: Sun Nov 26 16:02:14 2023 -0500 Javadoc spelling --- src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 4e2d8b9fd..aeb62776e 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -114,7 +114,7 @@ public class ExceptionUtils { * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or * catch Exception and use the {@code instanceof} operator. Either of these - * techniques are required when interacting with non-Java jvm code such as + * techniques are required when interacting with non-Java JVM code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked. * @@ -856,7 +856,7 @@ public class ExceptionUtils { * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or * catch Exception and use the {@code instanceof} operator. Either of these - * techniques are required when interacting with non-Java jvm code such as + * techniques are required when interacting with non-Java JVM code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked. *
(commons-lang) branch master updated: Javadoc spelling
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 63905f616 Javadoc spelling 63905f616 is described below commit 63905f61648aa97c106ae0a65944450ebcdc17d9 Author: Gary Gregory AuthorDate: Sun Nov 26 15:53:54 2023 -0500 Javadoc spelling --- src/main/java/org/apache/commons/lang3/JavaVersion.java| 2 +- src/main/java/org/apache/commons/lang3/SystemUtils.java| 2 +- .../org/apache/commons/lang3/exception/ExceptionUtils.java | 14 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java b/src/main/java/org/apache/commons/lang3/JavaVersion.java index a0b828429..15cbb14e6 100644 --- a/src/main/java/org/apache/commons/lang3/JavaVersion.java +++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java @@ -172,7 +172,7 @@ public enum JavaVersion { JAVA_21(21, "21"), /** - * The most recent java version. Mainly introduced to avoid to break when a new version of Java is used. + * The most recent Java version. Mainly introduced to avoid to break when a new version of Java is used. */ JAVA_RECENT(maxVersion(), Float.toString(maxVersion())); diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java index d6035744b..13190bbbd 100644 --- a/src/main/java/org/apache/commons/lang3/SystemUtils.java +++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java @@ -1945,7 +1945,7 @@ public class SystemUtils { /** * Decides if the Java version matches. * - * @param versionPrefix the prefix for the java version + * @param versionPrefix the prefix for the Java version * @return true if matches, or false if not or can't determine */ private static boolean getJavaVersionMatches(final String versionPrefix) { 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 b9ac4e990..4e2d8b9fd 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -107,14 +107,14 @@ public class ExceptionUtils { * } * * - * One downside to using this approach is that the java compiler will not + * One downside to using this approach is that the Java compiler will not * allow invoking code to specify a checked exception in a catch clause * unless there is some code path within the try block that has invoked a * method declared with that checked exception. If the invoking site wishes * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or * catch Exception and use the {@code instanceof} operator. Either of these - * techniques are required when interacting with non-java jvm code such as + * techniques are required when interacting with non-Java jvm code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked. * @@ -125,7 +125,7 @@ public class ExceptionUtils { * @return Never actually returned, this generic type matches any type * which the calling site requires. "Returning" the results of this * method, as done in the propagateExample above, will satisfy the - * java compiler requirement that all code paths return a value. + * Java compiler requirement that all code paths return a value. * @since 3.14.0 * @see #wrapAndThrow(Throwable) */ @@ -849,14 +849,14 @@ public class ExceptionUtils { * } * * - * One downside to using this approach is that the java compiler will not + * One downside to using this approach is that the Java compiler will not * allow invoking code to specify a checked exception in a catch clause * unless there is some code path within the try block that has invoked a * method declared with that checked exception. If the invoking site wishes * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or * catch Exception and use the {@code instanceof} operator. Either of these - * techniques are required when interacting with non-java jvm code such as + * techniques are required when interacting with non-Java jvm code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked. * @@ -867,7 +867,7 @@ public class ExceptionUtils { * @return Never actually returned, this generic type
(commons-lang) branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 8ed7b18dc Javadoc 8ed7b18dc is described below commit 8ed7b18dc9141b49b31ae71a00d82ba8bd6ba41a Author: Gary Gregory AuthorDate: Sun Nov 26 15:00:02 2023 -0500 Javadoc Normalize spelling --- src/main/java/org/apache/commons/lang3/BooleanUtils.java | 2 +- src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java | 2 +- src/main/java/org/apache/commons/lang3/time/package-info.java| 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java index ab73a42ec..80515b762 100644 --- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java +++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java @@ -478,7 +478,7 @@ public class BooleanUtils { } /** - * Converts a String to a boolean (optimised for performance). + * Converts a String to a boolean (optimized for performance). * * {@code 'true'}, {@code 'on'}, {@code 'y'}, {@code 't'} or {@code 'yes'} * (case insensitive) will return {@code true}. Otherwise, diff --git a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java index 2faa724f5..075d8df0f 100644 --- a/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java @@ -508,7 +508,7 @@ public class DurationFormatUtils { final TimeZone timezone) { Validate.isTrue(startMillis <= endMillis, "startMillis must not be greater than endMillis"); -// Used to optimise for differences under 28 days and +// Used to optimize for differences under 28 days and // called formatDuration(millis, format); however this did not work // over leap years. // TODO: Compare performance to see if anything was lost by diff --git a/src/main/java/org/apache/commons/lang3/time/package-info.java b/src/main/java/org/apache/commons/lang3/time/package-info.java index 88b47cec6..8383ad1c0 100644 --- a/src/main/java/org/apache/commons/lang3/time/package-info.java +++ b/src/main/java/org/apache/commons/lang3/time/package-info.java @@ -19,7 +19,7 @@ * These classes are immutable (and therefore thread-safe) apart from {@link org.apache.commons.lang3.time.StopWatch}. * * The time package contains some basic utilities for manipulating time (a delorean, police box and grandfather clock?). - * These include a {@link org.apache.commons.lang3.time.StopWatch} for simple performance measurements and an optimised {@link org.apache.commons.lang3.time.FastDateFormat} class. + * These include a {@link org.apache.commons.lang3.time.StopWatch} for simple performance measurements and an optimized {@link org.apache.commons.lang3.time.FastDateFormat} class. * * @since 2.0 */
[commons-lang] branch master updated: Javadoc clarification
This is an automated email from the ASF dual-hosted git repository. sebb pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 201f0946c Javadoc clarification 201f0946c is described below commit 201f0946c0ea5caabc89782072afe6aa3fca41ee Author: Sebb AuthorDate: Sun Oct 22 15:29:37 2023 +0100 Javadoc clarification [skip ci] --- src/main/java/org/apache/commons/lang3/RandomUtils.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java index 805773449..044c2c71f 100644 --- a/src/main/java/org/apache/commons/lang3/RandomUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java @@ -63,7 +63,7 @@ public class RandomUtils { } /** - * Generates a random double within 0 - Double.MAX_VALUE. + * Generates a random double between 0 (inclusive) and Double.MAX_VALUE (exclusive). * * @return the random double * @see #nextDouble(double, double) @@ -98,7 +98,7 @@ public class RandomUtils { } /** - * Generates a random float within 0 - Float.MAX_VALUE. + * Generates a random float between 0 (inclusive) and Float.MAX_VALUE (exclusive). * * @return the random float * @see #nextFloat(float, float) @@ -133,7 +133,7 @@ public class RandomUtils { } /** - * Generates a random int within 0 - Integer.MAX_VALUE. + * Generates a random int between 0 (inclusive) and Integer.MAX_VALUE (exclusive). * * @return the random integer * @see #nextInt(int, int)
[commons-lang] branch master updated: Javadoc clarification
This is an automated email from the ASF dual-hosted git repository. sebb pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9a778293c Javadoc clarification 9a778293c is described below commit 9a778293c3559db95dd04d3c3062cdda46ed50aa Author: Sebb AuthorDate: Sun Oct 22 15:25:15 2023 +0100 Javadoc clarification [skip ci] --- src/main/java/org/apache/commons/lang3/RandomUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java index 95349685d..805773449 100644 --- a/src/main/java/org/apache/commons/lang3/RandomUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java @@ -168,7 +168,7 @@ public class RandomUtils { } /** - * Generates a random long within 0 - Long.MAX_VALUE. + * Generates a random long between 0 (inclusive) and Long.MAX_VALUE (exclusive). * * @return the random long * @see #nextLong(long, long)
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 5019cdbdb Javadoc 5019cdbdb is described below commit 5019cdbdb800eeef2b9fa35e38d968010767b2f5 Author: Gary Gregory AuthorDate: Thu Oct 19 07:35:55 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 9ce332e9d..5e8e06fce 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java @@ -1550,7 +1550,7 @@ public abstract class ToStringStyle implements Serializable { /** * Gets the short class name for a class. * - * The short class name is the classname excluding + * The short class name is the class name excluding * the package name. * * @param cls the {@link Class} to get the short name of @@ -2129,7 +2129,7 @@ public abstract class ToStringStyle implements Serializable { /** * {@link ToStringStyle} that does not print out the - * classname, identity hash code, content start or field name. + * class name, identity hash code, content start or field name. * * This is an inner class rather than using * {@link StandardToStringStyle} to ensure its immutability. @@ -2195,7 +2195,7 @@ public abstract class ToStringStyle implements Serializable { } /** - * {@link ToStringStyle} that does not print out the classname + * {@link ToStringStyle} that does not print out the class name * and identity hash code but prints content start and field names. * * This is an inner class rather than using
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 98b119bf7 Javadoc 98b119bf7 is described below commit 98b119bf799ff57925189a62c5917503fc4649d0 Author: Gary Gregory AuthorDate: Tue Oct 17 11:19:18 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 69f4f6ccf..110feb621 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -113,7 +113,7 @@ public class ExceptionUtils { * method declared with that checked exception. If the invoking site wishes * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or - * catch Exception and use the instanceof operator. Either of these + * catch Exception and use the {@code instanceof} operator. Either of these * techniques are required when interacting with non-java jvm code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked. @@ -855,7 +855,7 @@ public class ExceptionUtils { * method declared with that checked exception. If the invoking site wishes * to catch the shaded checked exception, it must either invoke the shaded * code through a method re-declaring the desired checked exception, or - * catch Exception and use the instanceof operator. Either of these + * catch Exception and use the {@code instanceof} operator. Either of these * techniques are required when interacting with non-java jvm code such as * Jython, Scala, or Groovy, since these languages do not consider any * exceptions as checked.
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 1a45003b8 Javadoc 1a45003b8 is described below commit 1a45003b8b79886750f7460f984ffd3dab4a24c0 Author: Gary Gregory AuthorDate: Tue Oct 17 10:17:45 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 220207069..06440de01 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -965,8 +965,7 @@ public class ExceptionUtils { } /** - * Tests whether the cause of the specified {@link Throwable} - * should be thrown and does it if necessary. + * Tests whether the specified {@link Throwable} is unchecked and throws it if so. * * @param The Throwable type. * @param throwable the throwable to test and throw or return.
[commons-lang] branch master updated: Javadoc, no need to abbreviate in documentation
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new f9e851690 Javadoc, no need to abbreviate in documentation f9e851690 is described below commit f9e851690c982f17c67adf0aa1d4bd4807fba6a2 Author: Gary Gregory AuthorDate: Tue Oct 17 08:43:46 2023 -0400 Javadoc, no need to abbreviate in documentation --- src/main/java/org/apache/commons/lang3/Conversion.java| 8 src/main/java/org/apache/commons/lang3/ObjectUtils.java | 4 ++-- src/main/java/org/apache/commons/lang3/math/NumberUtils.java | 8 .../apache/commons/lang3/text/translate/JavaUnicodeEscaper.java | 4 ++-- .../org/apache/commons/lang3/text/translate/UnicodeEscaper.java | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Conversion.java b/src/main/java/org/apache/commons/lang3/Conversion.java index a4ef5b778..89fb4966e 100644 --- a/src/main/java/org/apache/commons/lang3/Conversion.java +++ b/src/main/java/org/apache/commons/lang3/Conversion.java @@ -744,7 +744,7 @@ public class Conversion { * Converts an array of Char into a long using the default (little endian, Lsb0) byte and * bit ordering. * - * @param src the hex string to convert + * @param src the hexadecimal string to convert * @param srcPos the position in {@code src}, in Char unit, from where to start the *conversion * @param dstInit initial value of the destination long @@ -775,7 +775,7 @@ public class Conversion { * Converts an array of Char into an int using the default (little endian, Lsb0) byte and bit * ordering. * - * @param src the hex string to convert + * @param src the hexadecimal string to convert * @param srcPos the position in {@code src}, in Char unit, from where to start the *conversion * @param dstInit initial value of the destination int @@ -805,7 +805,7 @@ public class Conversion { * Converts an array of Char into a short using the default (little endian, Lsb0) byte and * bit ordering. * - * @param src the hex string to convert + * @param src the hexadecimal string to convert * @param srcPos the position in {@code src}, in Char unit, from where to start the *conversion * @param dstInit initial value of the destination short @@ -836,7 +836,7 @@ public class Conversion { * Converts an array of Char into a byte using the default (little endian, Lsb0) byte and * bit ordering. * - * @param src the hex string to convert + * @param src the hexadecimal string to convert * @param srcPos the position in {@code src}, in Char unit, from where to start the *conversion * @param dstInit initial value of the destination byte diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index 381832a84..2e5a6c4db 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -743,7 +743,7 @@ public class ObjectUtils { } /** - * Returns the hex hash code for the given object per {@link Objects#hashCode(Object)}. + * Returns the hexadecimal hash code for the given object per {@link Objects#hashCode(Object)}. * * Short hand for {@code Integer.toHexString(Objects.hashCode(object))}. * @@ -792,7 +792,7 @@ public class ObjectUtils { } /** - * Returns the hex hash code for the given object per {@link System#identityHashCode(Object)}. + * Returns the hexadecimal hash code for the given object per {@link System#identityHashCode(Object)}. * * Short hand for {@code Integer.toHexString(System.identityHashCode(object))}. * 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 1059b4cd1..53c9fbe4f 100644 --- a/src/main/java/org/apache/commons/lang3/math/NumberUtils.java +++ b/src/main/java/org/apache/commons/lang3/math/NumberUtils.java @@ -930,7 +930,7 @@ public class NumberUtils { /** * Convert a {@link String} to a {@link Integer}, handling - * hex (0x) and octal (0) notations. + * hexadecimal (0x) and octal (0) notations. * N.B. a leading zero means octal; spaces are not trimmed. * * Returns {@code null} if the string is {@code null}. @@ -949,7 +949,7 @@ public class NumberUtils { /** * Convert a {@link String} to a {@link Long}; - * since 3.1 it handles hex (0X) and octal (0ddd) notations. + * since 3.1 it handles hexadecimal (0X) and octal (0ddd) notations.
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new e53d4c52d Javadoc e53d4c52d is described below commit e53d4c52d3717aa70e1c6216a59a1f6c767ec72b Author: Gary Gregory AuthorDate: Sat Oct 7 10:35:19 2023 -0400 Javadoc --- .../lang3/concurrent/EventCountCircuitBreaker.java | 17 + 1 file changed, 13 insertions(+), 4 deletions(-) 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 632396f09..5c9f44b0b 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/EventCountCircuitBreaker.java @@ -255,9 +255,12 @@ public class EventCountCircuitBreaker extends AbstractCircuitBreaker { } /** - * {@inheritDoc} This implementation checks the internal event counter against the + * {@inheritDoc} + * + * This implementation checks the internal event counter against the * threshold values and the check intervals. This may cause a state change of this * circuit breaker. + * */ @Override public boolean checkState() { @@ -285,10 +288,13 @@ public class EventCountCircuitBreaker extends AbstractCircuitBreaker { } /** - * {@inheritDoc} This circuit breaker may close itself again if the number of events + * {@inheritDoc} + * + * This circuit breaker may close itself again if the number of events * received during a check interval goes below the closing threshold. If this circuit * breaker is already open, this method has no effect, except that a new check * interval is started. + * */ @Override public void open() { @@ -297,10 +303,13 @@ public class EventCountCircuitBreaker extends AbstractCircuitBreaker { } /** - * {@inheritDoc} A new check interval is started. If too many events are received in + * {@inheritDoc} + * + * A new check interval is started. If too many events are received in * this interval, the circuit breaker changes again to state open. If this circuit * breaker is already closed, this method has no effect, except that a new check * interval is started. + * */ @Override public void close() { @@ -468,7 +477,7 @@ public class EventCountCircuitBreaker extends AbstractCircuitBreaker { * @return the updated instance */ public CheckIntervalData increment(final int delta) { -return (delta == 0) ? this : new CheckIntervalData(getEventCount() + delta, +return delta == 0 ? this : new CheckIntervalData(getEventCount() + delta, getCheckIntervalStart()); } }
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new e2426182c Javadoc e2426182c is described below commit e2426182c81d371e3c1ea3410156528e7c7944b3 Author: Gary Gregory AuthorDate: Fri Oct 6 09:43:02 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/StringUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java index 71697a97e..fbf10227a 100644 --- a/src/main/java/org/apache/commons/lang3/StringUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringUtils.java @@ -8991,7 +8991,7 @@ public class StringUtils { *the encoding to use, if null then use the platform default * @return a new String * @throws UnsupportedEncodingException - * If the named charset is not supported + * Never thrown * @throws NullPointerException * if the input is null * @deprecated use {@link StringUtils#toEncodedString(byte[], Charset)} instead of String constants in your code
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 7733c39e6 Javadoc 7733c39e6 is described below commit 7733c39e6bbacaafea0b3019d65a7c0c67007e93 Author: Gary Gregory AuthorDate: Thu Aug 10 09:37:36 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/ArrayFill.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/java/org/apache/commons/lang3/ArrayFill.java b/src/main/java/org/apache/commons/lang3/ArrayFill.java index facdc6619..a8de5e702 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayFill.java +++ b/src/main/java/org/apache/commons/lang3/ArrayFill.java @@ -120,6 +120,7 @@ public final class ArrayFill { /** * Fills and returns the given array. * + * @param the array type. * @param a the array to be filled. * @param val the value to be stored in all elements of the array. * @return the given array.
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 30bdb1964 Javadoc 30bdb1964 is described below commit 30bdb1964a08cb59470a1eb989d637c6956f9837 Author: Gary Gregory AuthorDate: Sun Jul 23 14:32:40 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/ObjectUtils.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index 33eac6949..69b5a7a3b 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -959,7 +959,7 @@ public class ObjectUtils { */ /** - * Checks, whether the given object is an Object array or a primitive array in a null-safe manner. + * Tests whether the given object is an Object array or a primitive array in a null-safe manner. * * * A {@code null} {@code object} Object will return {@code false}. @@ -983,7 +983,7 @@ public class ObjectUtils { } /** - * Checks if an Object is empty or null. + * Tests if an Object is empty or null. * * The following types are supported: * @@ -1035,7 +1035,7 @@ public class ObjectUtils { } /** - * Checks if an Object is not empty and not null. + * Tests if an Object is not empty and not null. * * The following types are supported: *
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9c73c833d Javadoc 9c73c833d is described below commit 9c73c833d53d23fffb116049904d4b07998f53b1 Author: Gary Gregory AuthorDate: Sun Jul 23 14:31:28 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/ObjectUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index c1208fdd5..33eac6949 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -657,7 +657,7 @@ public class ObjectUtils { * * @param The argument type or null. * @param object The argument. - * @return The argument Class or null. + * @return The argument's Class or null. * @since 3.13.0 */ @SuppressWarnings("unchecked")
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new c455ea283 Javadoc c455ea283 is described below commit c455ea283271f3e81404e024b42ced5adb10f224 Author: Gary Gregory AuthorDate: Sat Jul 22 21:43:04 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java index d1c3661da..6eb33267b 100755 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeExclude.java @@ -23,9 +23,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Use this annotation to exclude a field from being used by - * the various {@code reflectionHashcode} methods defined on - * {@link HashCodeBuilder}. + * Exclude a field from being used by the various {@code reflectionHashcode} methods defined on {@link HashCodeBuilder}. * * @since 3.5 */
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new e570d3df4 Javadoc e570d3df4 is described below commit e570d3df471154872bc23a7111836566f0487170 Author: Gary Gregory AuthorDate: Sat Jul 22 21:42:45 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java index b4ede8f1e..6f9f0cb60 100755 --- a/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java +++ b/src/main/java/org/apache/commons/lang3/builder/EqualsExclude.java @@ -23,9 +23,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Use this annotation to exclude a field from being used by - * the various {@code reflectionEquals} methods defined on - * {@link EqualsBuilder}. + * Excludes a field from being used by the various {@code reflectionEquals} methods defined on {@link EqualsBuilder}. * * @since 3.5 */
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new b4e34819f Javadoc b4e34819f is described below commit b4e34819ff1a25179ec4be5485c911eb6c58dcfc Author: Gary Gregory AuthorDate: Sat Jul 22 21:42:10 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java index 2b399f288..64b7582ce 100755 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringExclude.java @@ -23,8 +23,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Use this annotation to exclude a field from being used by - * the {@link ReflectionToStringBuilder}. + * Excludes a field from being used by the {@link ReflectionToStringBuilder}. * * @since 3.5 */
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 61edac32f Javadoc 61edac32f is described below commit 61edac32f0a558adc4f25fbc6cfb98f9171343f8 Author: Gary Gregory AuthorDate: Mon Jul 10 16:56:06 2023 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java | 4 .../java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java | 4 2 files changed, 8 insertions(+) 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 e4d20a990..367508e08 100644 --- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java @@ -56,12 +56,16 @@ import org.apache.commons.lang3.ObjectUtils; * {@code DiffResult.toString()} method. This style choice can be overridden by * calling {@link DiffResult#toString(ToStringStyle)}. * + * + * See {@link ReflectionDiffBuilder} for a reflection based version of this class. + * * * @param type of the left and right object. * @see Diffable * @see Diff * @see DiffResult * @see ToStringStyle + * @see ReflectionDiffBuilder * @since 3.3 */ public class DiffBuilder implements Builder> { 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 e0b257b49..131b84668 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/ReflectionDiffBuilder.java @@ -59,12 +59,16 @@ import org.apache.commons.lang3.reflect.FieldUtils; * {@code DiffResult.toString()} method. This style choice can be overridden by * calling {@link DiffResult#toString(ToStringStyle)}. * + * + * See {@link DiffBuilder} for a non-reflection based version of this class. + * * @param *type of the left and right object to diff. * @see Diffable * @see Diff * @see DiffResult * @see ToStringStyle + * @see DiffBuilder * @since 3.6 */ public class ReflectionDiffBuilder implements Builder> {
[commons-lang] branch master updated: Javadoc & format tweaks
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 38f55010f Javadoc & format tweaks 38f55010f is described below commit 38f55010fbacdf666da84b1f3c995f4943c10ba7 Author: Gary Gregory AuthorDate: Thu Jul 6 13:25:40 2023 -0400 Javadoc & format tweaks --- src/main/java/org/apache/commons/lang3/ArchUtils.java | 18 -- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ArchUtils.java b/src/main/java/org/apache/commons/lang3/ArchUtils.java index 52422faa9..efc5b0a18 100644 --- a/src/main/java/org/apache/commons/lang3/ArchUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArchUtils.java @@ -23,12 +23,11 @@ import org.apache.commons.lang3.arch.Processor; import org.apache.commons.lang3.stream.Streams; /** - * A utility class for the {@code os.arch} System Property. The class defines methods for - * identifying the architecture of the current JVM. + * Provides methods for identifying the architecture of the current JVM based on the {@code "os.arch"} system property. * - * Important: The {@code os.arch} System Property returns the architecture used by the JVM - * not of the operating system. + * Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system. * + * * @since 3.6 */ public class ArchUtils { @@ -81,7 +80,7 @@ public class ArchUtils { /** * Adds the given {@link Processor} with the given key {@link String} to the map. * - * @param key The key as {@link String}. + * @param key The key as {@link String}. * @param processor The {@link Processor} to add. * @throws IllegalStateException If the key already exists. */ @@ -95,7 +94,7 @@ public class ArchUtils { /** * Adds the given {@link Processor} with the given keys to the map. * - * @param keys The keys. + * @param keys The keys. * @param processor The {@link Processor} to add. * @throws IllegalStateException If the key already exists. */ @@ -107,8 +106,7 @@ public class ArchUtils { * Gets a {@link Processor} object of the current JVM. * * - * Important: The os.arch System Property returns the architecture used by the JVM - * not of the operating system. + * Important: The {@code "os.arch"} system property returns the architecture used by the JVM not of the operating system. * * * @return A {@link Processor} when supported, else {@code null}. @@ -118,8 +116,8 @@ public class ArchUtils { } /** - * Gets a {@link Processor} object the given value {@link String}. The {@link String} must be - * like a value returned by the {@code os.arch} System Property. + * Gets a {@link Processor} object the given value {@link String}. The {@link String} must be like a value returned by the {@code "os.arch"} system + * property. * * @param value A {@link String} like a value returned by the {@code os.arch} System Property. * @return A {@link Processor} when it exists, else {@code null}.
[commons-lang] branch master updated: Javadoc, in-line comment, and messages typos
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new ad710950a Javadoc, in-line comment, and messages typos ad710950a is described below commit ad710950a285ab2f72108fe98be63a7325ae42ce Author: Gary Gregory AuthorDate: Fri May 19 08:59:46 2023 -0400 Javadoc, in-line comment, and messages typos --- .../commons/lang3/text/ExtendedMessageFormatTest.java | 14 +++--- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java b/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java index f773b0697..d8e8f5ff6 100644 --- a/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java +++ b/src/test/java/org/apache/commons/lang3/text/ExtendedMessageFormatTest.java @@ -287,7 +287,7 @@ public class ExtendedMessageFormatTest extends AbstractLangTest { } /** - * Test equals() and hashcode. + * Test equals() and hashCode(). */ @Test public void testEqualsHashcode() { @@ -301,32 +301,32 @@ public class ExtendedMessageFormatTest extends AbstractLangTest { // Same object assertEquals(emf, emf, "same, equals()"); -assertEquals(emf.hashCode(), emf.hashCode(), "same, hashcode()"); +assertEquals(emf.hashCode(), emf.hashCode(), "same, hashCode()"); // Equal Object other = new ExtendedMessageFormat(pattern, Locale.US, fmtRegistry); assertEquals(emf, other, "equal, equals()"); -assertEquals(emf.hashCode(), other.hashCode(), "equal, hashcode()"); +assertEquals(emf.hashCode(), other.hashCode(), "equal, hashCode()"); // Different Class other = new OtherExtendedMessageFormat(pattern, Locale.US, fmtRegistry); assertNotEquals(emf, other, "class, equals()"); -assertEquals(emf.hashCode(), other.hashCode(), "class, hashcode()"); // same hashcode +assertEquals(emf.hashCode(), other.hashCode(), "class, hashCode()"); // same hash code // Different pattern other = new ExtendedMessageFormat("X" + pattern, Locale.US, fmtRegistry); assertNotEquals(emf, other, "pattern, equals()"); -assertNotEquals(emf.hashCode(), other.hashCode(), "pattern, hashcode()"); +assertNotEquals(emf.hashCode(), other.hashCode(), "pattern, hashCode()"); // Different registry other = new ExtendedMessageFormat(pattern, Locale.US, otherRegistry); assertNotEquals(emf, other, "registry, equals()"); -assertNotEquals(emf.hashCode(), other.hashCode(), "registry, hashcode()"); +assertNotEquals(emf.hashCode(), other.hashCode(), "registry, hashCode()"); // Different Locale other = new ExtendedMessageFormat(pattern, Locale.FRANCE, fmtRegistry); assertNotEquals(emf, other, "locale, equals()"); -assertEquals(emf.hashCode(), other.hashCode(), "locale, hashcode()"); // same hashcode +assertEquals(emf.hashCode(), other.hashCode(), "locale, hashCode()"); // same hash code } /**
[commons-lang] branch master updated: Javadoc typos
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9e404e5eb Javadoc typos 9e404e5eb is described below commit 9e404e5eb864f0396cb3360ea6656addfb544dd2 Author: Gary Gregory AuthorDate: Fri May 19 08:50:53 2023 -0400 Javadoc typos --- src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java | 2 +- src/main/java/org/apache/commons/lang3/builder/IDKey.java| 4 ++-- src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java| 4 ++-- src/main/java/org/apache/commons/lang3/builder/package-info.java | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java index 844ec86be..136cb5c3a 100644 --- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java @@ -30,7 +30,7 @@ import org.apache.commons.lang3.ObjectUtils; * Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods. * * It is consistent with {@code equals(Object)} and - * {@code hashcode()} built with {@link EqualsBuilder} and + * {@code hashCode()} built with {@link EqualsBuilder} and * {@link HashCodeBuilder}. * * Two Objects that compare equal using {@code equals(Object)} should normally 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 64e8fc5b7..8fabb482d 100644 --- a/src/main/java/org/apache/commons/lang3/builder/IDKey.java +++ b/src/main/java/org/apache/commons/lang3/builder/IDKey.java @@ -44,8 +44,8 @@ final class IDKey { } /** - * returns hash code - i.e. the system identity hashcode. - * @return the hashcode + * returns hash code - i.e. the system identity hash code. + * @return the hash code */ @Override public int hashCode() { 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 98ecc8fb6..9ce332e9d 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java @@ -2098,7 +2098,7 @@ public abstract class ToStringStyle implements Serializable { /** * {@link ToStringStyle} that prints out the short - * class name and no identity hashcode. + * class name and no identity hash code. * * This is an inner class rather than using * {@link StandardToStringStyle} to ensure its immutability. @@ -2129,7 +2129,7 @@ public abstract class ToStringStyle implements Serializable { /** * {@link ToStringStyle} that does not print out the - * classname, identity hashcode, content start or field name. + * classname, identity hash code, content start or field name. * * This is an inner class rather than using * {@link StandardToStringStyle} to ensure its immutability. diff --git a/src/main/java/org/apache/commons/lang3/builder/package-info.java b/src/main/java/org/apache/commons/lang3/builder/package-info.java index 216706718..b8163b59b 100644 --- a/src/main/java/org/apache/commons/lang3/builder/package-info.java +++ b/src/main/java/org/apache/commons/lang3/builder/package-info.java @@ -21,7 +21,7 @@ * When you write a {@link java.lang.Object#hashCode() hashCode()}, do you check Bloch's Effective Java? No? * You just hack in a quick number? * Well {@link org.apache.commons.lang3.builder.HashCodeBuilder} will save your day. - * It, and its buddies ({@link org.apache.commons.lang3.builder.EqualsBuilder}, {@link org.apache.commons.lang3.builder.CompareToBuilder}, {@link org.apache.commons.lang3.builder.ToStringBuilder}), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hashcode. + * It, and its buddies ({@link org.apache.commons.lang3.builder.EqualsBuilder}, {@link org.apache.commons.lang3.builder.CompareToBuilder}, {@link org.apache.commons.lang3.builder.ToStringBuilder}), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hash code. * * @see Object#equals(Object) * @see Object#toString()
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new ee7afc5c2 Javadoc ee7afc5c2 is described below commit ee7afc5c2dbad6211a5efd549aa90119fa0bb12a Author: Gary Gregory AuthorDate: Tue Apr 18 08:35:05 2023 -0400 Javadoc --- .../java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java index 2266abb4a..545b220fb 100644 --- a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java @@ -35,7 +35,7 @@ import org.junit.jupiter.api.Test; import org.junitpioneer.jupiter.DefaultTimeZone; /** - * TestCase for DurationFormatUtils. + * Tests {@link DurationFormatUtils}. * * NOT THREAD-SAFE. *
[commons-lang] branch master updated: Javadoc/Comments: Remove extra "whitespace"
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new ccb4ad223 Javadoc/Comments: Remove extra "whitespace" ccb4ad223 is described below commit ccb4ad2234dbc56a6396e4b1d54a1675b5446c5b Author: Gary Gregory AuthorDate: Sat Mar 25 09:36:25 2023 -0400 Javadoc/Comments: Remove extra "whitespace" --- src/test/java/org/apache/commons/lang3/EnumUtilsTest.java| 1 - src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherChild.java | 1 - .../java/org/apache/commons/lang3/reflect/testbed/AnotherParent.java | 1 - src/test/java/org/apache/commons/lang3/reflect/testbed/Grandchild.java | 1 - 4 files changed, 4 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/EnumUtilsTest.java b/src/test/java/org/apache/commons/lang3/EnumUtilsTest.java index 9f8da63a3..20cf5ae62 100644 --- a/src/test/java/org/apache/commons/lang3/EnumUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/EnumUtilsTest.java @@ -41,7 +41,6 @@ enum Enum64 { } /** - * */ public class EnumUtilsTest extends AbstractLangTest { diff --git a/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherChild.java b/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherChild.java index 590d4188c..8944aa236 100644 --- a/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherChild.java +++ b/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherChild.java @@ -17,7 +17,6 @@ package org.apache.commons.lang3.reflect.testbed; /** - * */ public class AnotherChild extends AnotherParent { } diff --git a/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherParent.java b/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherParent.java index 795e46a05..f43e6e477 100644 --- a/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherParent.java +++ b/src/test/java/org/apache/commons/lang3/reflect/testbed/AnotherParent.java @@ -17,7 +17,6 @@ package org.apache.commons.lang3.reflect.testbed; /** - * */ public class AnotherParent { } diff --git a/src/test/java/org/apache/commons/lang3/reflect/testbed/Grandchild.java b/src/test/java/org/apache/commons/lang3/reflect/testbed/Grandchild.java index 06b9c614f..abac4db1e 100644 --- a/src/test/java/org/apache/commons/lang3/reflect/testbed/Grandchild.java +++ b/src/test/java/org/apache/commons/lang3/reflect/testbed/Grandchild.java @@ -17,7 +17,6 @@ package org.apache.commons.lang3.reflect.testbed; /** - * */ public class Grandchild extends AnotherChild { }
[commons-lang] branch master updated: Javadoc & format tweaks
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 3f920e7a7 Javadoc & format tweaks 3f920e7a7 is described below commit 3f920e7a753dffd33f33393d8306bf571d5c979f Author: Gary Gregory AuthorDate: Wed Dec 7 10:10:16 2022 -0500 Javadoc & format tweaks --- .../java/org/apache/commons/lang3/time/DateUtilsTest.java | 13 ++--- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java index 64847b741..730959adf 100644 --- a/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java @@ -54,7 +54,6 @@ public class DateUtilsTest extends AbstractLangTest { private static Date BASE_DATE; private static TimeZone DEFAULT_ZONE; - /** * Used to check that Calendar objects are close enough * delta is in milliseconds @@ -606,7 +605,7 @@ public class DateUtilsTest extends AbstractLangTest { dateTimeParser.setTimeZone(DEFAULT_ZONE); } - // Bug 31395, large dates +// Bug 31395, large dates final Date endOfTime = new Date(Long.MAX_VALUE); // fyi: Sun Aug 17 07:12:55 CET 292278994 -- 807 millis final GregorianCalendar endCal = new GregorianCalendar(); endCal.setTime(endOfTime); @@ -790,7 +789,7 @@ public class DateUtilsTest extends AbstractLangTest { assertThrows(ClassCastException.class, () -> DateUtils.iterator("", DateUtils.RANGE_WEEK_CENTER)); } -// https://issues.apache.org/jira/browse/LANG-530 +/** https://issues.apache.org/jira/browse/LANG-530 */ @SuppressWarnings("deprecation") @Test public void testLang530() throws ParseException { @@ -806,7 +805,7 @@ public class DateUtilsTest extends AbstractLangTest { DateUtils.parseDateStrictly("09 abril 2008 23:55:38 GMT", new Locale("es"), "dd MMM HH:mm:ss zzz"); } -// Parse English date with German Locale +/** Parse English date with German Locale. */ @DefaultLocale(language = "de") @Test public void testLANG799_DE_FAIL() { @@ -834,7 +833,7 @@ public class DateUtilsTest extends AbstractLangTest { DateUtils.parseDateStrictly("Wed, 09 Apr 2008 23:55:38 GMT", "EEE, dd MMM HH:mm:ss zzz"); } -// Parse German date with English Locale, specifying German Locale override +/** Parse German date with English Locale, specifying German Locale override. */ @DefaultLocale(language = "en") @Test public void testLANG799_EN_WITH_DE_LOCALE() throws ParseException { @@ -914,9 +913,9 @@ public class DateUtilsTest extends AbstractLangTest { assertThrows(NullPointerException.class, () -> DateUtils.parseDate(null, parsers)); } -// LANG-486 +/** LANG-486 */ @Test -public void testParseDateWithLeniency() throws Exception { +public void testParseDateWithLeniency() throws ParseException { final GregorianCalendar cal = new GregorianCalendar(1998, 6, 30); final String dateStr = "02 942, 1996"; final String[] parsers = {"MM DDD, "};
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 0659831ad Javadoc 0659831ad is described below commit 0659831ad49a41244337eb9c60e6b6fe921756c2 Author: Gary Gregory AuthorDate: Tue Oct 25 10:02:41 2022 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/function/MethodInvokers.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java b/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java index 39f3b1e31..b90f0c14f 100644 --- a/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java +++ b/src/main/java/org/apache/commons/lang3/function/MethodInvokers.java @@ -201,13 +201,13 @@ public final class MethodInvokers { * * * @param The interface type. - * @param intfc The interface type. + * @param interfaceClass a class object representing {@code T}. * @param method the method to invoke. * @return a correctly-typed wrapper for the given target. * @see MethodHandleProxies#asInterfaceInstance(Class, MethodHandle) */ -public static T asInterfaceInstance(final Class intfc, final Method method) { -return MethodHandleProxies.asInterfaceInstance(Objects.requireNonNull(intfc, "intfc"), unreflectUnchecked(method)); +public static T asInterfaceInstance(final Class interfaceClass, final Method method) { +return MethodHandleProxies.asInterfaceInstance(Objects.requireNonNull(interfaceClass, "interfaceClass"), unreflectUnchecked(method)); } /**
[commons-lang] branch master updated: Javadoc @link tags do not need to use a FQCN for classes in java.lang
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 8b6f18cb0 Javadoc @link tags do not need to use a FQCN for classes in java.lang 8b6f18cb0 is described below commit 8b6f18cb0d4b0fb1281b39bfb36bababa6c26886 Author: Gary Gregory AuthorDate: Mon Aug 29 07:36:33 2022 -0400 Javadoc @link tags do not need to use a FQCN for classes in java.lang --- src/main/java/org/apache/commons/lang3/ObjectUtils.java | 4 ++-- src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java | 2 +- src/main/java/org/apache/commons/lang3/concurrent/package-info.java | 2 +- src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index 735617863..db1161368 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -62,7 +62,7 @@ public class ObjectUtils { * has another meaning. * * For example, in a {@link HashMap} the - * {@link java.util.HashMap#get(java.lang.Object)} method returns + * {@link java.util.HashMap#get(Object)} method returns * {@code null} if the {@link Map} contains {@code null} or if there is * no matching key. The {@code null} placeholder can be used to distinguish * between these two cases. @@ -101,7 +101,7 @@ public class ObjectUtils { * {@code null} has another meaning. * * For example, in a {@link HashMap} the - * {@link java.util.HashMap#get(java.lang.Object)} method returns + * {@link java.util.HashMap#get(Object)} method returns * {@code null} if the {@link Map} contains {@code null} or if there * is no matching key. The {@code null} placeholder can be used to * distinguish between these two cases. 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 9779853ca..39c88185a 100644 --- a/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/ToStringBuilder.java @@ -902,7 +902,7 @@ public class ToStringBuilder implements Builder { /** * Appends with the same format as the default Object toString() * method. Appends the class name followed by - * {@link System#identityHashCode(java.lang.Object)}. + * {@link System#identityHashCode(Object)}. * * @param srcObject the {@link Object} whose class name and id to output * @return this diff --git a/src/main/java/org/apache/commons/lang3/concurrent/package-info.java b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java index 7ff093401..a283a86d0 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/package-info.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/package-info.java @@ -407,7 +407,7 @@ * The nested {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder} class defines some methods for * configuring the new {@link org.apache.commons.lang3.concurrent.BasicThreadFactory} instance. Objects of this class * are immutable, so these attributes cannot be changed later. The naming pattern is a string which can be passed to - * {@link java.lang.String#format(java.util.Locale, String, Object...)}. The placeholder %d is replaced by an + * {@link String#format(java.util.Locale, String, Object...)}. The placeholder %d is replaced by an * increasing counter value. An instance can wrap another {@link java.util.concurrent.ThreadFactory} implementation; * this is achieved by calling the builder's * {@link org.apache.commons.lang3.concurrent.BasicThreadFactory.Builder#wrappedFactory(java.util.concurrent.ThreadFactory) 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 68de4ccab..71f5f65fc 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java @@ -401,7 +401,7 @@ public class TypeUtils { * parameter of {@link java.util.SortedSet}, which in turn sets the * parameter of {@link Set}, which in turn sets the parameter of * {@link java.util.Collection}, which in turn sets the parameter of - * {@link java.lang.Iterable}. Since {@link TreeSet}'s parameter maps + * {@link Iterable}. Since {@link TreeSet}'s parameter maps * (indirectly) to {@link Iterable}'s parameter, it will be able to * determine that based on the super type {@code Iterable>>}, the parameter of
[commons-lang] branch master updated: Javadoc @see tags do not need to use a FQCN for classes in java.lang
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 83dd1284e Javadoc @see tags do not need to use a FQCN for classes in java.lang 83dd1284e is described below commit 83dd1284e4af9e6b1a7a82ce5a095c8185309a1c Author: Gary Gregory AuthorDate: Mon Aug 29 07:18:26 2022 -0400 Javadoc @see tags do not need to use a FQCN for classes in java.lang --- src/main/java/org/apache/commons/lang3/Validate.java | 4 ++-- src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Validate.java b/src/main/java/org/apache/commons/lang3/Validate.java index 7e406379d..70b294bff 100644 --- a/src/main/java/org/apache/commons/lang3/Validate.java +++ b/src/main/java/org/apache/commons/lang3/Validate.java @@ -837,7 +837,7 @@ public class Validate { * * @param value the value to validate * @throws IllegalArgumentException if the value is not a number - * @see #notNaN(double, java.lang.String, Object...) + * @see #notNaN(double, String, Object...) * * @since 3.5 */ @@ -875,7 +875,7 @@ public class Validate { * * @param value the value to validate * @throws IllegalArgumentException if the value is infinite or Not-a-Number (NaN) - * @see #finite(double, java.lang.String, Object...) + * @see #finite(double, String, Object...) * * @since 3.5 */ 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 9d6c90ae1..6529d8d4d 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java @@ -73,7 +73,7 @@ public class ConstructorUtils { * @throws IllegalAccessException if invocation is not permitted by security * @throws InvocationTargetException if an error occurs on invocation * @throws InstantiationException if an error occurs on instantiation - * @see #invokeConstructor(java.lang.Class, java.lang.Object[], Class[]) + * @see #invokeConstructor(Class, Object[], Class[]) */ public static T invokeConstructor(final Class cls, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException, @@ -136,7 +136,7 @@ public class ConstructorUtils { * @throws IllegalAccessException if invocation is not permitted by security * @throws InvocationTargetException if an error occurs on invocation * @throws InstantiationException if an error occurs on instantiation - * @see #invokeExactConstructor(java.lang.Class, java.lang.Object[], Class[]) + * @see #invokeExactConstructor(Class, Object[], Class[]) */ public static T invokeExactConstructor(final Class cls, Object... args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException,
[commons-lang] branch master updated: Javadoc @see tags do not need to use a FQCN for classes in java.lang
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 843fa377c Javadoc @see tags do not need to use a FQCN for classes in java.lang 843fa377c is described below commit 843fa377c871922a2d757dfc9fdf2fdeae61b67c Author: Gary Gregory AuthorDate: Mon Aug 29 07:17:06 2022 -0400 Javadoc @see tags do not need to use a FQCN for classes in java.lang --- src/main/java/org/apache/commons/lang3/CharSetUtils.java | 10 +- .../java/org/apache/commons/lang3/StringEscapeUtils.java | 6 +++--- src/main/java/org/apache/commons/lang3/StringUtils.java| 14 +++--- src/main/java/org/apache/commons/lang3/ThreadUtils.java| 4 ++-- src/main/java/org/apache/commons/lang3/Validate.java | 6 +++--- .../org/apache/commons/lang3/builder/CompareToBuilder.java | 6 +++--- .../org/apache/commons/lang3/builder/package-info.java | 8 .../apache/commons/lang3/exception/ContextedException.java | 4 ++-- .../commons/lang3/exception/ContextedRuntimeException.java | 4 ++-- .../org/apache/commons/lang3/mutable/MutableFloat.java | 2 +- .../org/apache/commons/lang3/reflect/ConstructorUtils.java | 6 +++--- .../java/org/apache/commons/lang3/time/FastDateFormat.java | 8 .../java/org/apache/commons/lang3/time/FastDateParser.java | 8 .../org/apache/commons/lang3/time/FastDatePrinter.java | 12 ++-- 14 files changed, 49 insertions(+), 49 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSetUtils.java b/src/main/java/org/apache/commons/lang3/CharSetUtils.java index 198a6535a..b1efea59d 100644 --- a/src/main/java/org/apache/commons/lang3/CharSetUtils.java +++ b/src/main/java/org/apache/commons/lang3/CharSetUtils.java @@ -44,7 +44,7 @@ public class CharSetUtils { * CharSetUtils.containsAny("hello", "a-d") = false * * - * @see CharSet#getInstance(java.lang.String...) for set-syntax. + * @see CharSet#getInstance(String...) for set-syntax. * @param str String to look for characters in, may be null * @param set String[] set of characters to identify, may be null * @return whether or not the characters in the set are in the primary string @@ -76,7 +76,7 @@ public class CharSetUtils { * CharSetUtils.count("hello", "a-e") = 1 * * - * @see CharSet#getInstance(java.lang.String...) for set-syntax. + * @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 @@ -119,7 +119,7 @@ public class CharSetUtils { * CharSetUtils.delete("hello", "le") = "ho" * * - * @see CharSet#getInstance(java.lang.String...) for set-syntax. + * @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 @@ -144,7 +144,7 @@ public class CharSetUtils { * CharSetUtils.keep("hello", "le") = "ell" * * - * @see CharSet#getInstance(java.lang.String...) for set-syntax. + * @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 @@ -193,7 +193,7 @@ public class CharSetUtils { * CharSetUtils.squeeze("hello", "a-e") = "hello" * * - * @see CharSet#getInstance(java.lang.String...) for set-syntax. + * @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 diff --git a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java index c70020ffe..2aee2ca52 100644 --- a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java @@ -653,7 +653,7 @@ public class StringEscapeUtils { * * @param input the {@link String} to escape, may be null * @return a new escaped {@link String}, {@code null} if null string input - * @see #unescapeXml(java.lang.String) + * @see #unescapeXml(String) * @deprecated use {@link #escapeXml10(java.lang.String)} or {@link #escapeXml11(java.lang.String)} instead. */ @Deprecated @@ -686,7 +686,7 @@ public class StringEscapeUtils { * * @param inpu
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9a372f674 Javadoc 9a372f674 is described below commit 9a372f674951deee557cea93f6517674c0c5e315 Author: Gary Gregory AuthorDate: Fri Aug 26 16:39:14 2022 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java index 0dedad315..7dc042f29 100644 --- a/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/HashCodeBuilder.java @@ -894,7 +894,7 @@ public class HashCodeBuilder implements Builder { } /** - * Implements equals with iTotal. + * Implements equals using the hash code. * * @since 3.13.0 */
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 3cc9e3b44 Javadoc 3cc9e3b44 is described below commit 3cc9e3b44913491ea0ab39f3efdf3c3596914d3f Author: Gary Gregory AuthorDate: Mon Aug 22 10:25:47 2022 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/mutable/Mutable.java| 2 ++ src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java | 1 + src/main/java/org/apache/commons/lang3/mutable/MutableByte.java| 1 + src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java | 1 + src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java | 1 + src/main/java/org/apache/commons/lang3/mutable/MutableInt.java | 1 + src/main/java/org/apache/commons/lang3/mutable/MutableLong.java| 1 + src/main/java/org/apache/commons/lang3/mutable/MutableShort.java | 1 + 8 files changed, 9 insertions(+) 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 6abfe2bfc..e6c748524 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/Mutable.java +++ b/src/main/java/org/apache/commons/lang3/mutable/Mutable.java @@ -21,10 +21,12 @@ package org.apache.commons.lang3.mutable; * Provides mutable access to a value. * * {@link Mutable} is used as a generic interface to the implementations in this package. + * * * A typical use case would be to enable a primitive or string to be passed to a method and allow that method to * effectively change the value of the primitive/string. Another use case is to store a frequently changing primitive in * a collection (for example a total in a map) without needing to create new Integer/Long wrapper objects. + * * * @param the type to set and get * @since 2.1 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 b28516498..68511c33b 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java +++ b/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java @@ -25,6 +25,7 @@ import org.apache.commons.lang3.BooleanUtils; * A mutable {@code boolean} wrapper. * * Note that as MutableBoolean does not extend Boolean, it is not treated by String.format as a Boolean parameter. + * * * @see Boolean * @since 2.2 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 308064589..94d973805 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java +++ b/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java @@ -22,6 +22,7 @@ import org.apache.commons.lang3.math.NumberUtils; * A mutable {@code byte} wrapper. * * Note that as MutableByte does not extend Byte, it is not treated by String.format as a Byte parameter. + * * * @see Byte * @since 2.1 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 83f30895e..3f0d0e6bb 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java +++ b/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java @@ -20,6 +20,7 @@ package org.apache.commons.lang3.mutable; * A mutable {@code double} wrapper. * * Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter. + * * * @see Double * @since 2.1 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 bc7f0b0f0..6d6c30eef 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java +++ b/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java @@ -20,6 +20,7 @@ package org.apache.commons.lang3.mutable; * A mutable {@code float} wrapper. * * Note that as MutableFloat does not extend Float, it is not treated by String.format as a Float parameter. + * * * @see Float * @since 2.1 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 245cb8de3..99e78b972 100644 --- a/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java +++ b/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java @@ -22,6 +22,7 @@ import org.apache.commons.lang3.math.NumberUtils; * A mutable {@code int} wrapper. * * Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter. + * * * @see Integer * @since 2.1 diff --git a/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java b/src/main/java/org/apache/commons/
[commons-lang] branch master updated: Javadoc: StringUtils.repeat("", "x", 3) = "xx"; #918
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new a588f7e69 Javadoc: StringUtils.repeat("", "x", 3) = "xx"; #918 a588f7e69 is described below commit a588f7e6936b26026c0e6c7eca1c47a252291abe Author: Gary Gregory AuthorDate: Tue Jul 5 08:45:29 2022 -0400 Javadoc: StringUtils.repeat("", "x", 3) = "xx"; #918 --- src/changes/changes.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 043ca295f..8e8a16353 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -87,6 +87,7 @@ The type attribute can be add,update,fix,remove. Rewrite Conversion.binaryBeMsb0ToHexDigit to invert logic of binaryToHexDigit. Allow extension of previously final classes ImmutablePair and ImmutableTriple. Update ClassUtils Javadoc with some missing throws NPE #912. +Javadoc: StringUtils.repeat("", "x", 3) = "xx"; #918. Add GitHub coverage.yml. Add EnumUtils.getEnumSystemProperty(...).
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new d5fb182cc Javadoc d5fb182cc is described below commit d5fb182cc1c99f7147db0d6045e01c83accb3580 Author: Gary Gregory AuthorDate: Tue May 31 11:08:59 2022 -0400 Javadoc --- .../org/apache/commons/lang3/ArrayUtilsTest.java | 24 -- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java index b89d85053..c44419d7a 100644 --- a/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/ArrayUtilsTest.java @@ -6287,8 +6287,7 @@ public class ArrayUtilsTest { (short) 999})); } -// testToPrimitive/Object for boolean -// --- +/** testToPrimitive/Object for boolean */ @Test public void testToPrimitive_boolean() { final Boolean[] b = null; @@ -6307,8 +6306,7 @@ public class ArrayUtilsTest { assertArrayEquals(new boolean[]{true, true, false}, ArrayUtils.toPrimitive(new Boolean[]{Boolean.TRUE, null, Boolean.FALSE}, true)); } -// testToPrimitive/Object for byte -// --- +/** testToPrimitive/Object for byte */ @Test public void testToPrimitive_byte() { final Byte[] b = null; @@ -6339,8 +6337,7 @@ public class ArrayUtilsTest { Byte.valueOf((byte) 999)}, Byte.MAX_VALUE)); } -// testToPrimitive/Object for byte -// --- +/** testToPrimitive/Object for byte */ @Test public void testToPrimitive_char() { final Character[] b = null; @@ -6371,8 +6368,7 @@ public class ArrayUtilsTest { Character.valueOf('0')}, Character.MAX_VALUE)); } -// testToPrimitive/Object for double -// --- +/** testToPrimitive/Object for double */ @Test public void testToPrimitive_double() { final Double[] b = null; @@ -6403,8 +6399,7 @@ public class ArrayUtilsTest { null, Double.valueOf(999)}, Double.MAX_VALUE)); } -// testToPrimitive/Object for float -// --- +/** testToPrimitive/Object for float */ @Test public void testToPrimitive_float() { final Float[] b = null; @@ -6435,8 +6430,7 @@ public class ArrayUtilsTest { null, Float.valueOf(999)}, Float.MAX_VALUE)); } -// testToPrimitive/Object for int -// --- +/** testToPrimitive/Object for int */ @Test public void testToPrimitive_int() { final Integer[] b = null; @@ -6467,8 +6461,7 @@ public class ArrayUtilsTest { assertNull(ArrayUtils.toPrimitive(iArray, Integer.MIN_VALUE)); } -// testToPrimitive/Object for long -// --- +/** testToPrimitive/Object for long */ @Test public void testToPrimitive_long() { final Long[] b = null; @@ -6499,8 +6492,7 @@ public class ArrayUtilsTest { null, Long.valueOf(999)}, Long.MAX_VALUE)); } -// testToPrimitive/Object for short -// --- +/** testToPrimitive/Object for short */ @Test public void testToPrimitive_short() { final Short[] b = null;
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9ffccd7ac Javadoc 9ffccd7ac is described below commit 9ffccd7ac3e5ee85dcef5fb8612e97589fcca91c Author: Gary Gregory AuthorDate: Tue May 31 11:09:28 2022 -0400 Javadoc --- src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java b/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java index 613ed48a6..ac9116b41 100644 --- a/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/StringEscapeUtilsTest.java @@ -172,9 +172,7 @@ public class StringEscapeUtilsTest { } -// HTML and XML -//-- - +/** HTML and XML */ private static final String[][] HTML_ESCAPES = { {"no escaping", "plain text", "plain text"}, {"no escaping", "plain text", "plain text"},
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9370617f2 Javadoc 9370617f2 is described below commit 9370617f27d39e4a115a276647c59dac4426 Author: Gary Gregory AuthorDate: Tue May 31 11:07:10 2022 -0400 Javadoc --- .../java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java index 4631ffa34..fc6c2f039 100644 --- a/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java +++ b/src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java @@ -76,7 +76,7 @@ public class DurationFormatUtilsTest { } } -// https://issues.apache.org/bugzilla/show_bug.cgi?id=38401 +/** https://issues.apache.org/bugzilla/show_bug.cgi?id=38401 */ @Test public void testBugzilla38401() { assertEqualDuration( "/00/30 16:00:00 000", new int[] { 2006, 0, 26, 18, 47, 34 },
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new d1b750eac Javadoc d1b750eac is described below commit d1b750eaca45c9e33ca3900c72541d86e2d92565 Author: Gary Gregory AuthorDate: Sat May 28 14:03:15 2022 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/builder/Diff.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 a7be8b0fa..a7b0c2735 100644 --- a/src/main/java/org/apache/commons/lang3/builder/Diff.java +++ b/src/main/java/org/apache/commons/lang3/builder/Diff.java @@ -67,7 +67,7 @@ public abstract class Diff extends Pair { /** * - * Returns the type of the field. + * Gets the type of the field. * * * @return the field type @@ -78,7 +78,7 @@ public abstract class Diff extends Pair { /** * - * Returns the name of the field. + * Gets the name of the field. * * * @return the field name
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 0d729dd Javadoc. 0d729dd is described below commit 0d729dd72923bd2825669c455e5b3d6dde115f65 Author: Gary Gregory AuthorDate: Sun Apr 3 11:07:45 2022 -0400 Javadoc. --- .../concurrent/AbstractConcurrentInitializerTest.java | 8 .../lang3/concurrent/AtomicSafeInitializerTest.java| 18 -- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java index 436d035..c88f29e 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/AbstractConcurrentInitializerTest.java @@ -38,7 +38,7 @@ public abstract class AbstractConcurrentInitializerTest { /** * Tests a simple invocation of the get() method. * - * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it + * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it. */ @Test public void testGet() throws ConcurrentException { @@ -49,7 +49,7 @@ public abstract class AbstractConcurrentInitializerTest { * Tests whether sequential get() invocations always return the same * instance. * - * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it + * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it. */ @Test public void testGetMultipleTimes() throws ConcurrentException { @@ -64,8 +64,8 @@ public abstract class AbstractConcurrentInitializerTest { * Tests whether get() can be invoked from multiple threads concurrently. * Always the same object should be returned. * - * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it - * @throws java.lang.InterruptedException because the threading API my throw it + * @throws org.apache.commons.lang3.concurrent.ConcurrentException because the object under test may throw it. + * @throws java.lang.InterruptedException because the threading API my throw it. */ @Test public void testGetConcurrent() throws ConcurrentException, diff --git a/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java b/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java index f2d8ddc..4aa6564 100644 --- a/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java +++ b/src/test/java/org/apache/commons/lang3/concurrent/AtomicSafeInitializerTest.java @@ -24,10 +24,9 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** - * Test class for {@code AtomicSafeInitializer}. + * Test class for {@code AtomicSafeInitializer} which also serves as a simple example. */ -public class AtomicSafeInitializerTest extends -AbstractConcurrentInitializerTest { +public class AtomicSafeInitializerTest extends AbstractConcurrentInitializerTest { /** The instance to be tested. */ private AtomicSafeInitializerTestImpl initializer; @@ -53,19 +52,18 @@ public class AtomicSafeInitializerTest extends * @throws java.lang.InterruptedException because {@link #testGetConcurrent()} may throw it */ @Test -public void testNumberOfInitializeInvocations() throws ConcurrentException, -InterruptedException { +public void testNumberOfInitializeInvocations() throws ConcurrentException, InterruptedException { testGetConcurrent(); assertEquals(1, initializer.initCounter.get(), "Wrong number of invocations"); } /** - * A concrete test implementation of {@code AtomicSafeInitializer}. This - * implementation also counts the number of invocations of the initialize() - * method. + * A concrete test implementation of {@code AtomicSafeInitializer} which also serves as a simple example. + * + * This implementation also counts the number of invocations of the initialize() method. + * */ -private static class AtomicSafeInitializerTestImpl extends -AtomicSafeInitializer { +private static class AtomicSafeInitializerTestImpl extends AtomicSafeInitializer { /** A counter for initialize() invocations. */ final AtomicInteger initCounter = new AtomicInteger();
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 9abbb06 Javadoc. 9abbb06 is described below commit 9abbb0637680db4d3ed92beaab169390a21dd418 Author: Gary Gregory AuthorDate: Sun Apr 3 10:54:34 2022 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/time/DateUtils.java | 1 + src/main/java/org/apache/commons/lang3/time/FastDateParser.java | 1 + src/main/java/org/apache/commons/lang3/time/FormatCache.java| 2 ++ 3 files changed, 4 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/time/DateUtils.java b/src/main/java/org/apache/commons/lang3/time/DateUtils.java index 57eed68..33c61dc 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DateUtils.java @@ -1769,6 +1769,7 @@ public class DateUtils { } /** + * @param date Date to validate. * @throws NullPointerException if {@code date == null} */ private static void validateDateNotNull(final Date date) { diff --git a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java index 679eabc..19b8824 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDateParser.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDateParser.java @@ -585,6 +585,7 @@ public class FastDateParser implements DateParser, Serializable { /** * Gets a Strategy given a field from a SimpleDateFormat pattern * @param f A sub-sequence of the SimpleDateFormat pattern + * @param width formatting width * @param definingCalendar The calendar to obtain the short and long values * @return The Strategy that will handle parsing for the field */ diff --git a/src/main/java/org/apache/commons/lang3/time/FormatCache.java b/src/main/java/org/apache/commons/lang3/time/FormatCache.java index 265ef18..92defb2 100644 --- a/src/main/java/org/apache/commons/lang3/time/FormatCache.java +++ b/src/main/java/org/apache/commons/lang3/time/FormatCache.java @@ -31,6 +31,8 @@ import org.apache.commons.lang3.Validate; /** * FormatCache is a cache and factory for {@link Format}s. * + * @param The Format type. + * * @since 3.0 */ // TODO: Before making public move from getDateTimeInstance(Integer, ...) to int; or some other approach.
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new efce331 Javadoc. efce331 is described below commit efce331acd5b9e061243229ade1c664b150292cf Author: Gary Gregory AuthorDate: Sun Apr 3 10:42:12 2022 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java index c836eda..0065158 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java @@ -675,6 +675,7 @@ public class FastDatePrinter implements DatePrinter, Serializable { * * @param buffer the buffer to append to. * @param value the value to append digits from. + * @throws IOException If an I/O error occurs */ private static void appendDigits(final Appendable buffer, final int value) throws IOException { buffer.append((char) (value / 10 + '0')); @@ -688,6 +689,8 @@ public class FastDatePrinter implements DatePrinter, Serializable { * * @param buffer the buffer to append to. * @param value the value to append digits from. + * @param minFieldWidth Minimum field width. + * @throws IOException If an I/O error occurs */ private static void appendFullDigits(final Appendable buffer, int value, int minFieldWidth) throws IOException { // specialized paths for 1 to 4 digits -> avoid the memory allocation from the temporary work array
[commons-lang] branch master updated: Javadoc
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 2252fad Javadoc 2252fad is described below commit 2252fade508663ca468f6a6455494a1d511934c5 Author: Gary Gregory AuthorDate: Mon Mar 21 11:41:38 2022 -0400 Javadoc --- src/main/java/org/apache/commons/lang3/concurrent/Computable.java | 6 +- 1 file changed, 5 insertions(+), 1 deletion(-) 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 a74d1b1..bd13cd9 100644 --- a/src/main/java/org/apache/commons/lang3/concurrent/Computable.java +++ b/src/main/java/org/apache/commons/lang3/concurrent/Computable.java @@ -16,14 +16,18 @@ */ package org.apache.commons.lang3.concurrent; +import org.apache.commons.lang3.function.FailableFunction; + /** * Definition of an interface for a wrapper around a calculation that takes a single parameter and returns a result. * * This interface allows for wrapping a calculation into a class so that it maybe passed around an application. + * + * See also {@code FailableFunction}. * * @param the type of the input to the calculation * @param the type of the output of the calculation - * + * @see FailableFunction * @since 3.6 */ public interface Computable {
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 08f374f Javadoc. 08f374f is described below commit 08f374f0d7185142e8065cfa0cca9e04fab74c4b Author: Gary Gregory AuthorDate: Thu Mar 10 12:40:37 2022 -0500 Javadoc. More formal constant definition. --- .../org/apache/commons/lang3/function/FailableConsumer.java | 11 --- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java b/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java index aa7a8de..1d1d534 100644 --- a/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java +++ b/src/main/java/org/apache/commons/lang3/function/FailableConsumer.java @@ -19,12 +19,17 @@ package org.apache.commons.lang3.function; import java.util.Objects; import java.util.function.Consumer; +import java.util.function.Function; /** * A functional interface like {@link Consumer} that declares a {@code Throwable}. * - * @param Consumed type 1. - * @param Thrown exception. + * + * This is a functional interface whose functional method is {@link #accept(Object)}. + * + * + * @param the type of the input to the operation + * @param Thrown exception type. * @since 3.11 */ @FunctionalInterface @@ -32,7 +37,7 @@ public interface FailableConsumer { /** NOP singleton */ @SuppressWarnings("rawtypes") -FailableConsumer NOP = t -> {/* NOP */}; +FailableConsumer NOP = Function.identity()::apply; /** * Returns The NOP singleton.
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 656d202 Javadoc. 656d202 is described below commit 656d2023dcd149018cd126e283f675b4ffef9715 Author: Gary Gregory AuthorDate: Sat Dec 4 10:41:38 2021 -0500 Javadoc. --- src/main/java/org/apache/commons/lang3/Streams.java | 10 ++ 1 file changed, 10 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/Streams.java b/src/main/java/org/apache/commons/lang3/Streams.java index 5c14901..d9227d3 100644 --- a/src/main/java/org/apache/commons/lang3/Streams.java +++ b/src/main/java/org/apache/commons/lang3/Streams.java @@ -86,12 +86,22 @@ public class Streams { this.stream = stream; } +/** + * Throws IllegalStateException if this stream is already terminated. + * + * @throws IllegalStateException if this stream is already terminated. + */ protected void assertNotTerminated() { if (terminated) { throw new IllegalStateException("This stream is already terminated."); } } +/** + * Marks this stream as terminated. + * + * @throws IllegalStateException if this stream is already terminated. + */ protected void makeTerminated() { assertNotTerminated(); terminated = true;
[commons-lang] branch master updated: Javadoc typo.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 6dc8492 Javadoc typo. 6dc8492 is described below commit 6dc8492caf5b1a99270ca845a28f9469006afc70 Author: Gary Gregory AuthorDate: Fri Nov 12 15:12:04 2021 -0500 Javadoc typo. --- .../java/org/apache/commons/lang3/exception/UncheckedException.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/exception/UncheckedException.java b/src/main/java/org/apache/commons/lang3/exception/UncheckedException.java index 66c2278..5fdd337 100644 --- a/src/main/java/org/apache/commons/lang3/exception/UncheckedException.java +++ b/src/main/java/org/apache/commons/lang3/exception/UncheckedException.java @@ -19,7 +19,7 @@ package org.apache.commons.lang3.exception; /** * Abstracts the concept of wrapping a checked exception as unchecked. * - * Subclasses should only be used to wrapped checked exception. + * Subclasses should only be used to wrap checked exception. * * * @since 3.13.0
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new b652c47 Javadoc. b652c47 is described below commit b652c477f65d0d96d9f14d2afc3fcad723d20291 Author: Gary Gregory AuthorDate: Tue Aug 31 15:24:31 2021 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 ecfdc37..7fa51ba 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/ConstructorUtils.java @@ -277,7 +277,7 @@ public class ConstructorUtils { } /** - * Learn whether the specified class is generally accessible, i.e. is + * Tests whether the specified class is generally accessible, i.e. is * declared in an entirely {@code public} manner. * @param type to check * @return {@code true} if {@code type} and any enclosing classes are
[commons-lang] branch master updated: Javadoc: Don't refer to package private method.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 8c153b8 Javadoc: Don't refer to package private method. 8c153b8 is described below commit 8c153b833353e815ba0912aeea47130238379e25 Author: Gary Gregory AuthorDate: Mon Aug 30 09:45:14 2021 -0400 Javadoc: Don't refer to package private method. --- src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java index a74d366..697ad74 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java @@ -395,7 +395,7 @@ public class FastDatePrinter implements DatePrinter, Serializable { /** * Formats a {@code Date}, {@code Calendar} or * {@code Long} (milliseconds) object. - * @deprecated Use {{@link #format(Date)}, {{@link #format(Calendar)}, {{@link #format(long)}, or {{@link #format(Object)} + * @deprecated Use {{@link #format(Date)}, {{@link #format(Calendar)}, {{@link #format(long)}. * @param obj the object to format * @param toAppendTo the buffer to append to * @param pos the position - ignored
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 682c932 Javadoc. 682c932 is described below commit 682c93254109d56939d9867c1541cb4dca3c634f Author: Gary Gregory AuthorDate: Tue Aug 24 11:46:52 2021 -0400 Javadoc. - The first sentence is automatically a paragraph. - Close HTML tags. - Remove whitespace. - Remove dead in-line comments. --- src/main/java/org/apache/commons/lang3/ArrayUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/ArrayUtils.java b/src/main/java/org/apache/commons/lang3/ArrayUtils.java index 8b9b182..8bb103a 100644 --- a/src/main/java/org/apache/commons/lang3/ArrayUtils.java +++ b/src/main/java/org/apache/commons/lang3/ArrayUtils.java @@ -6848,7 +6848,7 @@ public class ArrayUtils { } /** - * >Reverses the order of the given array. + * Reverses the order of the given array. * * This method does nothing for a {@code null} input array. *
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new b0d9979 Javadoc. b0d9979 is described below commit b0d9979fb6547651d37bda56e150e505c705d3d9 Author: Gary Gregory AuthorDate: Sat Jul 10 10:28:13 2021 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 1913a3b..37d6378 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -69,7 +69,7 @@ public class ExceptionUtils { static final String WRAPPED_MARKER = " [wrapped] "; /** - * Claims a Throwable is another Exception type using type erasure. This + * Claims a Throwable is another Throwable type using type erasure. This * hides a checked exception from the Java compiler, allowing a checked * exception to be thrown without having the exception in the method's throw * clause.
[commons-lang] branch master updated: Javadoc: Tagging the first sentence as a paragraph is redundant.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 46094be Javadoc: Tagging the first sentence as a paragraph is redundant. 46094be is described below commit 46094be47e240ef0f126eb36710e19dc745b3875 Author: Gary Gregory AuthorDate: Sat Jul 10 10:25:02 2021 -0400 Javadoc: Tagging the first sentence as a paragraph is redundant. - Use pre tags instead of code tags for in-line code examples. - Close HTML tags. - Use "Gets..." for most getters. --- .../commons/lang3/exception/ExceptionUtils.java| 120 +++-- 1 file changed, 62 insertions(+), 58 deletions(-) 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 e3dbd1f..0041341 100644 --- a/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java +++ b/src/main/java/org/apache/commons/lang3/exception/ExceptionUtils.java @@ -32,8 +32,8 @@ import org.apache.commons.lang3.ClassUtils; import org.apache.commons.lang3.StringUtils; /** - * Provides utilities for manipulating and examining - * {@code Throwable} objects. + * Provides utilities for manipulating and examining + * {@code Throwable} objects. * * @since 1.0 */ @@ -42,7 +42,7 @@ public class ExceptionUtils { private static final int NOT_FOUND = -1; /** - * The names of methods commonly used to access a wrapped exception. + * The names of methods commonly used to access a wrapped exception. */ // TODO: Remove in Lang 4.0 private static final String[] CAUSE_METHOD_NAMES = { @@ -61,15 +61,15 @@ public class ExceptionUtils { }; /** - * Used when printing stack frames to denote the start of a - * wrapped exception. + * Used when printing stack frames to denote the start of a + * wrapped exception. * * Package private for accessibility by test suite. */ static final String WRAPPED_MARKER = " [wrapped] "; /** - * Introspects the {@code Throwable} to obtain the cause. + * Introspects the {@code Throwable} to obtain the cause. * * The method searches for methods with specific names that return a * {@code Throwable} object. This will pick up most wrapping exceptions, @@ -101,7 +101,7 @@ public class ExceptionUtils { } /** - * Introspects the {@code Throwable} to obtain the cause. + * Introspects the {@code Throwable} to obtain the cause. * * A {@code null} set of method names means use the default set. * A {@code null} in the set of method names will be ignored. @@ -141,7 +141,7 @@ public class ExceptionUtils { } /** - * Finds a {@code Throwable} by method name. + * Gets a {@code Throwable} by method name. * * @param throwable the exception to examine * @param methodName the name of the method to find and invoke @@ -167,7 +167,7 @@ public class ExceptionUtils { } /** - * Returns the default names used when searching for the cause of an exception. + * Gets the default names used when searching for the cause of an exception. * * This may be modified and used in the overloaded getCause(Throwable, String[]) method. * @@ -185,6 +185,7 @@ public class ExceptionUtils { * * The message returned is of the form * {ClassNameWithoutPackage}: {ThrowableMessage} + * * * @param th the throwable to get a message for, null returns empty string * @return the message, non-null @@ -200,7 +201,7 @@ public class ExceptionUtils { } /** - * Introspects the {@code Throwable} to obtain the root cause. + * Introspects the {@code Throwable} to obtain the root cause. * * This method walks through the exception chain to the last element, * "root" of the tree, using {@link Throwable#getCause()}, and @@ -226,6 +227,7 @@ public class ExceptionUtils { * * The message returned is of the form * {ClassNameWithoutPackage}: {ThrowableMessage} + * * * @param th the throwable to get a message for, null returns empty string * @return the message, non-null @@ -238,8 +240,8 @@ public class ExceptionUtils { } /** - * Creates a compact stack trace for the root cause of the supplied - * {@code Throwable}. + * Gets a compact stack trace for the root cause of the supplied + * {@code Throwable}. * * The output of this method is consistent across JDK versions. * It consists of the root exception followed by each of its wrapping @@ -275,9 +277,9 @@ public class ExceptionUtils { } /** - * Produces a {@code List} of stack frames - the message + * Gets a {@code List} of stack
[commons-lang] branch master updated: Javadoc: Sentences end in a period.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 6b03fe5 Javadoc: Sentences end in a period. 6b03fe5 is described below commit 6b03fe54b8a434435bea6127048d380e414404b8 Author: Gary Gregory AuthorDate: Fri Jan 22 13:41:06 2021 -0500 Javadoc: Sentences end in a period. --- src/main/java/org/apache/commons/lang3/ObjectUtils.java | 2 +- src/main/java/org/apache/commons/lang3/text/StrBuilder.java | 2 +- src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index c6c6a8e..8461ee9 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -803,7 +803,7 @@ public class ObjectUtils { * * @param appendable the appendable to append to * @param object the object to create a toString for - * @throws IOException if an I/O error occurs + * @throws IOException if an I/O error occurs. * @since 3.2 */ public static void identityToString(final Appendable appendable, final Object object) throws IOException { 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 9bf72ed..d9ec85f 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java +++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java @@ -445,7 +445,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * * @param readable object to read from * @return the number of characters read - * @throws IOException if an I/O error occurs + * @throws IOException if an I/O error occurs. * * @since 3.4 * @see #appendTo(Appendable) diff --git a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java index 9778abc..9f0e675 100644 --- a/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java +++ b/src/main/java/org/apache/commons/lang3/time/FastDatePrinter.java @@ -778,7 +778,7 @@ public class FastDatePrinter implements DatePrinter, Serializable { * * @param buf the output buffer * @param calendar calendar to be appended - * @throws IOException if an I/O error occurs + * @throws IOException if an I/O error occurs. */ void appendTo(Appendable buf, Calendar calendar) throws IOException; } @@ -792,7 +792,7 @@ public class FastDatePrinter implements DatePrinter, Serializable { * * @param buffer the output buffer * @param value the value to be appended - * @throws IOException if an I/O error occurs + * @throws IOException if an I/O error occurs. */ void appendTo(Appendable buffer, int value) throws IOException; }
[commons-lang] branch master updated: Javadoc to make is easier to use your IDE to jump to the method.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 5157875 Javadoc to make is easier to use your IDE to jump to the method. 5157875 is described below commit 5157875ce504d4b3c4d14bf5972a1dfb785f19bf Author: Gary Gregory AuthorDate: Tue Dec 29 11:41:49 2020 -0500 Javadoc to make is easier to use your IDE to jump to the method. --- .../java/org/apache/commons/lang3/time/Java15BugFastDateParserTest.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/test/java/org/apache/commons/lang3/time/Java15BugFastDateParserTest.java b/src/test/java/org/apache/commons/lang3/time/Java15BugFastDateParserTest.java index 4bc3315..265ca00 100644 --- a/src/test/java/org/apache/commons/lang3/time/Java15BugFastDateParserTest.java +++ b/src/test/java/org/apache/commons/lang3/time/Java15BugFastDateParserTest.java @@ -38,6 +38,7 @@ import org.junit.jupiter.params.provider.MethodSource; */ public class Java15BugFastDateParserTest { +/** @see org.apache.commons.lang3.time.FastDateParserTest#dateParserParameters() */ private static final String DATE_PARSER_PARAMETERS = "org.apache.commons.lang3.time.FastDateParserTest#dateParserParameters()"; @Test
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new dc54284 Javadoc. dc54284 is described below commit dc54284ee75435773dc37022d3759c582743c189 Author: Gary Gregory AuthorDate: Wed Jun 24 08:44:16 2020 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/text/StrLookup.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 f10aa73..7558c0b 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrLookup.java +++ b/src/main/java/org/apache/commons/lang3/text/StrLookup.java @@ -29,8 +29,9 @@ import java.util.Map; * If these do not suffice, you can subclass and implement your own matcher. * * For example, it would be possible to implement a lookup that used the - * key as a primary key, and looked up the value on demand from the database + * key as a primary key, and looked up the value on demand from the database. * + * @param Unused. * @since 2.2 * @deprecated as of 3.6, use commons-text * https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/StringLookupFactory.html";>
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 6315e8c Javadoc. 6315e8c is described below commit 6315e8c138d2b23427e77271bfad2359432a570b Author: Gary Gregory AuthorDate: Tue Jun 23 14:22:46 2020 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java index e6d4b92..da3011d 100644 --- a/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java +++ b/src/main/java/org/apache/commons/lang3/tuple/ImmutablePair.java @@ -76,6 +76,7 @@ public final class ImmutablePair extends Pair { * obtain the generic types. * * @param the left element type + * @param the right element type * @param left the left element, may be null * @return a pair formed from the two parameters, not null * @since 3.11 @@ -143,6 +144,7 @@ public final class ImmutablePair extends Pair { * This factory allows the pair to be created using inference to * obtain the generic types. * + * @param the left element type * @param the right element type * @param right the right element, may be null * @return a pair formed from the two parameters, not null
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new e22a5ea Javadoc. e22a5ea is described below commit e22a5ea87addb8d786925a46d74d8dfb2a6c41d2 Author: Gary Gregory AuthorDate: Wed Jun 17 17:13:40 2020 -0400 Javadoc. --- .../java/org/apache/commons/lang3/Functions.java| 21 +++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java index 626928c..7c9ec3d 100644 --- a/src/main/java/org/apache/commons/lang3/Functions.java +++ b/src/main/java/org/apache/commons/lang3/Functions.java @@ -31,8 +31,6 @@ import java.util.function.Predicate; import java.util.function.Supplier; import java.util.stream.Stream; -import org.apache.commons.lang3.Streams.FailableStream; -import org.apache.commons.lang3.function.Failable; import org.apache.commons.lang3.function.FailableBooleanSupplier; import org.apache.commons.lang3.function.FailableDoubleBinaryOperator; import org.apache.commons.lang3.function.FailableDoubleConsumer; @@ -41,6 +39,7 @@ import org.apache.commons.lang3.function.FailableIntConsumer; import org.apache.commons.lang3.function.FailableIntSupplier; import org.apache.commons.lang3.function.FailableLongConsumer; import org.apache.commons.lang3.function.FailableLongSupplier; +import org.apache.commons.lang3.stream.Streams.FailableStream; /** * This class provides utility functions, and classes for working with the {@code java.util.function} package, or more @@ -87,7 +86,9 @@ public class Functions { * @param Consumed type 1. * @param Consumed type 2. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableBiConsumer}. */ +@Deprecated @FunctionalInterface public interface FailableBiConsumer { @@ -110,7 +111,9 @@ public class Functions { * @param Input type 2. * @param Return type. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableBiFunction}. */ +@Deprecated @FunctionalInterface public interface FailableBiFunction { @@ -133,7 +136,9 @@ public class Functions { * @param Predicate type 1. * @param Predicate type 2. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableBiPredicate}. */ +@Deprecated @FunctionalInterface public interface FailableBiPredicate { @@ -155,7 +160,9 @@ public class Functions { * * @param Return type. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableCallable}. */ +@Deprecated @FunctionalInterface public interface FailableCallable { @@ -175,7 +182,9 @@ public class Functions { * * @param Consumed type 1. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableConsumer}. */ +@Deprecated @FunctionalInterface public interface FailableConsumer { @@ -196,7 +205,9 @@ public class Functions { * @param Input type 1. * @param Return type. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableFunction}. */ +@Deprecated @FunctionalInterface public interface FailableFunction { @@ -217,7 +228,9 @@ public class Functions { * * @param Predicate type 1. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailablePredicate}. */ +@Deprecated @FunctionalInterface public interface FailablePredicate { @@ -237,7 +250,9 @@ public class Functions { * TODO for 4.0: Move to org.apache.commons.lang3.function. * * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableRunnable}. */ +@Deprecated @FunctionalInterface public interface FailableRunnable { @@ -256,7 +271,9 @@ public class Functions { * * @param Return type. * @param Thrown exception. + * @deprecated Use {@link org.apache.commons.lang3.function.FailableSupplier}. */ +@Deprecated @FunctionalInterface public interface FailableSupplier {
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 598e8bd Javadoc. 598e8bd is described below commit 598e8bd51e1e900d58b9ce21f2c806da447888fb Author: Gary Gregory AuthorDate: Wed Jun 10 09:07:59 2020 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/Functions.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java index 4f580b7..2029b2e 100644 --- a/src/main/java/org/apache/commons/lang3/Functions.java +++ b/src/main/java/org/apache/commons/lang3/Functions.java @@ -103,7 +103,7 @@ public class Functions { @FunctionalInterface public interface FailableFunction { /** - * Apply the function. + * Applies this function. * @param input the input for the function * @return the result of the function * @throws T if the function fails @@ -114,7 +114,7 @@ public class Functions { @FunctionalInterface public interface FailableBiFunction { /** - * Apply the function. + * Applies this function. * @param input1 the first input for the function * @param input2 the second input for the function * @return the result of the function
[commons-lang] branch master updated: (Javadoc) Fix return tag for throwableOf*() methods #518.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 7c754d9 (Javadoc) Fix return tag for throwableOf*() methods #518. 7c754d9 is described below commit 7c754d9c1e96c2a3e90e4bf632b421a43f235e22 Author: Gary Gregory AuthorDate: Mon Apr 20 17:10:42 2020 -0400 (Javadoc) Fix return tag for throwableOf*() methods #518. --- src/changes/changes.xml | 11 ++- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/changes/changes.xml b/src/changes/changes.xml index befdbf4..d7a9336 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -49,11 +49,12 @@ The type attribute can be add,update,fix,remove. Fix Javdoc for StringUtils.appendIfMissingIgnoreCase() #507. org.junit-pioneer:junit-pioneer 0.5.4 -> 0.5.6. org.junit.jupiter:junit-jupiter 5.6.0 -> 5.6.1. -Simplify null checks in Pair.hashCode() using Objects.hashCode(). #517. -Simplify null checks in Triple.hashCode() using Objects.hashCode(). #516. -Simplify some if statements in StringUtils. #521. -Simplify a null check in the private replaceEach() method of StringUtils. #514. -Replace some usages of the ternary operator with calls to Math.max() and Math.min() #512. +Simplify null checks in Pair.hashCode() using Objects.hashCode(). #517. +Simplify null checks in Triple.hashCode() using Objects.hashCode(). #516. +Simplify some if statements in StringUtils. #521. +Simplify a null check in the private replaceEach() method of StringUtils. #514. +Replace some usages of the ternary operator with calls to Math.max() and Math.min() #512. +(Javadoc) Fix return tag for throwableOf*() methods #518.
[commons-lang] branch master updated: Javadoc tweaks.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 0f119ef Javadoc tweaks. 0f119ef is described below commit 0f119ef2a6ab2ac56cdcfd2b73858bdc4f216a85 Author: Gary Gregory AuthorDate: Sat Feb 22 09:21:57 2020 -0500 Javadoc tweaks. --- src/main/java/org/apache/commons/lang3/CharUtils.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharUtils.java b/src/main/java/org/apache/commons/lang3/CharUtils.java index 3c8ad3e..be0aea4 100644 --- a/src/main/java/org/apache/commons/lang3/CharUtils.java +++ b/src/main/java/org/apache/commons/lang3/CharUtils.java @@ -33,7 +33,7 @@ public class CharUtils { private static final char[] HEX_DIGITS = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'}; /** - * {@code \u000a} linefeed LF ('\n'). + * Linefeed character LF ({@code '\n'}, Unicode 000a). * * @see http://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.10.6";>JLF: Escape Sequences * for Character and String Literals @@ -42,7 +42,7 @@ public class CharUtils { public static final char LF = '\n'; /** - * {@code \u000d} carriage return CR ('\r'). + * Carriage return characterf CR ('\r', Unicode 000d). * * @see http://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.10.6";>JLF: Escape Sequences * for Character and String Literals
[commons-lang] branch master updated: JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490)
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 80839be JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490) 80839be is described below commit 80839be4577e298335a1d3887518bf1ef4455f64 Author: Peter Verhas AuthorDate: Mon Feb 17 15:58:19 2020 +0100 JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490) --- .../java/org/apache/commons/lang3/Functions.java | 24 +++--- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java index 91b4c9a..e7808ac 100644 --- a/src/main/java/org/apache/commons/lang3/Functions.java +++ b/src/main/java/org/apache/commons/lang3/Functions.java @@ -40,21 +40,21 @@ import org.apache.commons.lang3.Streams.FailableStream; * More specifically, it attempts to address the fact that lambdas are supposed * not to throw Exceptions, at least not checked Exceptions, aka instances of * {@link Exception}. This enforces the use of constructs like - * - * Consumerconsumer = (m) -> { + * {@code + * Consumer consumer = (m) -> { * try { * m.invoke(o, args); * } catch (Throwable t) { * throw Functions.rethrow(t); * } * }; - * + * } * By replacing a {@link java.util.function.Consumer Consumer } with a * {@link FailableConsumer FailableConsumer }, this can be * written like follows: - * - * Functions.accept((m) -> m.invoke(o,args)); - * + * {@code + * Functions.accept((m) -> m.invoke(o,args)); + * } * Obviously, the second version is much more concise and the spirit of * Lambda expressions is met better than the second version. */ @@ -446,10 +446,10 @@ public class Functions { * and regardless of success, or failure. If either the original action, or * any of the resource action fails, then the first failure (aka * {@link Throwable} is rethrown. Example use: - * + * {@code * final FileInputStream fis = new FileInputStream("my.file"); - * Functions.tryWithResources(useInputStream(fis), null, () -> fis.close()); - * + * Functions.tryWithResources(useInputStream(fis), null, () -> fis.close()); + * } * @param pAction The action to execute. This object will always * be invoked. * @param pErrorHandler An optional error handler, which will be invoked finally, @@ -509,10 +509,10 @@ public class Functions { * and regardless of success, or failure. If either the original action, or * any of the resource action fails, then the first failure (aka * {@link Throwable} is rethrown. Example use: - * + * {@code * final FileInputStream fis = new FileInputStream("my.file"); - * Functions.tryWithResources(useInputStream(fis), () -> fis.close()); - * + * Functions.tryWithResources(useInputStream(fis), () -> fis.close()); + * } * @param pAction The action to execute. This object will always * be invoked. * @param pResources The resource actions to execute. All resource
[commons-lang] branch master updated: Javadoc style.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new d54c895 Javadoc style. d54c895 is described below commit d54c8951d64bfaa7b85dc45dda5406ed05f9b07f Author: Gary Gregory AuthorDate: Fri Feb 14 10:00:33 2020 -0500 Javadoc style. --- .../java/org/apache/commons/lang3/CharRange.java | 8 .../java/org/apache/commons/lang3/ThreadUtils.java | 20 ++-- .../commons/lang3/builder/HashCodeBuilder.java | 2 +- .../lang3/concurrent/AtomicSafeInitializer.java | 2 +- .../commons/lang3/event/EventListenerSupport.java| 2 +- .../apache/commons/lang3/reflect/MethodUtils.java| 2 +- .../org/apache/commons/lang3/reflect/TypeUtils.java | 6 +++--- .../commons/lang3/text/ExtendedMessageFormat.java| 2 +- .../apache/commons/lang3/text/FormattableUtils.java | 2 +- .../org/apache/commons/lang3/time/DateUtils.java | 2 +- .../apache/commons/lang3/time/FastDateParser.java| 16 11 files changed, 32 insertions(+), 32 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharRange.java b/src/main/java/org/apache/commons/lang3/CharRange.java index 6a416bb..be656d2 100644 --- a/src/main/java/org/apache/commons/lang3/CharRange.java +++ b/src/main/java/org/apache/commons/lang3/CharRange.java @@ -271,7 +271,7 @@ final class CharRange implements Iterable, Serializable { private boolean hasNext; /** - * Construct a new iterator for the character range. + * Constructs a new iterator for the character range. * * @param r The character range */ @@ -296,7 +296,7 @@ final class CharRange implements Iterable, Serializable { } /** - * Prepare the next character in the range. + * Prepares the next character in the range. */ private void prepareNext() { if (range.negated) { @@ -329,7 +329,7 @@ final class CharRange implements Iterable, Serializable { } /** - * Return the next character in the iteration + * Returns the next character in the iteration * * @return {@code Character} for the next character */ @@ -346,7 +346,7 @@ final class CharRange implements Iterable, Serializable { /** * Always throws UnsupportedOperationException. * - * @throws UnsupportedOperationException + * @throws UnsupportedOperationException Always thrown. * @see java.util.Iterator#remove() */ @Override diff --git a/src/main/java/org/apache/commons/lang3/ThreadUtils.java b/src/main/java/org/apache/commons/lang3/ThreadUtils.java index 16986e0..5534194 100644 --- a/src/main/java/org/apache/commons/lang3/ThreadUtils.java +++ b/src/main/java/org/apache/commons/lang3/ThreadUtils.java @@ -36,7 +36,7 @@ import java.util.List; public class ThreadUtils { /** - * Return the active thread with the specified id if it belongs to the specified thread group. + * Finds the active thread with the specified id if it belongs to the specified thread group. * * @param threadId The thread id * @param threadGroup The thread group @@ -59,7 +59,7 @@ public class ThreadUtils { } /** - * Return the active thread with the specified id if it belongs to a thread group with the specified group name. + * Finds the active thread with the specified id if it belongs to a thread group with the specified group name. * * @param threadId The thread id * @param threadGroupName The thread group name @@ -82,7 +82,7 @@ public class ThreadUtils { } /** - * Return active threads with the specified name if they belong to a specified thread group. + * Finds active threads with the specified name if they belong to a specified thread group. * * @param threadName The thread name * @param threadGroup The thread group @@ -100,7 +100,7 @@ public class ThreadUtils { } /** - * Return active threads with the specified name if they belong to a thread group with the specified group name. + * Finds active threads with the specified name if they belong to a thread group with the specified group name. * * @param threadName The thread name * @param threadGroupName The thread group name @@ -132,7 +132,7 @@ public class ThreadUtils { } /** - * Return active thread groups with the specified group name. + * 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 unm
[commons-lang] branch master updated: - Javadoc. - Don't use 'p' as a parameter name prefix (we don't do that anywhere else.)
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 05588e4 - Javadoc. - Don't use 'p' as a parameter name prefix (we don't do that anywhere else.) 05588e4 is described below commit 05588e4ebb03fb0c9c5f908d7bae049849565afb Author: Gary Gregory AuthorDate: Fri Feb 14 09:50:53 2020 -0500 - Javadoc. - Don't use 'p' as a parameter name prefix (we don't do that anywhere else.) --- .../java/org/apache/commons/lang3/Streams.java | 93 -- .../commons/lang3/compare/ComparableUtils.java | 2 + 2 files changed, 53 insertions(+), 42 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/Streams.java b/src/main/java/org/apache/commons/lang3/Streams.java index 9510c58..f89cf16 100644 --- a/src/main/java/org/apache/commons/lang3/Streams.java +++ b/src/main/java/org/apache/commons/lang3/Streams.java @@ -32,10 +32,10 @@ import org.apache.commons.lang3.Functions.FailableFunction; import org.apache.commons.lang3.Functions.FailablePredicate; /** - * This class provides utility functions, and classes for working with the - * java.util.stream package, or more generally, with Java 8 lambdas. More + * Provides utility functions, and classes for working with the + * {@code java.util.stream} package, or more generally, with Java 8 lambdas. More * specifically, it attempts to address the fact that lambdas are supposed - * not to throw Exceptions, at least not checked Exceptions, aka instances + * not to throw Exceptions, at least not checked Exceptions, AKA instances * of {@link Exception}. This enforces the use of constructs like * * Consumerconsumer = (m) -> { @@ -53,20 +53,29 @@ import org.apache.commons.lang3.Functions.FailablePredicate; * * Obviously, the second version is much more concise and the spirit of * Lambda expressions is met better than in the first version. + * * @see Stream * @see Functions + * @since 3.10 */ public class Streams { - /** A reduced, and simplified version of a {@link Stream} with - * failable method signatures. - * @param The streams element type. - */ + + /** +* A reduced, and simplified version of a {@link Stream} with +* failable method signatures. +* @param The streams element type. +*/ public static class FailableStream { + private Stream stream; private boolean terminated; -public FailableStream(final Stream pStream) { -stream = pStream; +/** + * Constructs a new instance with the given {@code stream}. + * @param stream The stream. + */ +public FailableStream(final Stream stream) { +this.stream = stream; } protected void assertNotTerminated() { @@ -86,13 +95,13 @@ public class Streams { * * This is an intermediate operation. * - * @param pPredicate a non-interfering, stateless predicate to apply to each + * @param predicate a non-interfering, stateless predicate to apply to each * element to determine if it should be included. * @return the new stream */ -public FailableStream filter(final FailablePredicate pPredicate){ +public FailableStream filter(final FailablePredicate predicate){ assertNotTerminated(); -stream = stream.filter(Functions.asPredicate(pPredicate)); +stream = stream.filter(Functions.asPredicate(predicate)); return this; } @@ -109,11 +118,11 @@ public class Streams { * library chooses. If the action accesses shared state, it is * responsible for providing the required synchronization. * - * @param pAction a non-interfering action to perform on the elements + * @param action a non-interfering action to perform on the elements */ -public void forEach(final FailableConsumer pAction) { +public void forEach(final FailableConsumer action) { makeTerminated(); -stream().forEach(Functions.asConsumer(pAction)); +stream().forEach(Functions.asConsumer(action)); } /** @@ -159,14 +168,14 @@ public class Streams { * * @param the type of the result * @param the intermediate accumulation type of the {@code Collector} - * @param pCollector the {@code Collector} describing the reduction + * @param collector the {@code Collector} describing the reduction * @return the result of the reduction * @see #collect(Supplier, BiConsumer, BiConsumer) * @see Collectors */ -public R collect(final Collector pCollector) { +public R collect(final Collector c
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new c8289bf Javadoc. c8289bf is described below commit c8289bfcc9200ccf832a716cb3f34689c6bc8d83 Author: Gary Gregory AuthorDate: Mon Dec 30 13:41:54 2019 -0500 Javadoc. --- .../org/apache/commons/lang3/time/StopWatch.java | 59 ++ 1 file changed, 26 insertions(+), 33 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/time/StopWatch.java b/src/main/java/org/apache/commons/lang3/time/StopWatch.java index 58f09ad..876b2ed 100644 --- a/src/main/java/org/apache/commons/lang3/time/StopWatch.java +++ b/src/main/java/org/apache/commons/lang3/time/StopWatch.java @@ -131,30 +131,26 @@ public class StopWatch { /** * - * The method is used to find out if the StopWatch is started. A suspended - * StopWatch is also started watch. + * Returns whether the StopWatch is started. A suspended StopWatch is also started watch. * - - * @return boolean - * If the StopWatch is started. + * + * @return boolean If the StopWatch is started. */ abstract boolean isStarted(); /** * - * This method is used to find out whether the StopWatch is stopped. The - * stopwatch which's not yet started and explicitly stopped stopwatch is + * Returns whether the StopWatch is stopped. The stopwatch which's not yet started and explicitly stopped stopwatch is * considered as stopped. * * - * @return boolean - * If the StopWatch is stopped. + * @return boolean If the StopWatch is stopped. */ abstract boolean isStopped(); /** * - * This method is used to find out whether the StopWatch is suspended. + * Returns whether the StopWatch is suspended. * * * @return boolean @@ -166,7 +162,7 @@ public class StopWatch { private static final long NANO_2_MILLIS = 100L; /** - * Provides a started stopwatch for convenience. + * Creates a started stopwatch for convenience. * * @return StopWatch a stopwatch that's already been started. * @@ -177,6 +173,7 @@ public class StopWatch { sw.start(); return sw; } + /** * The current running state of the StopWatch. */ @@ -215,7 +212,7 @@ public class StopWatch { /** * - * Get the time on the stopwatch in nanoseconds. + * Gets the time on the stopwatch in nanoseconds. * * * @@ -240,7 +237,7 @@ public class StopWatch { /** * - * Get the split time on the stopwatch in nanoseconds. + * Gets the split time on the stopwatch in nanoseconds. * * * @@ -262,7 +259,7 @@ public class StopWatch { /** * - * Get the split time on the stopwatch. + * Gets the split time on the stopwatch. * * * @@ -280,7 +277,7 @@ public class StopWatch { } /** - * Returns the time this stopwatch was started. + * Gets the time this stopwatch was started. * * @return the time this stopwatch was started * @throws IllegalStateException @@ -297,7 +294,7 @@ public class StopWatch { /** * - * Get the time on the stopwatch. + * Gets the time on the stopwatch. * * * @@ -313,7 +310,7 @@ public class StopWatch { /** * - * Get the time on the stopwatch in the specified TimeUnit. + * Gets the time on the stopwatch in the specified TimeUnit. * * * @@ -333,12 +330,10 @@ public class StopWatch { /** * - * The method is used to find out if the StopWatch is started. A suspended - * StopWatch is also started watch. + * Returns whether the StopWatch is started. A suspended StopWatch is also started watch. * * - * @return boolean - * If the StopWatch is started. + * @return boolean If the StopWatch is started. * @since 3.2 */ public boolean isStarted() { @@ -347,13 +342,11 @@ public class StopWatch { /** * - * This method is used to find out whether the StopWatch is stopped. The - * stopwatch which's not yet started and explicitly stopped stopwatch is - * considered as stopped. + * Returns whether StopWatch is stopped. The stopwatch which's not yet started and explicitly stopped stopwatch is considered + * as stopped. * * - * @return boolean - * If the StopWatch is stopped. + * @return boolean If the StopWatch is stopped. * @since 3.2 */ public boolean isStopped() { @@ -362
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new 29723e8 Javadoc. 29723e8 is described below commit 29723e851ca56aa621165130049e588980c5a5e7 Author: Gary Gregory AuthorDate: Fri Sep 13 17:25:30 2019 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 08fcdc2..989155b 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java @@ -714,7 +714,7 @@ public class FieldUtils { *match {@code public} fields. * @throws IllegalArgumentException * if the field is {@code null} - * @deprecated As of java 12.0, we can no longer drop the final modifier, thus + * @deprecated As of Java 12, we can no longer drop the final modifier, thus * rendering this method obsolete. The JDK discussion about this change can be found * here: http://mail.openjdk.java.net/pipermail/core-libs-dev/2018-November/056486.html * @since 3.3
[commons-lang] branch master updated: Javadoc.
This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-lang.git The following commit(s) were added to refs/heads/master by this push: new a3aa116 Javadoc. a3aa116 is described below commit a3aa116d35f7cd7f412a51aca83d0d870200e703 Author: Gary Gregory AuthorDate: Wed Sep 11 10:21:23 2019 -0400 Javadoc. --- src/main/java/org/apache/commons/lang3/Range.java | 13 - 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java index 449be0c..e578701 100644 --- a/src/main/java/org/apache/commons/lang3/Range.java +++ b/src/main/java/org/apache/commons/lang3/Range.java @@ -457,7 +457,18 @@ public final class Range implements Serializable { * Fits the given element into this range by returning the given element or, if out of bounds, the range minimum if * below, or the range maximum if above. * - * + * + * Range range = Range.between(16, 64); + * range.fit(-9) --> 16 + * range.fit(0) --> 16 + * range.fit(15) --> 16 + * range.fit(16) --> 16 + * range.fit(17) --> 17 + * ... + * range.fit(63) --> 63 + * range.fit(64) --> 64 + * range.fit(99) --> 64 + * * @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 * @since 3.10