From e5e54fa003d0ee45384a6191b7f9cdf5bab6debb Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sun, 17 Dec 2023 14:38:39 -0500 Subject: [PATCH] Javadoc --- .../org/apache/commons/lang3/builder/HashCodeBuilder.java | 2 +- .../lang3/concurrent/CallableBackgroundInitializer.java | 2 +- .../apache/commons/lang3/concurrent/TimedSemaphore.java | 2 +- .../org/apache/commons/lang3/reflect/TypeLiteral.java | 4 ++-- .../java/org/apache/commons/lang3/stream/Streams.java | 2 +- .../org/apache/commons/lang3/stream/package-info.java | 2 +- .../apache/commons/lang3/text/ExtendedMessageFormat.java | 8 ++++---- .../java/org/apache/commons/lang3/text/FormatFactory.java | 2 +- .../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; * 

  * List<String> listOfString = 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<String> listOfString = (List<String>) typesafe.obtain(listOfStringType, ...); // nongeneric Type would necessitate a cast
@@ -57,7 +57,7 @@ import org.apache.commons.lang3.Validate;
  * List<String> listOfString = typesafe.obtain(new TypeLiteral<List<String>>() {}, ...);
  *
*

- * 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} * to a type variable while simultaneously making it short work to obtain a * {@link Type} instance for any given type, inline. *

diff --git a/src/main/java/org/apache/commons/lang3/stream/Streams.java b/src/main/java/org/apache/commons/lang3/stream/Streams.java index aa783eb8f..b640c02e3 100644 --- a/src/main/java/org/apache/commons/lang3/stream/Streams.java +++ b/src/main/java/org/apache/commons/lang3/stream/Streams.java @@ -45,7 +45,7 @@ import org.apache.commons.lang3.function.FailableFunction; import org.apache.commons.lang3.function.FailablePredicate; /** - * Provides utility functions, and classes for working with the {@code java.util.stream} package, or more generally, + * Provides utility functions, and classes for working with the {@link java.util.stream} package, or more generally, * with Java 8 lambdas. More specifically, it attempts to address the fact that lambdas are supposed not to throw * Exceptions, at least not checked Exceptions, AKA instances of {@link Exception}. This enforces the use of constructs * like: diff --git a/src/main/java/org/apache/commons/lang3/stream/package-info.java b/src/main/java/org/apache/commons/lang3/stream/package-info.java index b2deefcfb..0648fd258 100644 --- a/src/main/java/org/apache/commons/lang3/stream/package-info.java +++ b/src/main/java/org/apache/commons/lang3/stream/package-info.java @@ -15,7 +15,7 @@ * limitations under the License. */ /** - * Provides utility classes to complement those in {@code java.util.stream}. + * Provides utility classes to complement those in {@link java.util.stream}. * *

Contains utilities to allow streaming of failable functional interfaces from the * {@code org.apache.commons.lang3.functions} package allowing streaming of functional expressions diff --git a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java index ff4e77888..4b47f28fd 100644 --- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java +++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java @@ -30,12 +30,12 @@ import org.apache.commons.lang3.ObjectUtils; import org.apache.commons.lang3.Validate; /** - * Extends {@code java.text.MessageFormat} to allow pluggable/additional formatting + * Extends {@link java.text.MessageFormat} to allow pluggable/additional formatting * options for embedded format elements. Client code should specify a registry * of {@link FormatFactory} instances associated with {@link String} * format names. This registry will be consulted when the format elements are * parsed from the message pattern. In this way custom patterns can be specified, - * and the formats supported by {@code java.text.MessageFormat} can be overridden + * and the formats supported by {@link java.text.MessageFormat} can be overridden * at the format and/or format style level (see MessageFormat). A "format element" * embedded in the message pattern is specified (()? signifies optionality):
* {argument-number({@code ,}format-name @@ -43,7 +43,7 @@ import org.apache.commons.lang3.Validate; * *

* format-name and format-style values are trimmed of surrounding whitespace - * in the manner of {@code java.text.MessageFormat}. If format-name denotes + * in the manner of {@link java.text.MessageFormat}. If format-name denotes * {@code FormatFactory formatFactoryInstance} in {@code registry}, a {@link Format} * matching format-name and format-style is requested from * {@code formatFactoryInstance}. If this is successful, the {@link Format} @@ -56,7 +56,7 @@ import org.apache.commons.lang3.Validate; * {@link UnsupportedOperationException} if called. *

* - *

Limitations inherited from {@code java.text.MessageFormat}:

+ *

Limitations inherited from {@link java.text.MessageFormat}:

*
    *
  • When using "choice" subformats, support for nested formatting instructions is limited * to that provided by the base class.
    • diff --git a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java index ed5e8c3e6..f2c0d444a 100644 --- a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java +++ b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java @@ -36,7 +36,7 @@ public interface FormatFactory { * @param name The format type name * @param arguments Arguments used to create the format instance. This allows the * {@link FormatFactory} to implement the "format style" - * concept from {@code java.text.MessageFormat}. + * concept from {@link java.text.MessageFormat}. * @param locale The locale, may be null * @return The format instance */ diff --git a/src/main/java/org/apache/commons/lang3/time/DateParser.java b/src/main/java/org/apache/commons/lang3/time/DateParser.java index 01af551ee..596c10227 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateParser.java +++ b/src/main/java/org/apache/commons/lang3/time/DateParser.java @@ -106,7 +106,7 @@ public interface DateParser { * Parses text from a string to produce a Date. * * @param source A {@link String} whose beginning should be parsed. - * @return a {@code java.util.Date} object + * @return a {@link java.util.Date} object * @throws ParseException if the beginning of the specified string cannot be parsed. * @see java.text.DateFormat#parseObject(String) */ @@ -117,7 +117,7 @@ public interface DateParser { * * @param source A {@link String} whose beginning should be parsed. * @param pos the parse position - * @return a {@code java.util.Date} object + * @return a {@link java.util.Date} object * @see java.text.DateFormat#parseObject(String, ParsePosition) */ Object parseObject(String source, ParsePosition pos);