+ * Client code should specify a registry * of {@code FormatFactory} instances associated with {@code 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 {@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):
+ * embedded in the message pattern is specified (()? signifies optionality): + *

* {@code {}argument-number({@code ,}format-name * ({@code ,}format-style)?)?{@code }} + *

* format-name and format-style values are trimmed of surrounding whitespace diff --git a/src/main/java/org/apache/commons/text/StrBuilder.java b/src/main/java/org/apache/commons/text/StrBuilder.java index fce069d001..f1df60a2a2 100644 --- a/src/main/java/org/apache/commons/text/StrBuilder.java +++ b/src/main/java/org/apache/commons/text/StrBuilder.java @@ -376,7 +376,7 @@ public StrBuilder append(final char[] chars, final int startIndex, final int len return appendNull(); } if (startIndex < 0 || startIndex > chars.length) { - throw new StringIndexOutOfBoundsException("Invalid startIndex: " + length); + throw new StringIndexOutOfBoundsException("Invalid startIndex: " + startIndex); } if (length < 0 || startIndex + length > chars.length) { throw new StringIndexOutOfBoundsException("Invalid length: " + length); diff --git a/src/main/java/org/apache/commons/text/StrTokenizer.java b/src/main/java/org/apache/commons/text/StrTokenizer.java index 66ede10fd3..9d757234e5 100644 --- a/src/main/java/org/apache/commons/text/StrTokenizer.java +++ b/src/main/java/org/apache/commons/text/StrTokenizer.java @@ -389,6 +389,7 @@ public StrTokenizer(final String input, final StrMatcher delim, final StrMatcher /** * Unsupported ListIterator operation. + * * @param obj this parameter ignored. * @throws UnsupportedOperationException always. */ diff --git a/src/main/java/org/apache/commons/text/StringEscapeUtils.java b/src/main/java/org/apache/commons/text/StringEscapeUtils.java index b9ee6e0e75..700ca95690 100644 --- a/src/main/java/org/apache/commons/text/StringEscapeUtils.java +++ b/src/main/java/org/apache/commons/text/StringEscapeUtils.java @@ -122,6 +122,7 @@ public String toString() { return sb.toString(); } } + /** * Translator object for unescaping backslash escaped entries. */ @@ -323,6 +324,7 @@ public int translate(final CharSequence input, final int index, final Writer wri new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE), new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE) ); + /** * Translator object for escaping individual Comma Separated Values. * @@ -562,7 +564,6 @@ public static String escapeHtml3(final String input) { return ESCAPE_HTML3.translate(input); } - // HTML and XML /** * Escapes the characters in a {@code String} using HTML entities. * @@ -591,7 +592,6 @@ public static String escapeHtml4(final String input) { return ESCAPE_HTML4.translate(input); } - // Java and JavaScript /** * Escapes the characters in a {@code String} using Java String rules. * diff --git a/src/main/java/org/apache/commons/text/StringSubstitutor.java b/src/main/java/org/apache/commons/text/StringSubstitutor.java index d794c2999c..3667e91529 100644 --- a/src/main/java/org/apache/commons/text/StringSubstitutor.java +++ b/src/main/java/org/apache/commons/text/StringSubstitutor.java @@ -671,7 +671,6 @@ private void checkCyclicSubstitution(final String varName, final List pr throw new IllegalStateException(buf.toString()); } - // Escape /** * Returns the escape character. * diff --git a/src/main/java/org/apache/commons/text/TextRandomProvider.java b/src/main/java/org/apache/commons/text/TextRandomProvider.java index 84eb843db3..82477d6b89 100644 --- a/src/main/java/org/apache/commons/text/TextRandomProvider.java +++ b/src/main/java/org/apache/commons/text/TextRandomProvider.java @@ -39,6 +39,7 @@ * .build(); * } * + * * @since 1.1 */ public interface TextRandomProvider extends IntUnaryOperator { diff --git a/src/main/java/org/apache/commons/text/TextStringBuilder.java b/src/main/java/org/apache/commons/text/TextStringBuilder.java index b3ea8585f7..2977fa3232 100644 --- a/src/main/java/org/apache/commons/text/TextStringBuilder.java +++ b/src/main/java/org/apache/commons/text/TextStringBuilder.java @@ -483,7 +483,7 @@ public TextStringBuilder append(final char[] chars, final int startIndex, final return appendNull(); } if (startIndex < 0 || startIndex > chars.length) { - throw new StringIndexOutOfBoundsException("Invalid startIndex: " + length); + throw new StringIndexOutOfBoundsException("Invalid startIndex: " + startIndex); } if (length < 0 || startIndex + length > chars.length) { throw new StringIndexOutOfBoundsException("Invalid length: " + length); diff --git a/src/main/java/org/apache/commons/text/WordUtils.java b/src/main/java/org/apache/commons/text/WordUtils.java index ca41c6c3c3..720ca5f98c 100644 --- a/src/main/java/org/apache/commons/text/WordUtils.java +++ b/src/main/java/org/apache/commons/text/WordUtils.java @@ -779,6 +779,7 @@ public static String wrap(final String str, * "flammable\ninflammable" * * + * * @param str the String to be word wrapped, may be null. * @param wrapLength the column to wrap the words at, less than 1 is treated as 1. * @param newLineStr the string to insert for a new line, {@code null} uses the system property line separator. diff --git a/src/main/java/org/apache/commons/text/diff/EditCommand.java b/src/main/java/org/apache/commons/text/diff/EditCommand.java index ddcfbedec3..30cb38c4c2 100644 --- a/src/main/java/org/apache/commons/text/diff/EditCommand.java +++ b/src/main/java/org/apache/commons/text/diff/EditCommand.java @@ -17,7 +17,7 @@ package org.apache.commons.text.diff; /** - * Abstract base class for all commands used to transform an objects sequence + * Abstract class for all commands used to transform an objects sequence * into another one. *

* When two objects sequences are compared through the diff --git a/src/main/java/org/apache/commons/text/diff/StringsComparator.java b/src/main/java/org/apache/commons/text/diff/StringsComparator.java index 9f9813a959..2f530650ac 100644 --- a/src/main/java/org/apache/commons/text/diff/StringsComparator.java +++ b/src/main/java/org/apache/commons/text/diff/StringsComparator.java @@ -106,14 +106,17 @@ public int getStart() { return start; } } + /** * First character sequence. */ private final String left; + /** * Second character sequence. */ private final String right; + /** * Temporary array. */ 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 faf01ee9cb..2b280b9819 100644 --- a/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java +++ b/src/main/java/org/apache/commons/text/lookup/JavaPlatformStringLookup.java @@ -66,14 +66,19 @@ final class JavaPlatformStringLookup extends AbstractStringLookup { * Defines the singleton for this class. */ static final JavaPlatformStringLookup INSTANCE = new JavaPlatformStringLookup(); + /** {@code hardware} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */ private static final String KEY_HARDWARE = "hardware"; + /** {@code locale} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */ private static final String KEY_LOCALE = "locale"; + /** {@code os} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */ private static final String KEY_OS = "os"; + /** {@code runtime} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */ private static final String KEY_RUNTIME = "runtime"; + /** {@code version} key for driving {@link JavaPlatformStringLookup#lookup(String)}. */ private static final String KEY_VERSION = "version"; diff --git a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java index ac7b4018aa..8ea040098d 100644 --- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java +++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java @@ -132,7 +132,7 @@ public static LevenshteinDetailedDistance getDefaultInstance() { * *

* This implementation follows from Algorithms on Strings, Trees and Sequences by Dan Gusfield and Chas Emerick's implementation of the Levenshtein distance - * algorithm from http://www.merriampark.com/ld.htm + * algorithm. *

@@ -271,15 +271,8 @@ private static  LevenshteinResults limitedCompare(SimilarityInput left, Si
      * 

      *
      * 

-     * The previous implementation of the Levenshtein distance algorithm was from
-     * http://www.merriampark.com/ld.htm
-     * 
-     *
-     * 

      * Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large
-     * strings.

-     * This implementation of the Levenshtein distance algorithm is from
-     * http://www.merriampark.com/ldjava.htm
+     * strings.
      * 
      *
      * 
@@ -414,15 +407,8 @@ public LevenshteinDetailedDistance(final Integer threshold) {
      * 

      *
      * 

-     * The previous implementation of the Levenshtein distance algorithm was from
-     * http://www.merriampark.com/ld.htm
-     * 
-     *
-     * 

      * Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large
-     * strings.

-     * This implementation of the Levenshtein distance algorithm is from
-     * http://www.merriampark.com/ldjava.htm
+     * strings.
      * 
      *
      * 
@@ -457,15 +443,8 @@ public LevenshteinResults apply(final CharSequence left, final CharSequence righ
      * 

      *
      * 

-     * The previous implementation of the Levenshtein distance algorithm was from
-     * http://www.merriampark.com/ld.htm
-     * 
-     *
-     * 

      * Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large
-     * strings.

-     * This implementation of the Levenshtein distance algorithm is from
-     * http://www.merriampark.com/ldjava.htm
+     * strings.
      * 
      *
      * 
diff --git a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
index 8ab60eeec8..479b3fadea 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
@@ -55,7 +55,7 @@ public static LevenshteinDistance getDefaultInstance() {
      *
      * 

      * This implementation follows from Algorithms on Strings, Trees and Sequences by Dan Gusfield and Chas Emerick's implementation of the Levenshtein distance
-     * algorithm from http://www.merriampark.com/ld.htm
+     * algorithm.
      * 
      *
      * 
@@ -204,12 +204,6 @@ private static  int limitedCompare(SimilarityInput left, SimilarityInput

      *
      * 

-     * The previous implementation of the Levenshtein distance algorithm was from
-     * 
-     * https://web.archive.org/web/20120526085419/http://www.merriampark.com/ldjava.htm
-     * 
-     *
-     * 

      * This implementation only need one single-dimensional arrays of length s.length() + 1
      * 
      *
@@ -320,15 +314,8 @@ public LevenshteinDistance(final Integer threshold) {
      * 

      *
      * 

-     * The previous implementation of the Levenshtein distance algorithm was from
-     * http://www.merriampark.com/ld.htm
-     * 
-     *
-     * 

      * Chas Emerick has written an implementation in Java, which avoids an OutOfMemoryError which can occur when my Java implementation is used with very large
-     * strings.

-     * This implementation of the Levenshtein distance algorithm is from
-     * http://www.merriampark.com/ldjava.htm
+     * strings.
      * 
      *
      * 
diff --git a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
index 9a5f467136..b116e50eac 100644
--- a/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
+++ b/src/main/java/org/apache/commons/text/translate/CsvTranslators.java
@@ -59,6 +59,7 @@ void translateWhole(final CharSequence input, final Writer writer) throws IOExce
             }
         }
     }
+
     /**
      * Translator for unescaping escaped Comma Separated Value entries.
      */
@@ -90,10 +91,13 @@ void translateWhole(final CharSequence input, final Writer writer) throws IOExce
             }
         }
     }
+
     /** Comma character. */
     private static final char CSV_DELIMITER = ',';
+
     /** Quote character. */
     private static final char CSV_QUOTE = '"';
+
     /** Quote character converted to string. */
     private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);
 
diff --git a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
index 931344c55e..18f2f09287 100644
--- a/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/LookupTranslator.java
@@ -33,10 +33,13 @@ public class LookupTranslator extends CharSequenceTranslator {
 
     /** The mapping to be used in translation. */
     private final Map lookupMap;
+
     /** The first character of each key in the lookupMap. */
     private final BitSet prefixSet;
+
     /** The length of the shortest key in the lookupMap. */
     private final int shortest;
+
     /** The length of the longest key in the lookupMap. */
     private final int longest;
 
diff --git a/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java b/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
index 90dd7f23bc..2fd4f67100 100644
--- a/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
+++ b/src/main/java/org/apache/commons/text/translate/SinglePassTranslator.java
@@ -37,6 +37,7 @@ private String getClassName() {
 
     /**
      * {@inheritDoc}
+     *
      * @throws IllegalArgumentException if {@code index != 0}.
      */
     @Override
diff --git a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
index a2e2c75157..cea0dcbbaa 100644
--- a/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
+++ b/src/main/java/org/apache/commons/text/translate/UnicodeEscaper.java
@@ -35,6 +35,7 @@ public class UnicodeEscaper extends CodePointTranslator {
     public static UnicodeEscaper above(final int codePoint) {
         return outsideOf(0, codePoint);
     }
+
     /**
      * Constructs a {@code UnicodeEscaper} below the specified value (exclusive).
      *
@@ -44,6 +45,7 @@ public static UnicodeEscaper above(final int codePoint) {
     public static UnicodeEscaper below(final int codePoint) {
         return outsideOf(codePoint, Integer.MAX_VALUE);
     }
+
     /**
      * Constructs a {@code UnicodeEscaper} between the specified values (inclusive).
      *
diff --git a/src/site/xdoc/security.xml b/src/site/xdoc/security.xml
index b211fd77bd..150584ad35 100644
--- a/src/site/xdoc/security.xml
+++ b/src/site/xdoc/security.xml
@@ -114,5 +114,10 @@
                 

             
         
-    
+    

+      

+      For information about safe deserialization, please see Safe Deserialization.
+      
+    
+  
 
diff --git a/src/test/java/org/apache/commons/text/StrBuilderTest.java b/src/test/java/org/apache/commons/text/StrBuilderTest.java
index 6ae331e931..6d7de7e527 100644
--- a/src/test/java/org/apache/commons/text/StrBuilderTest.java
+++ b/src/test/java/org/apache/commons/text/StrBuilderTest.java
@@ -834,6 +834,16 @@ void testEqualsIgnoreCase() {
         assertTrue(sb1.equalsIgnoreCase(sb2));
     }
 
+    @Test
+    void testErrorMessageShowsCorrectVariable() {
+        final StrBuilder sb = new StrBuilder("Hello");
+        final char[] chars = { 'a', 'b', 'c' };
+        StringIndexOutOfBoundsException ex = assertThrows(StringIndexOutOfBoundsException.class, () -> sb.append(chars, 1, 4));
+        assertTrue(ex.getMessage().contains("length: 4"));
+        ex = assertThrows(StringIndexOutOfBoundsException.class, () -> sb.append(chars, 7, 3));
+        assertTrue(ex.getMessage().contains("startIndex: 7"));
+    }
+
     @Test
     void testGetChars() {
         final StrBuilder sb = new StrBuilder();
@@ -2016,5 +2026,4 @@ void testTrim() {
         sb.clear().append("a b c");
         assertEquals("a b c", sb.trim().toString());
     }
-
 }
diff --git a/src/test/java/org/apache/commons/text/TextStringBuilderTest.java b/src/test/java/org/apache/commons/text/TextStringBuilderTest.java
index 1900c19d68..649fc4ea71 100644
--- a/src/test/java/org/apache/commons/text/TextStringBuilderTest.java
+++ b/src/test/java/org/apache/commons/text/TextStringBuilderTest.java
@@ -989,6 +989,16 @@ void testEqualsIgnoreCase() {
         // TextStringBuilder("title".toUpperCase(turkish))));
     }
 
+    @Test
+    void testErrorMessageShowsCorrectVariable() {
+        final TextStringBuilder sb = new TextStringBuilder("Hello");
+        final char[] chars = { 'a', 'b', 'c' };
+        StringIndexOutOfBoundsException ex = assertThrows(StringIndexOutOfBoundsException.class, () -> sb.append(chars, 1, 4));
+        assertTrue(ex.getMessage().contains("length: 4"));
+        ex = assertThrows(StringIndexOutOfBoundsException.class, () -> sb.append(chars, 7, 3));
+        assertTrue(ex.getMessage().contains("startIndex: 7"));
+    }
+
     @Test
     void testGetChars() {
         final TextStringBuilder sb = new TextStringBuilder();
@@ -2392,5 +2402,4 @@ void testWrap_CharArray_Int_Exceptions() {
         assertThrows(IllegalArgumentException.class, () -> TextStringBuilder.wrap("abc".toCharArray(), -1));
         assertThrows(IllegalArgumentException.class, () -> TextStringBuilder.wrap(ArrayUtils.EMPTY_CHAR_ARRAY, 1));
     }
-
 }
diff --git a/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java b/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
index 49d1318ed3..b726616519 100644
--- a/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
+++ b/src/test/java/org/apache/commons/text/jmh/LongestCommonSubsequencePerformance.java
@@ -49,6 +49,7 @@
 @Measurement(iterations = 5, time = 1)
 @Fork(value = 1, jvmArgs = {"-server", "-Xms512M", "-Xmx512M"})
 public class LongestCommonSubsequencePerformance {
+
     /**
      * Older implementation of LongestCommonSubsequence.
      * Code is copied from Apache Commons Text version 1.10.0-SNAPSHOT