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 e906a080 Javadoc
e906a080 is described below
commit e906a0801e03da31256f0cba00d002f9814e8a9a
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:18 2026 -0400
Javadoc
---
.../org/apache/commons/text/AlphabetConverter.java | 4 ++--
.../apache/commons/text/RandomStringGenerator.java | 2 +-
.../java/org/apache/commons/text/StrBuilder.java | 12 +++++-----
.../java/org/apache/commons/text/StrLookup.java | 8 +++----
.../java/org/apache/commons/text/StrMatcher.java | 22 +++++++++---------
.../java/org/apache/commons/text/StrTokenizer.java | 20 ++++++++---------
.../org/apache/commons/text/StringEscapeUtils.java | 18 +++++++--------
.../org/apache/commons/text/StringSubstitutor.java | 4 ++--
.../org/apache/commons/text/StringTokenizer.java | 20 ++++++++---------
.../apache/commons/text/TextRandomProvider.java | 4 ++--
.../org/apache/commons/text/TextStringBuilder.java | 12 +++++-----
.../commons/text/io/StringSubstitutorReader.java | 2 +-
.../text/lookup/AbstractPathFencedLookup.java | 2 +-
.../commons/text/lookup/AbstractStringLookup.java | 6 ++---
.../text/lookup/BiFunctionStringLookup.java | 4 ++--
.../commons/text/lookup/FunctionStringLookup.java | 4 ++--
.../text/lookup/IllegalArgumentExceptions.java | 4 ++--
.../text/lookup/JavaPlatformStringLookup.java | 2 +-
.../org/apache/commons/text/lookup/PathFence.java | 4 ++--
.../commons/text/lookup/StringLookupFactory.java | 24 ++++++++++----------
.../apache/commons/text/matcher/StringMatcher.java | 2 +-
.../commons/text/matcher/StringMatcherFactory.java | 26 +++++++++++-----------
.../apache/commons/text/numbers/DoubleFormat.java | 4 ++--
.../apache/commons/text/numbers/ParsedDecimal.java | 2 +-
.../apache/commons/text/similarity/Counter.java | 2 +-
.../commons/text/similarity/SimilarityInput.java | 4 ++--
26 files changed, 109 insertions(+), 109 deletions(-)
diff --git a/src/main/java/org/apache/commons/text/AlphabetConverter.java
b/src/main/java/org/apache/commons/text/AlphabetConverter.java
index 3864ac6a..d23b29ce 100644
--- a/src/main/java/org/apache/commons/text/AlphabetConverter.java
+++ b/src/main/java/org/apache/commons/text/AlphabetConverter.java
@@ -83,7 +83,7 @@ public final class AlphabetConverter {
* Creates new String that contains just the given code point.
*
* @param i code point.
- * @return a new string with the new code point.
+ * @return A new string with the new code point.
* @see
"http://www.oracle.com/us/technologies/java/supplementary-142654.html";
*/
private static String codePointToString(final int i) {
@@ -97,7 +97,7 @@ public final class AlphabetConverter {
* Converts characters to integers.
*
* @param chars array of characters.
- * @return an equivalent array of integers.
+ * @return An equivalent array of integers.
*/
private static Integer[] convertCharsToIntegers(final Character[] chars) {
if (ArrayUtils.isEmpty(chars)) {
diff --git a/src/main/java/org/apache/commons/text/RandomStringGenerator.java
b/src/main/java/org/apache/commons/text/RandomStringGenerator.java
index 5b17555b..0fa5d949 100644
--- a/src/main/java/org/apache/commons/text/RandomStringGenerator.java
+++ b/src/main/java/org/apache/commons/text/RandomStringGenerator.java
@@ -358,7 +358,7 @@ public final class RandomStringGenerator {
/**
* Constructs a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.11.0
*/
public static Builder builder() {
diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java
b/src/main/java/org/apache/commons/text/StrBuilder.java
index c477a57e..f1805667 100644
--- a/src/main/java/org/apache/commons/text/StrBuilder.java
+++ b/src/main/java/org/apache/commons/text/StrBuilder.java
@@ -1393,7 +1393,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* The returned reader supports marking, and ignores the flush method.
* </p>
*
- * @return a reader that reads from this builder.
+ * @return A reader that reads from this builder.
*/
public Reader asReader() {
return new StrBuilderReader();
@@ -1429,7 +1429,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* Calling {@link StrTokenizer#reset(String)} or {@link
StrTokenizer#reset(char[])} with a non-null value will break the link with the
builder.
* </p>
*
- * @return a tokenizer that is linked to this builder.
+ * @return A tokenizer that is linked to this builder.
*/
public StrTokenizer asTokenizer() {
return new StrBuilderTokenizer();
@@ -1453,7 +1453,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
* The returned writer ignores the close and flush methods.
* </p>
*
- * @return a writer that populates this builder.
+ * @return A writer that populates this builder.
*/
public Writer asWriter() {
return new StrBuilderWriter();
@@ -1887,7 +1887,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Gets a suitable hash code for this builder.
*
- * @return a hash code.
+ * @return A hash code.
*/
@Override
public int hashCode() {
@@ -2853,7 +2853,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
/**
* Copies the builder's character array into a new character array.
*
- * @return a new array that represents the contents of the builder.
+ * @return A new array that represents the contents of the builder.
*/
public char[] toCharArray() {
return size == 0 ? ArrayUtils.EMPTY_CHAR_ARRAY : Arrays.copyOf(buffer,
size);
@@ -2864,7 +2864,7 @@ public class StrBuilder implements CharSequence,
Appendable, Serializable, Build
*
* @param startIndex the start index, inclusive, must be valid.
* @param endIndex the end index, exclusive, must be valid except that
if too large it is treated as end of string.
- * @return a new array that holds part of the contents of the builder.
+ * @return A new array that holds part of the contents of the builder.
* @throws IndexOutOfBoundsException if startIndex is invalid, or if
endIndex is invalid (but endIndex greater than size is valid).
*/
public char[] toCharArray(final int startIndex, int endIndex) {
diff --git a/src/main/java/org/apache/commons/text/StrLookup.java
b/src/main/java/org/apache/commons/text/StrLookup.java
index b3e17155..cef7872f 100644
--- a/src/main/java/org/apache/commons/text/StrLookup.java
+++ b/src/main/java/org/apache/commons/text/StrLookup.java
@@ -164,7 +164,7 @@ public abstract class StrLookup<V> implements StringLookup {
*
* @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.
+ * @return A lookup using the map, not null.
*/
public static <V> StrLookup<V> mapLookup(final Map<String, V> map) {
return new MapStrLookup<>(map);
@@ -173,7 +173,7 @@ public abstract class StrLookup<V> implements StringLookup {
/**
* Returns a lookup which always returns null.
*
- * @return a lookup that always returns null, not null.
+ * @return A lookup that always returns null, not null.
*/
public static StrLookup<?> noneLookup() {
return NONE_LOOKUP;
@@ -187,7 +187,7 @@ public abstract class StrLookup<V> implements StringLookup {
* </p>
*
* @param resourceBundle the map of keys to values, may be null.
- * @return a lookup using the map, not null.
+ * @return A lookup using the map, not null.
* @see StringLookupFactory#resourceBundleStringLookup(String)
*/
public static StrLookup<String> resourceBundleLookup(final ResourceBundle
resourceBundle) {
@@ -203,7 +203,7 @@ public abstract class StrLookup<V> implements StringLookup {
* If a null key is used, this lookup will throw a NullPointerException.
* </p>
*
- * @return a lookup using system properties, not null.
+ * @return A lookup using system properties, not null.
*/
public static StrLookup<String> systemPropertiesLookup() {
return SYSTEM_PROPERTIES_LOOKUP;
diff --git a/src/main/java/org/apache/commons/text/StrMatcher.java
b/src/main/java/org/apache/commons/text/StrMatcher.java
index c9c24bb5..eb662678 100644
--- a/src/main/java/org/apache/commons/text/StrMatcher.java
+++ b/src/main/java/org/apache/commons/text/StrMatcher.java
@@ -249,7 +249,7 @@ public abstract class StrMatcher {
* Creates a matcher from a character.
*
* @param ch the character to match, must not be null.
- * @return a new Matcher for the given char.
+ * @return A new Matcher for the given char.
*/
public static StrMatcher charMatcher(final char ch) {
return new CharMatcher(ch);
@@ -259,7 +259,7 @@ public abstract class StrMatcher {
* Creates a matcher from a set of characters.
*
* @param chars the characters to match, null or empty matches nothing.
- * @return a new matcher for the given char[].
+ * @return A new matcher for the given char[].
*/
public static StrMatcher charSetMatcher(final char... chars) {
if (ArrayUtils.isEmpty(chars)) {
@@ -275,7 +275,7 @@ public abstract class StrMatcher {
* Creates a matcher from a string representing a set of characters.
*
* @param chars the characters to match, null or empty matches nothing.
- * @return a new Matcher for the given characters.
+ * @return A new Matcher for the given characters.
*/
public static StrMatcher charSetMatcher(final String chars) {
if (chars == null || chars.isEmpty()) {
@@ -290,7 +290,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the comma character.
*
- * @return a matcher for a comma.
+ * @return A matcher for a comma.
*/
public static StrMatcher commaMatcher() {
return COMMA_MATCHER;
@@ -299,7 +299,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the double quote character.
*
- * @return a matcher for a double quote.
+ * @return A matcher for a double quote.
*/
public static StrMatcher doubleQuoteMatcher() {
return DOUBLE_QUOTE_MATCHER;
@@ -308,7 +308,7 @@ public abstract class StrMatcher {
/**
* Matches no characters.
*
- * @return a matcher that matches nothing.
+ * @return A matcher that matches nothing.
*/
public static StrMatcher noneMatcher() {
return NONE_MATCHER;
@@ -317,7 +317,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the single or double quote character.
*
- * @return a matcher for a single or double quote.
+ * @return A matcher for a single or double quote.
*/
public static StrMatcher quoteMatcher() {
return QUOTE_MATCHER;
@@ -326,7 +326,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the single quote character.
*
- * @return a matcher for a single quote.
+ * @return A matcher for a single quote.
*/
public static StrMatcher singleQuoteMatcher() {
return SINGLE_QUOTE_MATCHER;
@@ -335,7 +335,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the space character.
*
- * @return a matcher for a space.
+ * @return A matcher for a space.
*/
public static StrMatcher spaceMatcher() {
return SPACE_MATCHER;
@@ -355,7 +355,7 @@ public abstract class StrMatcher {
* Creates a matcher from a string.
*
* @param str the string to match, null or empty matches nothing
- * @return a new Matcher for the given String
+ * @return A new Matcher for the given String
*/
public static StrMatcher stringMatcher(final String str) {
if (str == null || str.isEmpty()) {
@@ -367,7 +367,7 @@ public abstract class StrMatcher {
/**
* Returns a matcher which matches the tab character.
*
- * @return a matcher for a tab.
+ * @return A matcher for a tab.
*/
public static StrMatcher tabMatcher() {
return TAB_MATCHER;
diff --git a/src/main/java/org/apache/commons/text/StrTokenizer.java
b/src/main/java/org/apache/commons/text/StrTokenizer.java
index 9d757234..8610a76d 100644
--- a/src/main/java/org/apache/commons/text/StrTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StrTokenizer.java
@@ -111,7 +111,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
/**
* Returns a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
+ * @return A clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getCSVClone() {
return (StrTokenizer) CSV_TOKENIZER_PROTOTYPE.clone();
@@ -124,7 +124,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* You must call a "reset" method to set the string which you want to
parse.
* </p>
*
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StrTokenizer getCSVInstance() {
return getCSVClone();
@@ -135,7 +135,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* trim whitespace from both ends (which can be overridden with the
setTrimmer method).
*
* @param input the text to parse.
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StrTokenizer getCSVInstance(final char[] input) {
final StrTokenizer tok = getCSVClone();
@@ -148,7 +148,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* trim whitespace from both ends (which can be overridden with the
setTrimmer method).
*
* @param input the text to parse.
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StrTokenizer getCSVInstance(final String input) {
final StrTokenizer tok = getCSVClone();
@@ -159,7 +159,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
/**
* Returns a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
+ * @return A clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*/
private static StrTokenizer getTSVClone() {
return (StrTokenizer) TSV_TOKENIZER_PROTOTYPE.clone();
@@ -172,7 +172,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* You must call a "reset" method to set the string which you want to
parse.
* </p>
*
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StrTokenizer getTSVInstance() {
return getTSVClone();
@@ -183,7 +183,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* be overridden with the setTrimmer method).
*
* @param input the string to parse.
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StrTokenizer getTSVInstance(final char[] input) {
final StrTokenizer tok = getTSVClone();
@@ -196,7 +196,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* be overridden with the setTrimmer method).
*
* @param input the string to parse.
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StrTokenizer getTSVInstance(final String input) {
final StrTokenizer tok = getTSVClone();
@@ -436,7 +436,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
* Creates a new instance of this Tokenizer. The new instance is reset so
that it will be at the start of the token list. If a
* {@link CloneNotSupportedException} is caught, return {@code null}.
*
- * @return a new instance of this Tokenizer which has been reset.
+ * @return A new instance of this Tokenizer which has been reset.
*/
@Override
public Object clone() {
@@ -450,7 +450,7 @@ public class StrTokenizer implements ListIterator<String>,
Cloneable {
/**
* Creates a new instance of this Tokenizer. The new instance is reset so
that it will be at the start of the token list.
*
- * @return a new instance of this Tokenizer which has been reset.
+ * @return A new instance of this Tokenizer which has been reset.
* @throws CloneNotSupportedException if there is a problem cloning.
*/
Object cloneReset() throws CloneNotSupportedException {
diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java
b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
index 700ca956..7dc51edb 100644
--- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java
+++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java
@@ -558,7 +558,7 @@ public class StringEscapeUtils {
* <p>Supports only the HTML 3.0 entities.</p>
*
* @param input the {@code String} to escape, may be null.
- * @return a new escaped {@code String}, {@code null} if null string input.
+ * @return A new escaped {@code String}, {@code null} if null string input.
*/
public static String escapeHtml3(final String input) {
return ESCAPE_HTML3.translate(input);
@@ -581,7 +581,7 @@ public class StringEscapeUtils {
* is not a legal entity and so is not supported).</p>
*
* @param input the {@code String} to escape, may be null.
- * @return a new escaped {@code String}, {@code null} if null string input.
+ * @return A new escaped {@code String}, {@code null} if null string input.
* @see <a
href="https://hotwired.lycos.com/webmonkey/reference/special_characters/";>ISO
Entities</a>
* @see <a href="https://www.w3.org/TR/REC-html32#latin1";>HTML 3.2
Character Entities for ISO Latin-1</a>
* @see <a href="https://www.w3.org/TR/REC-html40/sgml/entities.html";>HTML
4.0 Character entity references</a>
@@ -688,7 +688,7 @@ public class StringEscapeUtils {
* </p>
*
* @param input the {@code String} to escape, may be null.
- * @return a new escaped {@code String}, {@code null} if null string input.
+ * @return A new escaped {@code String}, {@code null} if null string input.
* @see #unescapeXml(String)
*/
public static String escapeXml10(final String input) {
@@ -724,7 +724,7 @@ public class StringEscapeUtils {
* </p>
*
* @param input the {@code String} to escape, may be null.
- * @return a new escaped {@code String}, {@code null} if null string input.
+ * @return A new escaped {@code String}, {@code null} if null string input.
* @see #unescapeXml(String)
*/
public static String escapeXml11(final String input) {
@@ -800,7 +800,7 @@ public class StringEscapeUtils {
* entities.
*
* @param input the {@code String} to unescape, may be null.
- * @return a new unescaped {@code String}, {@code null} if null string
input.
+ * @return A new unescaped {@code String}, {@code null} if null string
input.
*/
public static String unescapeHtml3(final String input) {
return UNESCAPE_HTML3.translate(input);
@@ -819,7 +819,7 @@ public class StringEscapeUtils {
* </p>
*
* @param input the {@code String} to unescape, may be null.
- * @return a new unescaped {@code String}, {@code null} if null string
input.
+ * @return A new unescaped {@code String}, {@code null} if null string
input.
*/
public static String unescapeHtml4(final String input) {
return UNESCAPE_HTML4.translate(input);
@@ -830,7 +830,7 @@ public class StringEscapeUtils {
* unless the {@code '\'} is preceded by another {@code '\'}.
*
* @param input the {@code String} to unescape, may be null.
- * @return a new unescaped {@code String}, {@code null} if null string
input.
+ * @return A new unescaped {@code String}, {@code null} if null string
input.
*/
public static String unescapeJava(final String input) {
return UNESCAPE_JAVA.translate(input);
@@ -863,7 +863,7 @@ public class StringEscapeUtils {
* </p>
*
* @param input the {@code String} to unescape, may be null.
- * @return a new unescaped {@code String}, {@code null} if null string
input.
+ * @return A new unescaped {@code String}, {@code null} if null string
input.
* @see #escapeXml10(String)
* @see #escapeXml11(String)
*/
@@ -875,7 +875,7 @@ public class StringEscapeUtils {
* Unescapes the characters in a {@code String} using XSI rules.
*
* @param input the {@code String} to unescape, may be null.
- * @return a new unescaped {@code String}, {@code null} if null string
input.
+ * @return A new unescaped {@code String}, {@code null} if null string
input.
* @see StringEscapeUtils#escapeXSI(String)
*/
public static String unescapeXSI(final String input) {
diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java
b/src/main/java/org/apache/commons/text/StringSubstitutor.java
index 32e7d0b4..f2eb1e5c 100644
--- a/src/main/java/org/apache/commons/text/StringSubstitutor.java
+++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java
@@ -382,7 +382,7 @@ public class StringSubstitutor {
* </tr>
* </table>
*
- * @return a new instance using the interpolator string lookup.
+ * @return A new instance using the interpolator string lookup.
* @see StringLookupFactory#interpolatorStringLookup()
* @since 1.8
*/
@@ -1558,7 +1558,7 @@ public class StringSubstitutor {
/**
* Returns a string representation of the object.
*
- * @return a string representation of the object.
+ * @return A string representation of the object.
* @since 1.11.0
*/
@Override
diff --git a/src/main/java/org/apache/commons/text/StringTokenizer.java
b/src/main/java/org/apache/commons/text/StringTokenizer.java
index 83b1c12f..2682a36a 100644
--- a/src/main/java/org/apache/commons/text/StringTokenizer.java
+++ b/src/main/java/org/apache/commons/text/StringTokenizer.java
@@ -118,7 +118,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
/**
* Returns a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of {@code CSV_TOKENIZER_PROTOTYPE}.
+ * @return A clone of {@code CSV_TOKENIZER_PROTOTYPE}.
*/
private static StringTokenizer getCSVClone() {
return (StringTokenizer) CSV_TOKENIZER_PROTOTYPE.clone();
@@ -132,7 +132,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* You must call a "reset" method to set the string which you want to
parse.
* </p>
*
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StringTokenizer getCSVInstance() {
return getCSVClone();
@@ -143,7 +143,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* trim whitespace from both ends (which can be overridden with the
setTrimmer method).
*
* @param input the text to parse.
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StringTokenizer getCSVInstance(final char[] input) {
return getCSVClone().reset(input);
@@ -154,7 +154,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* trim whitespace from both ends (which can be overridden with the
setTrimmer method).
*
* @param input the text to parse.
- * @return a new tokenizer instance which parses Comma Separated Value
strings.
+ * @return A new tokenizer instance which parses Comma Separated Value
strings.
*/
public static StringTokenizer getCSVInstance(final String input) {
return getCSVClone().reset(input);
@@ -163,7 +163,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
/**
* Returns a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*
- * @return a clone of {@code TSV_TOKENIZER_PROTOTYPE}.
+ * @return A clone of {@code TSV_TOKENIZER_PROTOTYPE}.
*/
private static StringTokenizer getTSVClone() {
return (StringTokenizer) TSV_TOKENIZER_PROTOTYPE.clone();
@@ -176,7 +176,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* You must call a "reset" method to set the string which you want to
parse.
* </p>
*
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StringTokenizer getTSVInstance() {
return getTSVClone();
@@ -187,7 +187,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* be overridden with the setTrimmer method).
*
* @param input the string to parse.
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StringTokenizer getTSVInstance(final char[] input) {
return getTSVClone().reset(input);
@@ -198,7 +198,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* be overridden with the setTrimmer method).
*
* @param input the string to parse.
- * @return a new tokenizer instance which parses Tab Separated Value
strings.
+ * @return A new tokenizer instance which parses Tab Separated Value
strings.
*/
public static StringTokenizer getTSVInstance(final String input) {
return getTSVClone().reset(input);
@@ -422,7 +422,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
* Creates a new instance of this Tokenizer. The new instance is reset so
that it will be at the start of the token list. If a
* {@link CloneNotSupportedException} is caught, return {@code null}.
*
- * @return a new instance of this Tokenizer which has been reset.
+ * @return A new instance of this Tokenizer which has been reset.
*/
@Override
public Object clone() {
@@ -436,7 +436,7 @@ public class StringTokenizer implements
ListIterator<String>, Cloneable {
/**
* Creates a new instance of this Tokenizer. The new instance is reset so
that it will be at the start of the token list.
*
- * @return a new instance of this Tokenizer which has been reset.
+ * @return A new instance of this Tokenizer which has been reset.
* @throws CloneNotSupportedException if there is a problem cloning.
*/
Object cloneReset() throws CloneNotSupportedException {
diff --git a/src/main/java/org/apache/commons/text/TextRandomProvider.java
b/src/main/java/org/apache/commons/text/TextRandomProvider.java
index 82477d6b..19b1a46f 100644
--- a/src/main/java/org/apache/commons/text/TextRandomProvider.java
+++ b/src/main/java/org/apache/commons/text/TextRandomProvider.java
@@ -48,7 +48,7 @@ public interface TextRandomProvider extends IntUnaryOperator {
* Generates an int value between 0 (inclusive) and the specified value
(exclusive).
*
* @param max Bound on the random number to be returned. Must be positive.
- * @return a random int value between 0 (inclusive) and max (exclusive).
+ * @return A random int value between 0 (inclusive) and max (exclusive).
* @since 1.14.0
*/
@Override
@@ -60,7 +60,7 @@ public interface TextRandomProvider extends IntUnaryOperator {
* Generates an int value between 0 (inclusive) and the specified value
(exclusive).
*
* @param max Bound on the random number to be returned. Must be positive.
- * @return a random int value between 0 (inclusive) and max (exclusive).
+ * @return A random int value between 0 (inclusive) and max (exclusive).
* @deprecated Use {@link #applyAsInt(int)}.
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java
b/src/main/java/org/apache/commons/text/TextStringBuilder.java
index 585711b4..a3997bff 100644
--- a/src/main/java/org/apache/commons/text/TextStringBuilder.java
+++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java
@@ -1428,7 +1428,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
* The returned reader supports marking, and ignores the flush method.
* </p>
*
- * @return a reader that reads from this builder.
+ * @return A reader that reads from this builder.
*/
public Reader asReader() {
return new TextStringBuilderReader();
@@ -1467,7 +1467,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
* break the link with the builder.
* </p>
*
- * @return a tokenizer that is linked to this builder.
+ * @return A tokenizer that is linked to this builder.
*/
public StringTokenizer asTokenizer() {
return new TextStringBuilderTokenizer();
@@ -1491,7 +1491,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
* The returned writer ignores the close and flush methods.
* </p>
*
- * @return a writer that populates this builder.
+ * @return A writer that populates this builder.
*/
public Writer asWriter() {
return new TextStringBuilderWriter();
@@ -1993,7 +1993,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
/**
* Gets a suitable hash code for this builder.
*
- * @return a hash code.
+ * @return A hash code.
*/
@Override
public int hashCode() {
@@ -3087,7 +3087,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
/**
* Copies the builder's character array into a new character array.
*
- * @return a new array that represents the contents of the builder.
+ * @return A new array that represents the contents of the builder.
*/
public char[] toCharArray() {
return size == 0 ? ArrayUtils.EMPTY_CHAR_ARRAY : Arrays.copyOf(buffer,
size);
@@ -3098,7 +3098,7 @@ public class TextStringBuilder implements CharSequence,
Appendable, Serializable
*
* @param startIndex the start index, inclusive, must be valid.
* @param endIndex the end index, exclusive, must be valid except that
if too large it is treated as end of string.
- * @return a new array that holds part of the contents of the builder.
+ * @return A new array that holds part of the contents of the builder.
* @throws IndexOutOfBoundsException if startIndex is invalid, or if
endIndex is invalid (but endIndex greater than size is valid).
*/
public char[] toCharArray(final int startIndex, int endIndex) {
diff --git
a/src/main/java/org/apache/commons/text/io/StringSubstitutorReader.java
b/src/main/java/org/apache/commons/text/io/StringSubstitutorReader.java
index 99f648fe..2f00f370 100644
--- a/src/main/java/org/apache/commons/text/io/StringSubstitutorReader.java
+++ b/src/main/java/org/apache/commons/text/io/StringSubstitutorReader.java
@@ -144,7 +144,7 @@ public class StringSubstitutorReader extends FilterReader {
/**
* Reads a single character.
*
- * @return a character as an {@code int} or {@code -1} for end-of-stream.
+ * @return A character as an {@code int} or {@code -1} for end-of-stream.
* @throws IOException If an I/O error occurs.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/text/lookup/AbstractPathFencedLookup.java
b/src/main/java/org/apache/commons/text/lookup/AbstractPathFencedLookup.java
index b4fc4601..a4e63080 100644
--- a/src/main/java/org/apache/commons/text/lookup/AbstractPathFencedLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/AbstractPathFencedLookup.java
@@ -42,7 +42,7 @@ abstract class AbstractPathFencedLookup extends
AbstractStringLookup {
* Gets a Path for the given file name checking that it resolves within
our fence.
*
* @param fileName the file name to resolve.
- * @return a fenced Path.
+ * @return A fenced Path.
* @throws IllegalArgumentException if the file name is not without our
fence.
*/
protected Path getPath(final String fileName) {
diff --git
a/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
index d5a18448..3be5315c 100644
--- a/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/AbstractStringLookup.java
@@ -55,7 +55,7 @@ abstract class AbstractStringLookup implements StringLookup {
*
* @param value The source string.
* @param ch The character to search.
- * @return a new string.
+ * @return A new string.
* @deprecated Use {@link StringUtils#substringAfter(String, int)}.
*/
@Deprecated
@@ -68,7 +68,7 @@ abstract class AbstractStringLookup implements StringLookup {
*
* @param value The source string.
* @param str The string to search.
- * @return a new string.
+ * @return A new string.
* @deprecated Use {@link StringUtils#substringAfter(String, String)}.
*/
@Deprecated
@@ -81,7 +81,7 @@ abstract class AbstractStringLookup implements StringLookup {
*
* @param value The source string.
* @param ch The character to search.
- * @return a new string.
+ * @return A new string.
* @deprecated Use {@link StringUtils#substringAfterLast(String, int)}.
*/
@Deprecated
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 1cc93ab8..655ae93f 100644
--- a/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/BiFunctionStringLookup.java
@@ -38,7 +38,7 @@ final class BiFunctionStringLookup<P, R> implements
BiStringLookup<P> {
*
* @param <T> The function's input type
* @param biFunction the function, may be null.
- * @return a new instance backed by the given function.
+ * @return A new instance backed by the given function.
*/
static <U, T> BiFunctionStringLookup<U, T> on(final BiFunction<String, U,
T> biFunction) {
return new BiFunctionStringLookup<>(biFunction);
@@ -49,7 +49,7 @@ final class BiFunctionStringLookup<P, R> implements
BiStringLookup<P> {
*
* @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.
+ * @return A new instance backed by the given map.
*/
static <U, T> BiFunctionStringLookup<U, T> on(final Map<String, T> map) {
return on((key, u) -> map.get(key));
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 db25a742..6808e387 100644
--- a/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/FunctionStringLookup.java
@@ -37,7 +37,7 @@ final class FunctionStringLookup<V> extends
AbstractStringLookup {
*
* @param <R> The function's input type
* @param function the function, may be null.
- * @return a new instance backed by the given function.
+ * @return A new instance backed by the given function.
*/
static <R> FunctionStringLookup<R> on(final Function<String, R> function) {
return new FunctionStringLookup<>(function);
@@ -48,7 +48,7 @@ final class FunctionStringLookup<V> extends
AbstractStringLookup {
*
* @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.
+ * @return A new instance backed by the given map.
*/
static <V> FunctionStringLookup<V> on(final Map<String, V> map) {
return on(StringLookupFactory.toMap(map)::get);
diff --git
a/src/main/java/org/apache/commons/text/lookup/IllegalArgumentExceptions.java
b/src/main/java/org/apache/commons/text/lookup/IllegalArgumentExceptions.java
index e52d5360..0cefdfb0 100644
---
a/src/main/java/org/apache/commons/text/lookup/IllegalArgumentExceptions.java
+++
b/src/main/java/org/apache/commons/text/lookup/IllegalArgumentExceptions.java
@@ -30,7 +30,7 @@ final class IllegalArgumentExceptions {
*
* @param format See {@link String#format(String,Object...)}.
* @param args See {@link String#format(String,Object...)}.
- * @return an {@link IllegalArgumentException} with a message formatted
with {@link String#format(String,Object...)}.
+ * @return An {@link IllegalArgumentException} with a message formatted
with {@link String#format(String,Object...)}.
*/
static IllegalArgumentException format(final String format, final
Object... args) {
return new IllegalArgumentException(String.format(format, args));
@@ -43,7 +43,7 @@ final class IllegalArgumentExceptions {
* @param t the throwable cause.
* @param format See {@link String#format(String,Object...)}.
* @param args See {@link String#format(String,Object...)}.
- * @return an {@link IllegalArgumentException} with a message formatted
with {@link String#format(String,Object...)}.
+ * @return An {@link IllegalArgumentException} with a message formatted
with {@link String#format(String,Object...)}.
*/
static IllegalArgumentException format(final Throwable t, final String
format, final Object... args) {
return new IllegalArgumentException(String.format(format, args), t);
diff --git
a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
index 2b280b98..d20fcac4 100644
--- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java
@@ -152,7 +152,7 @@ final class JavaPlatformStringLookup extends
AbstractStringLookup {
* Gets the given system property.
*
* @param name a system property name.
- * @return a system property value.
+ * @return A system property value.
*/
private String getSystemProperty(final String name) {
return StringLookupFactory.INSTANCE_SYSTEM_PROPERTIES.apply(name);
diff --git a/src/main/java/org/apache/commons/text/lookup/PathFence.java
b/src/main/java/org/apache/commons/text/lookup/PathFence.java
index 8f59a923..a1b749f3 100644
--- a/src/main/java/org/apache/commons/text/lookup/PathFence.java
+++ b/src/main/java/org/apache/commons/text/lookup/PathFence.java
@@ -65,7 +65,7 @@ final class PathFence {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
*/
static Builder builder() {
return new Builder();
@@ -89,7 +89,7 @@ final class PathFence {
* Gets a Path for the given file name checking that it resolves within
our fence.
*
* @param fileName the file name to resolve.
- * @return a fenced Path.
+ * @return A fenced Path.
* @throws IllegalArgumentException if the file name is not without our
fence.
*/
Path apply(final String fileName) {
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 c507d9cb..21ef4083 100644
--- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
+++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
@@ -600,7 +600,7 @@ public final class StringLookupFactory {
/**
* Constructs a new {@link Builder}.
*
- * @return a new {@link Builder}
+ * @return A new {@link Builder}
* @since 1.12.0
*/
public static Builder builder() {
@@ -763,7 +763,7 @@ public final class StringLookupFactory {
* @param <R> the function return type.
* @param <U> the function's second parameter type.
* @param biFunction the function.
- * @return a new MapStringLookup.
+ * @return A new MapStringLookup.
* @since 1.9
*/
public <R, U> BiStringLookup<U> biFunctionStringLookup(final
BiFunction<String, U, R> biFunction) {
@@ -956,7 +956,7 @@ public final class StringLookupFactory {
* The examples above convert {@code "UTF-8:com/domain/document.txt"} to
the contents of the file.
* </p>
*
- * @return a file StringLookup instance.
+ * @return A file StringLookup instance.
* @since 1.5
*/
public StringLookup fileStringLookup() {
@@ -987,7 +987,7 @@ public final class StringLookupFactory {
* </p>
*
* @param fences The fences guarding Path resolution.
- * @return a file StringLookup instance.
+ * @return A file StringLookup instance.
* @since 1.12.0
*/
public StringLookup fileStringLookup(final Path... fences) {
@@ -999,7 +999,7 @@ public final class StringLookupFactory {
*
* @param <R> the function return type.
* @param function the function.
- * @return a new MapStringLookup.
+ * @return A new MapStringLookup.
* @since 1.9
*/
public <R> StringLookup functionStringLookup(final Function<String, R>
function) {
@@ -1042,7 +1042,7 @@ public final class StringLookupFactory {
* @param defaultStringLookup the default string lookup; this lookup is
used when a variable cannot be resolved using the lookups in {@code
stringLookupMap}
* or the configured default lookups (if
enabled)
* @param addDefaultLookups whether to use default lookups as described
above.
- * @return a new InterpolatorStringLookup.
+ * @return A new InterpolatorStringLookup.
* @since 1.4
*/
public StringLookup interpolatorStringLookup(final Map<String,
StringLookup> stringLookupMap, final StringLookup defaultStringLookup,
@@ -1056,7 +1056,7 @@ public final class StringLookupFactory {
*
* @param <V> The value type the default string lookup's map.
* @param map the default map for string lookups.
- * @return a new InterpolatorStringLookup.
+ * @return A new InterpolatorStringLookup.
*/
public <V> StringLookup interpolatorStringLookup(final Map<String, V> map)
{
return new InterpolatorStringLookup(map);
@@ -1067,7 +1067,7 @@ public final class StringLookupFactory {
* variables. (See the class documentation for details on how default
lookups are configured.)
*
* @param defaultStringLookup the default string lookup.
- * @return a new InterpolatorStringLookup.
+ * @return A new InterpolatorStringLookup.
*/
public StringLookup interpolatorStringLookup(final StringLookup
defaultStringLookup) {
return new InterpolatorStringLookup(defaultStringLookup);
@@ -1180,7 +1180,7 @@ public final class StringLookupFactory {
*
* @param <V> The map value type.
* @param map the map.
- * @return a new MapStringLookup.
+ * @return A new MapStringLookup.
*/
public <V> StringLookup mapStringLookup(final Map<String, V> map) {
return FunctionStringLookup.on(map);
@@ -1262,7 +1262,7 @@ public final class StringLookupFactory {
* {@code "com/domain/document.properties"}.
* </p>
*
- * @return a Properties StringLookup instance.
+ * @return A Properties StringLookup instance.
* @since 1.5
*/
public StringLookup propertiesStringLookup() {
@@ -1303,7 +1303,7 @@ public final class StringLookupFactory {
* </p>
*
* @param fences The fences guarding Path resolution.
- * @return a Properties StringLookup instance.
+ * @return A Properties StringLookup instance.
* @since 1.12.0
*/
public StringLookup propertiesStringLookup(final Path... fences) {
@@ -1362,7 +1362,7 @@ public final class StringLookupFactory {
* </p>
*
* @param bundleName Only lookup in this bundle.
- * @return a ResourceBundleStringLookup instance for the given bundle name.
+ * @return A ResourceBundleStringLookup instance for the given bundle name.
* @since 1.5
*/
public StringLookup resourceBundleStringLookup(final String bundleName) {
diff --git a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
index 8fb104ee..cc1f1019 100644
--- a/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
+++ b/src/main/java/org/apache/commons/text/matcher/StringMatcher.java
@@ -30,7 +30,7 @@ public interface StringMatcher {
* Returns a matcher that matches this matcher followed by the given
matcher.
*
* @param stringMatcher the next matcher.
- * @return a matcher that matches this matcher followed by the given
matcher.
+ * @return A matcher that matches this matcher followed by the given
matcher.
* @since 1.9
*/
default StringMatcher andThen(final StringMatcher stringMatcher) {
diff --git
a/src/main/java/org/apache/commons/text/matcher/StringMatcherFactory.java
b/src/main/java/org/apache/commons/text/matcher/StringMatcherFactory.java
index b3c12265..8bb9fee5 100644
--- a/src/main/java/org/apache/commons/text/matcher/StringMatcherFactory.java
+++ b/src/main/java/org/apache/commons/text/matcher/StringMatcherFactory.java
@@ -92,7 +92,7 @@ public final class StringMatcherFactory {
* Creates a matcher that matches all of the given matchers in order.
*
* @param stringMatchers the matcher.
- * @return a matcher that matches all of the given matchers in order.
+ * @return A matcher that matches all of the given matchers in order.
* @since 1.9
*/
public StringMatcher andMatcher(final StringMatcher... stringMatchers) {
@@ -110,7 +110,7 @@ public final class StringMatcherFactory {
* Constructor that creates a matcher from a character.
*
* @param ch the character to match, must not be null.
- * @return a new Matcher for the given char.
+ * @return A new Matcher for the given char.
*/
public StringMatcher charMatcher(final char ch) {
return new AbstractStringMatcher.CharMatcher(ch);
@@ -120,7 +120,7 @@ public final class StringMatcherFactory {
* Constructor that creates a matcher from a set of characters.
*
* @param chars the characters to match, null or empty matches nothing.
- * @return a new matcher for the given char[].
+ * @return A new matcher for the given char[].
*/
public StringMatcher charSetMatcher(final char... chars) {
final int len = ArrayUtils.getLength(chars);
@@ -137,7 +137,7 @@ public final class StringMatcherFactory {
* Creates a matcher from a string representing a set of characters.
*
* @param chars the characters to match, null or empty matches nothing.
- * @return a new Matcher for the given characters.
+ * @return A new Matcher for the given characters.
*/
public StringMatcher charSetMatcher(final String chars) {
final int len = StringUtils.length(chars);
@@ -153,7 +153,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the comma character.
*
- * @return a matcher for a comma.
+ * @return A matcher for a comma.
*/
public StringMatcher commaMatcher() {
return COMMA_MATCHER;
@@ -162,7 +162,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the double quote character.
*
- * @return a matcher for a double quote.
+ * @return A matcher for a double quote.
*/
public StringMatcher doubleQuoteMatcher() {
return DOUBLE_QUOTE_MATCHER;
@@ -171,7 +171,7 @@ public final class StringMatcherFactory {
/**
* Matches no characters.
*
- * @return a matcher that matches nothing.
+ * @return A matcher that matches nothing.
*/
public StringMatcher noneMatcher() {
return NONE_MATCHER;
@@ -180,7 +180,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the single or double quote character.
*
- * @return a matcher for a single or double quote.
+ * @return A matcher for a single or double quote.
*/
public StringMatcher quoteMatcher() {
return QUOTE_MATCHER;
@@ -189,7 +189,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the single quote character.
*
- * @return a matcher for a single quote.
+ * @return A matcher for a single quote.
*/
public StringMatcher singleQuoteMatcher() {
return SINGLE_QUOTE_MATCHER;
@@ -198,7 +198,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the space character.
*
- * @return a matcher for a space.
+ * @return A matcher for a space.
*/
public StringMatcher spaceMatcher() {
return SPACE_MATCHER;
@@ -217,7 +217,7 @@ public final class StringMatcherFactory {
* Creates a matcher from a string.
*
* @param chars the string to match, null or empty matches nothing.
- * @return a new Matcher for the given String.
+ * @return A new Matcher for the given String.
* @since 1.9
*/
public StringMatcher stringMatcher(final char... chars) {
@@ -231,7 +231,7 @@ public final class StringMatcherFactory {
* Creates a matcher from a string.
*
* @param str the string to match, null or empty matches nothing.
- * @return a new Matcher for the given String.
+ * @return A new Matcher for the given String.
*/
public StringMatcher stringMatcher(final String str) {
return StringUtils.isEmpty(str) ? NONE_MATCHER :
stringMatcher(str.toCharArray());
@@ -240,7 +240,7 @@ public final class StringMatcherFactory {
/**
* Returns a matcher which matches the tab character.
*
- * @return a matcher for a tab.
+ * @return A matcher for a tab.
*/
public StringMatcher tabMatcher() {
return TAB_MATCHER;
diff --git a/src/main/java/org/apache/commons/text/numbers/DoubleFormat.java
b/src/main/java/org/apache/commons/text/numbers/DoubleFormat.java
index 01b0076c..216ed09c 100644
--- a/src/main/java/org/apache/commons/text/numbers/DoubleFormat.java
+++ b/src/main/java/org/apache/commons/text/numbers/DoubleFormat.java
@@ -269,7 +269,7 @@ public enum DoubleFormat {
* Returns a formatted representation of the given rounded decimal
value to {@code dst}.
*
* @param val value to format.
- * @return a formatted representation of the given rounded decimal
value to {@code dst}.
+ * @return A formatted representation of the given rounded decimal
value to {@code dst}.
*/
protected abstract String applyFiniteInternal(ParsedDecimal val);
@@ -526,7 +526,7 @@ public enum DoubleFormat {
/**
* Builds a new double format function.
*
- * @return a new double format function.
+ * @return A new double format function.
*/
@Override
public DoubleFunction<String> get() {
diff --git a/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
b/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
index a9bb59a0..02754f9e 100644
--- a/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
+++ b/src/main/java/org/apache/commons/text/numbers/ParsedDecimal.java
@@ -145,7 +145,7 @@ final class ParsedDecimal {
* Constructs a new instance from the given double value.
*
* @param d double value.
- * @return a new instance containing the parsed components of the given
double value.
+ * @return A new instance containing the parsed components of the given
double value.
* @throws IllegalArgumentException if {@code d} is {@code NaN} or
infinite.
*/
public static ParsedDecimal from(final double d) {
diff --git a/src/main/java/org/apache/commons/text/similarity/Counter.java
b/src/main/java/org/apache/commons/text/similarity/Counter.java
index 908bf9ed..400989a8 100644
--- a/src/main/java/org/apache/commons/text/similarity/Counter.java
+++ b/src/main/java/org/apache/commons/text/similarity/Counter.java
@@ -38,7 +38,7 @@ final class Counter {
* returns a map with the element as key and the count as value.
*
* @param tokens array of tokens.
- * @return a map, where the elements are key, and the count the value.
+ * @return A map, where the elements are key, and the count the value.
*/
public static Map<CharSequence, Integer> of(final CharSequence[] tokens) {
final Map<CharSequence, Integer> map = new HashMap<>();
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 aa6b6b2a..139703f7 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityInput.java
@@ -34,7 +34,7 @@ public interface SimilarityInput<E> {
* Creates a new input for a {@link CharSequence}.
*
* @param cs input character sequence.
- * @return a new input.
+ * @return A new input.
*/
static SimilarityInput<Character> input(final CharSequence cs) {
return new SimilarityCharacterInput(cs);
@@ -45,7 +45,7 @@ public interface SimilarityInput<E> {
*
* @param <T> The type of similarity score unit.
* @param input character sequence or similarity input.
- * @return a new input.
+ * @return A new input.
* @throws IllegalArgumentException when the input type is neither {@link
CharSequence} or {@link SimilarityInput}.
*/
@SuppressWarnings("unchecked")
