This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new f9861c09e Javadoc: Use {@code}
f9861c09e is described below
commit f9861c09eb3d2af3e79e2fa0c523e5e616b94af5
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Apr 24 09:11:34 2026 -0400
Javadoc: Use {@code}
---
.../java/org/apache/commons/lang3/ClassUtils.java | 8 ++++----
.../java/org/apache/commons/lang3/JavaVersion.java | 4 ++--
.../lang3/concurrent/AbstractCircuitBreaker.java | 2 +-
.../lang3/concurrent/BackgroundInitializer.java | 2 +-
.../concurrent/CallableBackgroundInitializer.java | 10 +++++-----
.../commons/lang3/concurrent/ConcurrentUtils.java | 20 ++++++++++----------
.../lang3/concurrent/ConstantInitializer.java | 4 ++--
.../lang3/concurrent/MultiBackgroundInitializer.java | 8 ++++----
.../commons/lang3/concurrent/TimedSemaphore.java | 2 +-
.../apache/commons/lang3/text/StrSubstitutor.java | 2 +-
10 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/src/main/java/org/apache/commons/lang3/ClassUtils.java
b/src/main/java/org/apache/commons/lang3/ClassUtils.java
index ad4dc44ad..ca9894b79 100644
--- a/src/main/java/org/apache/commons/lang3/ClassUtils.java
+++ b/src/main/java/org/apache/commons/lang3/ClassUtils.java
@@ -1685,7 +1685,7 @@ private static boolean useFull(final int runAheadTarget,
final int source, final
* </p>
*
* @param classes the class array to convert, may be null or empty.
- * @return an array which contains for each given class, the primitive
class or <strong>null</strong> if the original class is not a wrapper class.
+ * @return an array which contains for each given class, the primitive
class or {@code null} if the original class is not a wrapper class.
* {@code null} if null input. Empty array if an empty array
passed in.
* @see #wrapperToPrimitive(Class)
* @since 2.4
@@ -1706,11 +1706,11 @@ public static Class<?>[] wrappersToPrimitives(final
Class<?>... classes) {
* <p>
* This method is the counter part of {@code primitiveToWrapper()}. If the
passed in class is a wrapper class for a
* primitive type, this primitive type will be returned (e.g. {@code
Integer.TYPE} for {@code Integer.class}). For other
- * classes, or if the parameter is <strong>null</strong>, the return value
is <strong>null</strong>.
+ * classes, or if the parameter is {@code null}, the return value is
{@code null}.
* </p>
*
- * @param cls the class to convert, may be <strong>null</strong>.
- * @return the corresponding primitive type if {@code cls} is a wrapper
class, <strong>null</strong> otherwise.
+ * @param cls the class to convert, may be {@code null}.
+ * @return the corresponding primitive type if {@code cls} is a wrapper
class, {@code null} otherwise.
* @see #primitiveToWrapper(Class)
* @since 2.4
*/
diff --git a/src/main/java/org/apache/commons/lang3/JavaVersion.java
b/src/main/java/org/apache/commons/lang3/JavaVersion.java
index af13d4ae4..3939563dc 100644
--- a/src/main/java/org/apache/commons/lang3/JavaVersion.java
+++ b/src/main/java/org/apache/commons/lang3/JavaVersion.java
@@ -221,7 +221,7 @@ public enum JavaVersion {
* Transforms the given string with a Java version number to the
corresponding constant of this enumeration class. This method is used
internally.
*
* @param versionStr the Java version as string.
- * @return the corresponding enumeration constant or <strong>null</strong>
if the version is unknown.
+ * @return the corresponding enumeration constant or {@code null} if the
version is unknown.
*/
static JavaVersion get(final String versionStr) {
if (versionStr == null) {
@@ -303,7 +303,7 @@ static JavaVersion get(final String versionStr) {
* Transforms the given string with a Java version number to the
corresponding constant of this enumeration class. This method is used
internally.
*
* @param versionStr the Java version as string.
- * @return the corresponding enumeration constant or <strong>null</strong>
if the version is unknown.
+ * @return the corresponding enumeration constant or {@code null} if the
version is unknown.
*/
static JavaVersion getJavaVersion(final String versionStr) {
return get(versionStr);
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
index 60743fb46..20891c0ff 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/AbstractCircuitBreaker.java
@@ -99,7 +99,7 @@ public AbstractCircuitBreaker() {
/**
* Adds a change listener to this circuit breaker. This listener is
notified whenever
* the state of this circuit breaker changes. If the listener is
- * <strong>null</strong>, it is silently ignored.
+ * {@code null}, it is silently ignored.
*
* @param listener the listener to be added
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
index e0ab8b155..f1a02695e 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/BackgroundInitializer.java
@@ -271,7 +271,7 @@ public T get() throws ConcurrentException {
/**
* Gets the {@link ExecutorService} that is actually used for executing
* the background task. This method can be called after {@link #start()}
- * (before {@code start()} it returns <strong>null</strong>). If an
external executor
+ * (before {@code start()} it returns {@code null}). If an external
executor
* was set, this is also the active executor. Otherwise this method returns
* the temporary executor that was created by this object.
*
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 7d7d07777..77cd0765c 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/CallableBackgroundInitializer.java
@@ -73,8 +73,8 @@ public class CallableBackgroundInitializer<T> extends
BackgroundInitializer<T> {
* Creates a new instance of {@link CallableBackgroundInitializer} and sets
* the {@link Callable} to be executed in a background thread.
*
- * @param call the {@link Callable} (must not be <strong>null</strong>).
- * @throws IllegalArgumentException if the {@link Callable} is
<strong>null</strong>.
+ * @param call the {@link Callable} (must not be {@code null}).
+ * @throws IllegalArgumentException if the {@link Callable} is {@code
null}.
*/
public CallableBackgroundInitializer(final Callable<T> call) {
checkCallable(call);
@@ -85,9 +85,9 @@ public CallableBackgroundInitializer(final Callable<T> call) {
* Creates a new instance of {@link CallableBackgroundInitializer} and
initializes it with the {@link Callable} to be executed in a background thread
and
* the {@link ExecutorService} for managing the background execution.
*
- * @param call the {@link Callable} (must not be <strong>null</strong>).
+ * @param call the {@link Callable} (must not be {@code null}).
* @param exec an external {@link ExecutorService} to be used for task
execution.
- * @throws IllegalArgumentException if the {@link Callable} is
<strong>null</strong>.
+ * @throws IllegalArgumentException if the {@link Callable} is {@code
null}.
*/
public CallableBackgroundInitializer(final Callable<T> call, final
ExecutorService exec) {
super(exec);
@@ -99,7 +99,7 @@ public CallableBackgroundInitializer(final Callable<T> call,
final ExecutorServi
* Tests the passed in {@link Callable} and throws an exception if it is
undefined.
*
* @param callable the object to check.
- * @throws IllegalArgumentException if the {@link Callable} is
<strong>null</strong>.
+ * @throws IllegalArgumentException if the {@link Callable} is {@code
null}.
*/
private void checkCallable(final Callable<T> callable) {
Objects.requireNonNull(callable, "callable");
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
index eb71d3262..5cc2b39e9 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConcurrentUtils.java
@@ -46,7 +46,7 @@ static final class ConstantFuture<T> implements Future<T> {
* Creates a new instance of {@link ConstantFuture} and initializes it
* with the constant value.
*
- * @param value the value (may be <strong>null</strong>)
+ * @param value the value (may be {@code null})
*/
ConstantFuture(final T value) {
this.value = value;
@@ -138,8 +138,8 @@ public static <T> Future<T> constantFuture(final T value) {
* is called. With the resulting object
* {@link #putIfAbsent(ConcurrentMap, Object, Object)} is called. This
* handles the case that in the meantime another thread has added the key
to
- * the map. Both the map and the initializer can be <strong>null</strong>;
in this
- * case this method simply returns <strong>null</strong>.
+ * the map. Both the map and the initializer can be {@code null}; in this
+ * case this method simply returns {@code null}.
*
* @param <K> the type of the keys of the map
* @param <V> the type of the values of the map
@@ -193,8 +193,8 @@ public static <K, V> V createIfAbsentUnchecked(final
ConcurrentMap<K, V> map,
* necessary. This method performs the following checks on the cause of the
* passed in exception:
* <ul>
- * <li>If the passed in exception is <strong>null</strong> or the cause is
- * <strong>null</strong>, this method returns <strong>null</strong>.</li>
+ * <li>If the passed in exception is {@code null} or the cause is
+ * {@code null}, this method returns {@code null}.</li>
* <li>If the cause is a runtime exception, it is directly thrown.</li>
* <li>If the cause is an error, it is directly thrown, too.</li>
* <li>In any other case the cause is a checked exception. The method then
@@ -239,7 +239,7 @@ public static ConcurrentRuntimeException
extractCauseUnchecked(final ExecutionEx
* exception - which might already cause an unchecked exception or an error
* being thrown. If the cause is a checked exception however, it is wrapped
* in a {@link ConcurrentException}, which is thrown. If the passed in
- * exception is <strong>null</strong> or has no cause, the method simply
returns
+ * exception is {@code null} or has no cause, the method simply returns
* without throwing an exception.
*
* @param ex the exception to be handled
@@ -277,8 +277,8 @@ public static void handleCauseUnchecked(final
ExecutionException ex) {
* Invokes the specified {@link ConcurrentInitializer} and returns the
* object produced by the initializer. This method just invokes the {@code
* get()} method of the given {@link ConcurrentInitializer}. It is
- * <strong>null</strong>-safe: if the argument is <strong>null</strong>,
result is also
- * <strong>null</strong>.
+ * {@code null}-safe: if the argument is {@code null}, result is also
+ * {@code null}.
*
* @param <T> the type of the object produced by the initializer
* @param initializer the {@link ConcurrentInitializer} to be invoked
@@ -332,9 +332,9 @@ public static <T> T initializeUnchecked(final
ConcurrentInitializer<T> initializ
* returns the value which is stored in the map.
* </p>
* <p>
- * This method is <strong>null</strong>-safe: It accepts a
<strong>null</strong> map as input
+ * This method is {@code null}-safe: It accepts a {@code null} map as input
* without throwing an exception. In this case the return value is
- * <strong>null</strong>, too.
+ * {@code null}, too.
* </p>
*
* @param <K> the type of the keys of the map
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
index f7ee310ae..a861d4d89 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/ConstantInitializer.java
@@ -48,8 +48,8 @@ public class ConstantInitializer<T> implements
ConcurrentInitializer<T> {
* Creates a new instance of {@link ConstantInitializer} and initializes it
* with the object to be managed. The {@code get()} method will always
* return the object passed here. This class does not place any
restrictions
- * on the object. It may be <strong>null</strong>, then {@code get()} will
return
- * <strong>null</strong>, too.
+ * on the object. It may be {@code null}, then {@code get()} will return
+ * {@code null}, too.
*
* @param obj the object to be managed by this initializer
*/
diff --git
a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
index 68fa95d58..733d86352 100644
---
a/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
+++
b/src/main/java/org/apache/commons/lang3/concurrent/MultiBackgroundInitializer.java
@@ -152,7 +152,7 @@ private BackgroundInitializer<?> checkName(final String
name) {
* Gets the {@link ConcurrentException} object that was thrown by the
* {@link BackgroundInitializer} with the given name. If this
* initializer did not throw an exception, the return value is
- * <strong>null</strong>. If the name cannot be resolved, an exception
is thrown.
+ * {@code null}. If the name cannot be resolved, an exception is
thrown.
*
* @param name the name of the {@link BackgroundInitializer}.
* @return the exception thrown by this initializer.
@@ -178,7 +178,7 @@ public BackgroundInitializer<?> getInitializer(final String
name) {
/**
* Gets the result object produced by the {@code
* BackgroundInitializer} with the given name. This is the object
returned by the initializer's {@code initialize()} method. If this
- * {@link BackgroundInitializer} caused an exception,
<strong>null</strong> is returned. If the name cannot be resolved, an exception
is thrown.
+ * {@link BackgroundInitializer} caused an exception, {@code null} is
returned. If the name cannot be resolved, an exception is thrown.
*
* @param name the name of the {@link BackgroundInitializer}.
* @return the result object produced by this {@code
BackgroundInitializer}.
@@ -245,8 +245,8 @@ public MultiBackgroundInitializer(final ExecutorService
exec) {
* Adds a new {@link BackgroundInitializer} to this object. When this
{@link MultiBackgroundInitializer} is started, the given initializer will be
* processed. This method must not be called after {@link #start()} has
been invoked.
*
- * @param name the name of the initializer (must not be
<strong>null</strong>).
- * @param backgroundInitializer the {@link BackgroundInitializer} to add
(must not be <strong>null</strong>).
+ * @param name the name of the initializer (must not be
{@code null}).
+ * @param backgroundInitializer the {@link BackgroundInitializer} to add
(must not be {@code null}).
* @throws NullPointerException if either {@code name} or {@code
backgroundInitializer} is {@code null}.
* @throws IllegalStateException if {@code start()} has already been
called.
*/
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 d25f1e135..f601ab4f1 100644
--- a/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java
+++ b/src/main/java/org/apache/commons/lang3/concurrent/TimedSemaphore.java
@@ -268,7 +268,7 @@ public TimedSemaphore(final long timePeriod, final TimeUnit
timeUnit, final int
/**
* Constructs a new instance of {@link TimedSemaphore} and initializes it
with an executor service, the given time period, and the limit. The executor
service
- * will be used for creating a periodic task for monitoring the time
period. It can be <strong>null</strong>, then a default service will be created.
+ * will be used for creating a periodic task for monitoring the time
period. It can be {@code null}, then a default service will be created.
*
* @param service the executor service.
* @param timePeriod the time period.
diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
index 24da18a5c..ec0dc4431 100644
--- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java
@@ -864,7 +864,7 @@ public boolean replaceIn(final StringBuilder source, final
int offset, final int
* @param buf the buffer where the substitution is occurring, not null.
* @param startPos the start position of the variable including the
prefix, valid.
* @param endPos the end position of the variable including the suffix,
valid.
- * @return the variable's value or <strong>null</strong> if the variable
is unknown.
+ * @return the variable's value or {@code null} if the variable is unknown.
*/
protected String resolveVariable(final String variableName, final
StrBuilder buf, final int startPos, final int endPos) {
final StrLookup<?> resolver = getVariableResolver();
