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-text.git
The following commit(s) were added to refs/heads/master by this push:
new 85dc1c41 Javadoc
85dc1c41 is described below
commit 85dc1c41b2acc6b055ae9cfccf347e0776c72eaa
Author: Gary Gregory <[email protected]>
AuthorDate: Tue Jun 30 14:05:47 2026 +0000
Javadoc
---
src/main/java/org/apache/commons/text/Builder.java | 2 +-
src/main/java/org/apache/commons/text/StrLookup.java | 6 +++---
src/main/java/org/apache/commons/text/StrSubstitutor.java | 12 ++++++------
src/main/java/org/apache/commons/text/StringSubstitutor.java | 12 ++++++------
.../apache/commons/text/lookup/BiFunctionStringLookup.java | 4 ++--
.../org/apache/commons/text/lookup/FunctionStringLookup.java | 4 ++--
.../apache/commons/text/lookup/InterpolatorStringLookup.java | 2 +-
.../org/apache/commons/text/lookup/StringLookupFactory.java | 8 ++++----
.../commons/text/similarity/IntersectionSimilarity.java | 4 ++--
.../org/apache/commons/text/similarity/SimilarityInput.java | 2 +-
10 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/Builder.java
b/src/main/java/org/apache/commons/text/Builder.java
index c0405b9a..c7cad0f5 100644
--- a/src/main/java/org/apache/commons/text/Builder.java
+++ b/src/main/java/org/apache/commons/text/Builder.java
@@ -77,7 +77,7 @@ import java.util.function.Supplier;
* </pre>
*
*
- * @param <T> the type of object that the builder will construct or compute.
+ * @param <T> The type of object that the builder will construct or compute.
* @since 1.0
* @see Supplier
* @deprecated Use {@link Supplier}.
diff --git a/src/main/java/org/apache/commons/text/StrLookup.java
b/src/main/java/org/apache/commons/text/StrLookup.java
index b2177813..b3e17155 100644
--- a/src/main/java/org/apache/commons/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/text/StrLookup.java
@@ -39,7 +39,7 @@ import org.apache.commons.text.lookup.StringLookupFactory;
* on demand from the database
* </p>
*
- * @param <V> the type of the values supported by the lookup
+ * @param <V> The type of the values supported by the lookup
* @since 1.0
* @deprecated Deprecated as of 1.3, use {@link StringLookupFactory} instead.
This class will be removed in 2.0.
*/
@@ -49,7 +49,7 @@ public abstract class StrLookup<V> implements StringLookup {
/**
* Lookup implementation that uses a Map.
*
- * @param <V> the type of the values supported by the lookup
+ * @param <V> The type of the values supported by the lookup
*/
private static final class MapStrLookup<V> extends StrLookup<V> {
@@ -162,7 +162,7 @@ public abstract class StrLookup<V> implements StringLookup {
* using toString().
* </p>
*
- * @param <V> the type of the values supported by the lookup.
+ * @param <V> The type of the values supported by the lookup.
* @param map the map of keys to values, may be null.
* @return a lookup using the map, not null.
*/
diff --git a/src/main/java/org/apache/commons/text/StrSubstitutor.java
b/src/main/java/org/apache/commons/text/StrSubstitutor.java
index 2ea2a905..5aa276fe 100644
--- a/src/main/java/org/apache/commons/text/StrSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StrSubstitutor.java
@@ -150,7 +150,7 @@ public class StrSubstitutor {
* Replaces all the occurrences of variables in the given source object
with
* their matching values from the map.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param source the source text containing the variables to substitute,
null returns null.
* @param valueMap the map with the values, may be null.
* @return The result of the replace operation.
@@ -164,7 +164,7 @@ public class StrSubstitutor {
* their matching values from the map. This method allows to specify a
* custom variable prefix and suffix
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param source the source text containing the variables to substitute,
null returns null.
* @param valueMap the map with the values, may be null.
* @param prefix the prefix of variables, not null.
@@ -257,7 +257,7 @@ public class StrSubstitutor {
* Constructs a new instance and initializes it. Uses defaults for variable
* prefix and suffix and the escaping character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
*/
public <V> StrSubstitutor(final Map<String, V> valueMap) {
@@ -267,7 +267,7 @@ public class StrSubstitutor {
/**
* Constructs a new instance and initializes it. Uses a default escaping
character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -280,7 +280,7 @@ public class StrSubstitutor {
/**
* Constructs a new instance and initializes it.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -295,7 +295,7 @@ public class StrSubstitutor {
/**
* Constructs a new instance and initializes it.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java
b/src/main/java/org/apache/commons/text/StringSubstitutor.java
index 3263ef07..32e7d0b4 100644
--- a/src/main/java/org/apache/commons/text/StringSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java
@@ -393,7 +393,7 @@ public class StringSubstitutor {
/**
* Replaces all the occurrences of variables in the given source object
with their matching values from the map.
*
- * @param <V> the type of the values in the map
+ * @param <V> The type of the values in the map
* @param source the source text containing the variables to substitute,
null returns null
* @param valueMap the map with the values, may be null
* @return The result of the replace operation
@@ -407,7 +407,7 @@ public class StringSubstitutor {
* Replaces all the occurrences of variables in the given source object
with their matching values from the map.
* This method allows to specify a custom variable prefix and suffix
*
- * @param <V> the type of the values in the map
+ * @param <V> The type of the values in the map
* @param source the source text containing the variables to substitute,
null returns null
* @param valueMap the map with the values, may be null
* @param prefix the prefix of variables, not null
@@ -505,7 +505,7 @@ public class StringSubstitutor {
* Constructs a new initialized instance. Uses defaults for variable
prefix and suffix and the escaping
* character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
*/
public <V> StringSubstitutor(final Map<String, V> valueMap) {
@@ -515,7 +515,7 @@ public class StringSubstitutor {
/**
* Constructs a new initialized instance. Uses a default escaping
character.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -528,7 +528,7 @@ public class StringSubstitutor {
/**
* Constructs a new initialized instance.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
@@ -543,7 +543,7 @@ public class StringSubstitutor {
/**
* Constructs a new initialized instance.
*
- * @param <V> the type of the values in the map.
+ * @param <V> The type of the values in the map.
* @param valueMap the map with the variables' values, may be null.
* @param prefix the prefix for variables, not null.
* @param suffix the suffix for variables, not null.
diff --git
a/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
index 336d4293..1cc93ab8 100644
--- a/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
@@ -36,7 +36,7 @@ final class BiFunctionStringLookup<P, R> implements
BiStringLookup<P> {
/**
* Creates a new instance backed by a Function.
*
- * @param <T> the function's input type
+ * @param <T> The function's input type
* @param biFunction the function, may be null.
* @return a new instance backed by the given function.
*/
@@ -47,7 +47,7 @@ final class BiFunctionStringLookup<P, R> implements
BiStringLookup<P> {
/**
* Creates a new instance backed by a Map. Used by the default lookup.
*
- * @param <T> the map's value type.
+ * @param <T> The map's value type.
* @param map the map of keys to values, may be null.
* @return a new instance backed by the given map.
*/
diff --git
a/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
index daee9bca..db25a742 100644
--- a/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
@@ -35,7 +35,7 @@ final class FunctionStringLookup<V> extends
AbstractStringLookup {
/**
* Creates a new instance backed by a Function.
*
- * @param <R> the function's input type
+ * @param <R> The function's input type
* @param function the function, may be null.
* @return a new instance backed by the given function.
*/
@@ -46,7 +46,7 @@ final class FunctionStringLookup<V> extends
AbstractStringLookup {
/**
* Creates a new instance backed by a Map. Used by the default lookup.
*
- * @param <V> the map's value type.
+ * @param <V> The map's value type.
* @param map the map of keys to values, may be null.
* @return a new instance backed by the given map.
*/
diff --git
a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
index 0232b0db..3ff68841 100644
--- a/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/InterpolatorStringLookup.java
@@ -82,7 +82,7 @@ final class InterpolatorStringLookup extends
AbstractStringLookup {
* Uses the {@link StringLookupFactory default lookups}.
* </p>
*
- * @param <V> the map's value type.
+ * @param <V> The map's value type.
* @param defaultMap the default map for string lookups.
*/
<V> InterpolatorStringLookup(final Map<String, V> defaultMap) {
diff --git
a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
index a9c7b0ba..ee1bc407 100644
--- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
+++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
@@ -629,8 +629,8 @@ public final class StringLookupFactory {
/**
* Returns the given map if the input is non-null or an empty immutable
map if the input is null.
*
- * @param <K> the class of the map keys
- * @param <V> the class of the map values
+ * @param <K> The class of the map keys
+ * @param <V> The class of the map values
* @param map The map to test
* @return the given map if the input is non-null or an empty immutable
map if the input is null.
*/
@@ -1054,7 +1054,7 @@ public final class StringLookupFactory {
* Returns a new InterpolatorStringLookup using the given key-value pairs
and the configured {@link #addDefaultStringLookups(Map) default lookups} to
* resolve variables. (See the class documentation for details on how
default lookups are configured.)
*
- * @param <V> the value type the default string lookup's map.
+ * @param <V> The value type the default string lookup's map.
* @param map the default map for string lookups.
* @return a new InterpolatorStringLookup.
*/
@@ -1178,7 +1178,7 @@ public final class StringLookupFactory {
/**
* Returns a new map-based lookup where the request for a lookup is
answered with the value for that key.
*
- * @param <V> the map value type.
+ * @param <V> The map value type.
* @param map the map.
* @return a new MapStringLookup.
*/
diff --git
a/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
b/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
index 370b00a2..0a734f0d 100644
---
a/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
+++
b/src/main/java/org/apache/commons/text/similarity/IntersectionSimilarity.java
@@ -30,7 +30,7 @@ import java.util.function.Function;
* within a {@link Set} or {@link HashMap}. Ideally the type is immutable and
implements
* {@link Object#equals(Object)} and {@link Object#hashCode()}.</p>
*
- * @param <T> the type of the elements extracted from the character sequence
+ * @param <T> The type of the elements extracted from the character sequence
* @since 1.7
* @see Set
* @see HashMap
@@ -122,7 +122,7 @@ public class IntersectionSimilarity<T> implements
SimilarityScore<IntersectionRe
* Computes the intersection between two sets. This is the count of all
the elements
* that are within both sets.
*
- * @param <T> the type of the elements in the set.
+ * @param <T> The type of the elements in the set.
* @param setA the set A.
* @param setB the set B.
* @return The intersection of A and B.
diff --git
a/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
b/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
index c39f41a0..73b85458 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
@@ -25,7 +25,7 @@ import java.util.Objects;
* You can implement a SimilarityInput on a domain object instead of
CharSequence where implementing CharSequence does not make sense.
* </p>
*
- * @param <E> the type of elements in this input.
+ * @param <E> The type of elements in this input.
* @since 1.13.0
*/
public interface SimilarityInput<E> {
