diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 4cbe168c3e..9ff35c83e7 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -23,7 +23,7 @@ Before you push a pull request, review this list:
- [ ] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
- [ ] Read the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) if you use Artificial Intelligence (AI).
-- [ ] I used AI to create any part of, or all of, this pull request.
+- [ ] I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
- [ ] Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself.
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index b47769e0ee..e072e3dd79 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -37,6 +37,7 @@ jobs:
security-events: write
strategy:
+ max-parallel: 20
fail-fast: false
matrix:
language: [ 'java' ]
@@ -45,10 +46,10 @@ jobs:
steps:
- name: Checkout repository
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- - uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
+ - uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 #v5.0.3
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -57,7 +58,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
- uses: github/codeql-action/init@fe4161a26a8629af62121b670040955b330f9af2 # v4.31.6
+ uses: github/codeql-action/init@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
@@ -68,7 +69,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
- uses: github/codeql-action/autobuild@fe4161a26a8629af62121b670040955b330f9af2 # v4.31.6
+ uses: github/codeql-action/autobuild@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
@@ -82,4 +83,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@fe4161a26a8629af62121b670040955b330f9af2 # v4.31.6
+ uses: github/codeql-action/analyze@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
index 1df8666044..a04da50909 100644
--- a/.github/workflows/dependency-review.yml
+++ b/.github/workflows/dependency-review.yml
@@ -26,6 +26,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: 'Checkout Repository'
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- name: 'Dependency Review PR'
uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # v4.8.2
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index 30ddf451ed..ca5362ba4e 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -26,6 +26,7 @@ jobs:
runs-on: ubuntu-latest
continue-on-error: ${{ matrix.experimental }}
strategy:
+ max-parallel: 20
matrix:
java: [ 8, 11, 17, 21, 25 ]
experimental: [false]
@@ -34,11 +35,11 @@ jobs:
experimental: true
steps:
- - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set up JDK ${{ matrix.java }}
- uses: actions/setup-java@f2beeb24e141e01a676f977032f5a29d81c9e27e # v5.1.0
+ uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
with:
distribution: 'temurin'
java-version: ${{ matrix.java }}
diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml
index bcb94cd7f5..7182c34001 100644
--- a/.github/workflows/scorecards-analysis.yml
+++ b/.github/workflows/scorecards-analysis.yml
@@ -40,7 +40,7 @@ jobs:
steps:
- name: "Checkout code"
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+ uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
@@ -57,13 +57,13 @@ jobs:
publish_results: true
- name: "Upload artifact"
- uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0
+ uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
with:
name: SARIF file
path: results.sarif
retention-days: 5
- name: "Upload to code-scanning"
- uses: github/codeql-action/upload-sarif@fe4161a26a8629af62121b670040955b330f9af2 # v4.31.6
+ uses: github/codeql-action/upload-sarif@c6f931105cb2c34c8f901cc885ba1e2e259cf745 # v4.34.0
with:
sarif_file: results.sarif
diff --git a/.gitignore b/.gitignore
index 03ca919d66..c5860d17e9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -19,3 +19,7 @@ site-content
.externalToolBuilders
/.checkstyle
/.DS_Store
+
+# NetBeans files
+nb-configuration.xml
+nbactions.xml
diff --git a/NOTICE.txt b/NOTICE.txt
index 0c73fbda69..167fda3832 100644
--- a/NOTICE.txt
+++ b/NOTICE.txt
@@ -1,5 +1,5 @@
Apache Commons Text
-Copyright 2014-2025 The Apache Software Foundation
+Copyright 2014-2026 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (https://www.apache.org/).
diff --git a/README.md b/README.md
index 81333cf313..3cd07a15d7 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,7 @@ Apache Commons Text
[](https://github.com/apache/commons-text/actions/workflows/maven.yml)
[](https://search.maven.org/artifact/org.apache.commons/commons-text)
-[](https://javadoc.io/doc/org.apache.commons/commons-text/1.14.0)
+[](https://javadoc.io/doc/org.apache.commons/commons-text/1.15.0)
[](https://github.com/apache/commons-text/actions/workflows/codeql-analysis.yml)
[](https://api.securityscorecards.dev/projects/github.com/apache/commons-text)
@@ -69,7 +69,7 @@ Alternatively, you can pull it from the central Maven repositories:
org.apache.commonscommons-text
- 1.14.0
+ 1.15.0
```
@@ -90,7 +90,7 @@ There are some guidelines which will make applying PRs easier for us:
+ Respect the existing code style for each file.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
-+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
++ Before you push a PR, run `mvn` (without arguments). This runs the default goal which contains all build checks.
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco`
If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index f3e1471648..f299b31453 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -14,8 +14,63 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+Apache Commons Text 1.15.0 Release Notes
+----------------------------------------
+
+The Apache Commons Text team is pleased to announce the release of Apache Commons Text 1.15.0.
+
+Apache Commons Text is a set of utility functions and reusable components for processing
+and manipulating text in a Java environment.
+
+Release 1.15.0. This is a feature and maintenance release. Java 8 or later is required.
+
+
+New features
+------------
+
+* Add experimental CycloneDX VEX file #683. Thanks to Piotr P. Karwasz, Gary Gregory.
+* TEXT-235: Add Damerau-Levenshtein distance #687. Thanks to LorgeN, Gary Gregory.
+* Add unit tests to increase coverage #719. Thanks to Michael Hausegger, Gary Gregory.
+* Add new test for CharSequenceTranslator#with() #725. Thanks to Michael Hausegger, Gary Gregory.
+* Add tests and assertions to org.apache.commons.text.similarity to get to 100% code coverage #727, #728. Thanks to Michael Hausegger.
+
+Fixed Bugs
+----------
+
+* Fix exception message typo in XmlStringLookup.XmlStringLookup(Map, Path...). Thanks to Gary Gregory.
+* TEXT-236: Inserting at the end of a TextStringBuilder throws a StringIndexOutOfBoundsException. Thanks to Pierre Post, Sumit Bera, Alex Herbert, Gary Gregory.
+* Fix TextStringBuilderTest.testAppendToCharBuffer() to use proper argument type #724. Thanks to Michael Hausegger.
+* Fix Apache RAT plugin console warnings. Thanks to Gary Gregory.
+* Fix site XML to use version 2.0.0 XML schema. Thanks to Gary Gregory.
+* Removed unreachable threshold verification code in src/main/java/org/apache/commons/text/similarity #730. Thanks to Michael Hausegger.
+* Enable secure processing for the XML parser in XmlStringLookup in case the underlying JAXP implementation doesn't #729. Thanks to 김민재 (minjas0507), Gary Gregory, Piotr Karwasz.
+
+Changes
+-------
+
+* Bump org.apache.commons:commons-parent from 85 to 93 #704, #723, #726. Thanks to Gary Gregory.
+* Bump commons.bytebuddy.version from 1.17.6 to 1.18.2 #696, #722. Thanks to Gary Gregory.
+* Bump graalvm.version from 24.2.2 to 25.0.1 #703, #716. Thanks to Gary Gregory, Dependabot.
+* Bump org.apache.commons:commons-lang3 from 3.18.0 to 3.20.0. Thanks to Gary Gregory.
+* Bump commons-io:commons-io from 2.20.0 to 2.21.0. Thanks to Gary Gregory.
+
+
+Historical list of changes: https://commons.apache.org/proper/commons-text/changes.html
+
+For complete information on Apache Commons Text, including instructions on how to submit bug reports,
+patches, or suggestions for improvement, see the Apache Commons Text website:
+
+https://commons.apache.org/proper/commons-text
+
+Download page: https://commons.apache.org/proper/commons-text/download_text.cgi
+
+Have fun!
+-Apache Commons Team
+
+-----------------------------------------------------------------------------
+
Apache Commons Text 1.14.0 Release Notes
-------------------------------------------------
+----------------------------------------
The Apache Commons Text team is pleased to announce the release of Apache Commons Text 1.14.0.
@@ -327,7 +382,7 @@ New features
* TEXT-207: Add DoubleFormat utility.
* TEXT-190: Document negative limit for WordUtils abbreviate method Thanks to Benjamin Bing.
-* TEXT-188: Speed up LevenshteinDistance with threshold by exiting early Thanks to Jakob Vesterstrm.
+* TEXT-188: Speed up LevenshteinDistance with threshold by exiting early Thanks to Jakob Vesterstrøm.
* TEXT-185: Release Notes page hasn't been updated for 1.9 release yet. Thanks to Larry West, Gary Gregory.
* Add StrBuilder.isNotEmpty(). Thanks to Gary Gregory.
diff --git a/pom.xml b/pom.xml
index bcab4f571a..bc8e9a9200 100644
--- a/pom.xml
+++ b/pom.xml
@@ -20,10 +20,10 @@
org.apache.commonscommons-parent
- 93
+ 97commons-text
- 1.15.0-SNAPSHOT
+ 1.15.1-SNAPSHOTApache Commons TextApache Commons Text is a set of utility functions and reusable components for processing
and manipulating text in a Java environment.
@@ -33,14 +33,14 @@
ISO-8859-1UTF-8
- 2025-07-24T12:03:40Z
+ 2025-12-07T22:18:14Z1.81.8texttextorg.apache.commons.text
- 1.15.0
- 1.15.1
+ 1.15.01
+ 1.15.2(Java 8+)TEXT12318221
@@ -48,7 +48,7 @@
https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-textsite-content3.20.0
- 1.18.2
+ 1.18.71.6false1.37
@@ -61,7 +61,7 @@
- 1.14.0
+ 1.15.0RC1truescm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}
@@ -72,13 +72,14 @@
commons.releaseManagerKey
-->
+
true1.00
- 0.97
- 0.98
+ 0.99
+ 0.990.95
- 0.94
- 0.98
+ 0.99
+ 0.97
@@ -135,6 +136,12 @@
${jmh.version}test
+
+ org.apache.commons
+ commons-csv
+ 1.14.1
+ test
+ clean verify apache-rat:check japicmp:cmp checkstyle:check pmd:check spotbugs:check javadoc:javadoc
@@ -149,7 +156,6 @@
src/site/resources/download_text.cgisrc/site/resources/release-notes/RELEASE-NOTES-*.txtsrc/test/resources/org/apache/commons/text/stringEscapeUtilsTestData.txt
- src/test/resources/org/apache/commons/text/lcs-perf-analysis-inputs.csvsrc/test/resources/org/apache/commons/text/oss-fuzz/**
@@ -598,13 +604,45 @@
+
benchmarktrueorg.apache
+
+
+ org.openjdk.jmh
+ jmh-core
+ ${commons.jmh.version}
+ test
+
+
+ org.openjdk.jmh
+ jmh-generator-annprocess
+ ${commons.jmh.version}
+ test
+
+
+ org.apache.commons
+ commons-collections4
+ 4.5.0
+ test
+
+
+
+
+ maven-compiler-plugin
+ ${commons.compiler.version}
+
+
+ **/*
+
+
+
+
org.codehaus.mojoexec-maven-plugin
@@ -620,12 +658,12 @@
java-classpath
-
+ org.openjdk.jmh.Main-rfjson-rff
- target/jmh-result.${benchmark}.json
+ target/jmh-result.json${benchmark}
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index f8912d2005..a3ae6cc2bc 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -37,386 +37,387 @@ and commit
The type attribute can be add,update,fix,remove.
-->
-
-
+Apache Commons Text Changes
-
-
- Fix exception message typo in XmlStringLookup.XmlStringLookup(Map, Path...).
- Inserting at the end of a TextStringBuilder throws a StringIndexOutOfBoundsException.
- Fix TextStringBuilderTest.testAppendToCharBuffer() to use proper argument type #724.
- Fix Apache RAT plugin console warnings.
- Fix site XML to use version 2.0.0 XML schema.
- Removed unreachable threshold verification code in src/main/java/org/apache/commons/text/similarity #730.
- Enable secure processing for the XML parser in XmlStringLookup #729.
-
- Add experimental CycloneDX VEX file #683.
- Add Damerau-Levenshtein distance #687.
- Add unit tests to increase coverage #719.
- Add new test for CharSequenceTranslator#with() #725.
- Add tests and assertions to org.apache.commons.text.similarity to get to 100% code coverage #727, #728.
-
- Bump org.apache.commons:commons-parent from 85 to 93 #704, #723, #726.
- Bump commons.bytebuddy.version from 1.17.6 to 1.18.2 #696, #722.
- Bump graalvm.version from 24.2.2 to 25.0.1 #703, #716.
- Bump org.apache.commons:commons-lang3 from 3.18.0 to 3.20.0.
- Bump commons-io:commons-io from 2.20.0 to 2.21.0.
-
-
-
- Fix PMD UnnecessaryFullyQualifiedName in StringLookupFactory.
- Fix PMD UnnecessaryFullyQualifiedName in DefaultStringLookupsHolder.
- Fix PMD UnnecessaryFullyQualifiedName in PropertiesStringLookup.
- Fix PMD UnnecessaryFullyQualifiedName in JavaPlatformStringLookup.
- Fix PMD UnnecessaryFullyQualifiedName in StringSubstitutor.
- Fix PMD UnnecessaryFullyQualifiedName in StrSubstitutor.
- Fix PMD UnnecessaryFullyQualifiedName in AlphabetConverter.
- Fix PMD AvoidBranchingStatementAsLastInLoop in TextStringBuilder.
- Fix PMD AvoidBranchingStatementAsLastInLoop in StrBuilder.
- org.apache.commons.text.translate.LookupTranslator.LookupTranslator(Map CharSequence>) now throws NullPointerException instead of java.security.InvalidParameterException.
-
- Interface StringLookup now extends UnaryOperator<String>.
- Interface TextRandomProvider extends IntUnaryOperator.
- Add RandomStringGenerator.Builder.usingRandom(IntUnaryOperator).
- Add PMD check to default Maven goal.
- Add org.apache.commons.text.RandomStringGenerator.Builder.setAccumulate(boolean).
-
- Bump org.apache.commons:commons-parent from 81 to 85 #668.
- Bump commons-io:commons-io from 2.18.0 to 2.20.0.
- Bump graalvm.version from 24.2.0 to 24.2.2 #665, #681.
- Bump commons.bytebuddy.version from 1.17.5 to 1.17.6 (#677).
- Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 #680.
-
-
-
- Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80).
- Deprecate EntityArrays.EntityArrays().
- StringLookupFactory.DefaultStringLookupsHolder.createDefaultStringLookups() maps DefaultStringLookup.LOCAL_HOST twice instead of once for LOCAL_HOST and LOOPBACK_ADDRESS.
-
-
- Bump org.apache.commons:commons-parent from 79 to 81.
- Bump commons.bytebuddy.version from 1.16.1 to 1.17.5 #643, #659, #660.
- Bump graalvm.version from 24.1.2 to 24.2.0 #653.
-
-
-
- Add StringLookupFactory.loopbackAddressStringLookup().
- Add StringLookupFactory.KEY_LOOPBACK_ADDRESS.
- Add DefaultStringLookup.LOOPBACK_ADDRESS.
- Add richer inputs in package org.apache.commons.text.similarity with SimilarityInput.
- Add HammingDistance.apply(SimilarityInput, SimilarityInput).
- Add JaccardDistance.apply(SimilarityInput, SimilarityInput).
- Add JaccardSimilarity.apply(SimilarityInput, SimilarityInput).
- Add JaroWinklerDistance.apply(SimilarityInput, SimilarityInput).
- Add JaroWinklerSimilarity.apply(SimilarityInput, SimilarityInput).
- Add LevenshteinDetailedDistance.apply(SimilarityInput, SimilarityInput).
- Add LevenshteinDistance.apply(SimilarityInput, SimilarityInput).
-
- Fix build on Java 22.
- Fix build on Java 23-ea.
- Make package-private constructor private: StrLookup.MapStrLookup.MapStrLookup(Map).
- Make package-private constructor private: StrLookup.SystemPropertiesStrLookup.SystemPropertiesStrLookup().
- Make package-private class private and final: MapStrLookup.
- Make package-private class private: StrMatcher.CharMatcher.
- Make package-private class private: StrMatcher.CharSetMatcher.
- Make package-private class private: StrMatcher.NoMatcher.
- Make package-private class private: StrMatcher.StringMatcher.
- Make package-private class private: StrMatcher.TrimMatcher.
- Make package-private class private and final: IntersectionSimilarity.BagCount.
- Make package-private class private and final: IntersectionSimilarity.TinyCount.
- Deprecate LevenshteinDistance.LevenshteinDistance() in favor of LevenshteinDistance.getDefaultInstance().
- Deprecate LevenshteinDetailedDistance.LevenshteinDetailedDistance() in favor of LevenshteinDetailedDistance.getDefaultInstance().
- Improve StrBuilder documentation for new line text.
- Improve TextStringBuilder documentation for new line text #547.
- Required OSGi Import-Package version numbers in MANIFEST.MF #627.
-
- Bump org.apache.commons:commons-parent from 69 to 78 #542, #557, #571, #581, #584, #593, #600, #603, #614.
- Bump tests on Java >= 22 org.graalvm.*:* from 24.0.0 to 24.1.1 #592, #610.
- Bump commons.bytebuddy.version from 1.14.13 to 1.16.1 #538, #548, #553, #565, #579, #582, #585, #596, #597, #604, #612, #620, #623, #625, #640.
- Bump SpotBugs from 4.8.3 to 4.8.5.
- Bump org.assertj:assertj-core from 3.25.3 to 3.26.3 #554, #566.
- Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.2.1 #564, #611.
- Bump org.apache.commons:commons-rng-simple from 1.5 to 1.6 #568.
- Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #569, #575, #586.
- Bump commons-io:commons-io from 2.16.1 to 2.18.0 #594, #628.
-
-
-
- Add StringLookupFactory.fileStringLookup(Path...) and deprecated fileStringLookup().
- Add StringLookupFactory.propertiesStringLookup(Path...) and deprecated propertiesStringLookup().
- Add StringLookupFactory.xmlStringLookup(Map, Path...) and deprecated xmlStringLookup() and xmlStringLookup(Map).
- Add StringLookupFactory.builder() for fencing Path resolution of the file, properties and XML lookups.
- Add DoubleFormat.Builder.get() as Builder now implements Supplier.
-
- WordUtils.containsAllWords() may throw PatternSyntaxException.
- Fix regression for determining whitespace in WordUtils #519.
- Deprecate Builder in favor of Supplier.
-
- Bump commons-lang3 from 3.13.0 to 3.14.0.
- Bump commons.bytebuddy.version from 1.14.9 to 1.14.13 #476, #482, #505, #521.
- Bump org.codehaus.mojo:exec-maven-plugin from 3.1.0 to 3.2.0 #474, #508.
- Bump commons-io from 2.15.0 to 2.16.1 #522, #527.
- Bump commons-parent from 64 to 69 #524.
- Bump org.assertj:assertj-core from 3.24.2 to 3.25.3.
-
-
-
- Fix StringTokenizer.getTokenList to return an independent modifiable list
- Fix Javadoc for StringEscapeUtils.escapeHtml4 #382
- TextStringBuidler#hashCode() allocates a String on each call #387.
- Fix Bundle-SymbolicName to use the package name org.apache.commons.text
- Add and use a package-private singleton for RegexTokenizer.
- Add and use a package-private singleton for CosineSimilarity.
- Add and use a package-private singleton for LongestCommonSubsequence.
- Add and use a package-private singleton for JaroWinklerSimilarity.
- Add and use a package-private singleton for JaccardSimilarity.
- [StepSecurity] ci: Harden GitHub Actions #428.
- Improve AlphabetConverter Javadoc #429.
- Fix exception message in IntersectionResult to make set-theoretic sense #438.
- Add null-check in RandomStringGenerator#Builder#selectFrom() to avoid NullPointerException #434.
- Add null-check in RandomStringGenerator#Builder#withinRange() to avoid NullPointerException.
- Fix TextStringBuilder to over-allocate when ensuring capacity #452.
- Constructor for ResourceBundleStringLookup should be private instead of package-private.
- Constructor for UrlDecoderStringLookup should be private instead of package-private.
- Constructor for UrlEncoderStringLookup should be private instead of package-private.
- Javadoc of org.apache.commons.text.lookup.DefaultStringLookup.XML is incorrect.
- Update DoubleFormat to state it is based on Double.toString. #467.
-
- Set SecureProcessing feature in XmlStringLookup by default.
- Add StringLookupFactory.xmlStringLookup(Map<String, Boolean>...).
- Add @FunctionalInterface to FormatFactory.
- Add RandomStringGenerator.builder().
- Add XmlEncoderStringLookup/XmlDecoderStringLookup #449.
- Add StringSubstitutor.toString().
-
- Bump actions/cache.
- Bump actions/setup-java.
- Bump actions/checkout.
- Bump pmd from 6.49.0 to 6.52.0 #364.
- Bump commons-rng-simple from 1.4 to 1.5 #370.
- Bump spotbugs-maven-plugin from 4.7.2.0 to 4.7.3.6 #371, #385.
- Bump spotbugs from 4.7.2 to 4.7.3 #373.
- Bump mockito-inline from 4.8.0 to 4.11.0 #380, #389, #396, #400.
- Bump jmh.version from 1.35 to 1.37 #388.
- Bump commons-parent from 54 to 64 #392, #401.
- Bump assertj-core from 3.23.1 to 3.24.2 #405, #410.
- Bump maven-checkstyle-plugin from 3.2.0 to 3.2.1 #407.
- Bump commons-io from 2.11.0 to 2.15.0.
- Bump commons-lang3 from 3.12.0 to 3.13.0.
-
-
-
- Fix CaseUtils when the input string contains only delimiters
- Add GraalVM test dependencies to fix test failures with Java 15.
- Incorrect values for Jaccard similarity with empty strings.
- StringSubstitutor map constructor throws NPE on 1.9 with null map.
- JaroWinklerDistance returns the same values as JaroWinklerSimilarity.
- Correct Javadoc in FileStringLookup.
- Minor Improvements #192, #196.
- Use StringUtils.INDEX_NOT_FOUND constant.
- Remove redundant local variable.
- Replace lambda with method reference.
- Simplify statements.
- Replace statement lambda with expression lambda.
- Use static class inner class in tests.
- Simplify assertion.
- Extract duplicate code.
- Set void return method.
- Remove unused exception from TextStringBuilder.readFrom(CharBuffer). This preserves binary compatibility but not source compatibility.
- StrBuilder.StrBuilderReader.skip(long): Throw an exception when an implicit narrowing conversion in a compound assignment would result in information loss or a numeric error such as an overflows.
- TextStringBuilder.TextStringBuilderReader.skip(long): Throw an exception when an implicit narrowing conversion in a compound assignment would result in information loss or a numeric error such as an overflows.
- TextStringBuilder.equals whatever the capacity is #281.
- A More Efficient Implementation for Calculating Size of Longest Common Subsequence.
- LookupTranslator returns count of chars consumed, not of codepoints consumed.
- Use Math.min() call instead of doing it manually. #335.
- TextStringBuilder: Throw OutOfMemoryError instead of NegativeArraySizeException.
- TextStringBuilder: Can't grow to sizes up to Integer.MAX_VALUE.
- Make default string lookups configurable via system property. Remove dns, url, and script lookups from defaults. If these lookups are required for use in StringSubstitutor.createInterpolator(), they must be enabled via system property. See StringLookupFactory for details.
-
- Add DoubleFormat utility.
- Document negative limit for WordUtils abbreviate method
- Speed up LevenshteinDistance with threshold by exiting early
- Release Notes page hasn't been updated for 1.9 release yet.
- Add StrBuilder.isNotEmpty().
-
- Bump actions/setup-java from v1.4.0 to 3 #147, #156, #155, #172, #215, #314.
- Bump github/codeql-action from 1 to 2 #319.
- Bump checkstyle from 8.34 to 9.3, #141, #168, #182, #188, #193, #201, #208, #211, #228, #235, #245, #253, #255, #262, #270, #280, #287, #299, #315, #321.
- Bump spotbugs-maven-plugin from 4.0.0 to 4.7.2.0, #144, #150, #167, #176, #194, #210, #223, #250, #268, #273, #277, #278, #286, #293, #303, #320, #325, #338, #344, #354.
- Bump spotbugs from 4.1.3 to 4.7.2 #175, 189, #209, #218, #247, #256, #264, #275, #284, #289, #296, #306, #355.
- Bump mockito-inline from 3.4.4 to 4.8.0, #143, #148, #149, #152, #153, #154, #158, #159, #166, #177, #180, #187, #195, #197, #207, #216, #231, #236, #237, #243, #258, #259, #260, #261, #272, #285, #291, #305, #317, #330, #331, #347, #352.
- Bump junit-jupiter from 5.6.2 to 5.9.1 #163, #204, #232, #265, #269, #288, #343, #357.
- Bump assertj-core from 3.16.1 to 3.23.1 #151, #157, #160, #178, #184, #199, #244, #267, #294.
- Bump commons-io from 2.7 to 2.11.0 #161 #251.
- Bump commons-parent from 51 to 54 #145, #358.
- Bump maven-pmd-plugin from 3.13.0 to 3.19.0 #186, #263, #302, #334, #349, #353.
- Bump pmd from 6.42.0 to 6.46.0.
- Bump graalvm.version from 20.2.0 to 22.0.0.2 #185, #198, #206, #227, #252, #276, #295, #300.
- Bump commons.japicmp.version from 0.14.3 to 0.16.0.
- Bump commons.jacoco.version 0.8.5 to 0.8.8; fixes Java 15 build.
- Bump maven-checkstyle-plugin from 3.1.1 to 3.2.0 #202, #348.
- Bump commons-lang3 3.11 -> 3.12.0.
- Bump commons.javadoc.version from 3.2.0 to 3.4.1.
- Bump commons.project-info.version from 3.1.0 to 3.1.2.
- Bump jmh.version from 1.32 to 1.35 #254, #292, #313.
- Bump commons-rng-simple from 1.3 to 1.4 #266.
- Bump taglist-maven-plugin from 2.4 to 3.0.0 #297.
- Bump commons.pmd-impl.version from 6.44.0 to 6.49.0 #323, #336, #345, #350.
- Bump exec-maven-plugin from 3.0.0 to 3.1.0 #340.
-
-
- Removed non-existing parameter from Javadocs and spelled out parameters in throws.
- StringEscapeUtils.unescapeCsv doesn't remove quotes at begin and end of string.
- ScriptStringLookup does not accept ":" #126.
- StringSubstitutor incorrectly removes some escape characters.
- Fix Javadocs #135.
- Fix typos #137.
- Make ConstantStringLookup.constantCache final #136.
- Simplify if in CaseUtils #134.
- [javadoc] Fix compiler warnings in Java code example in Javadoc #124.
- Update from Apache Commons Lang 3.9 to 3.11.
- Add StringMatcher.size().
- Refactor TextStringBuilder.readFrom(Readable), extracting readFrom(CharBuffer) and readFrom(Reader).
- Add BiStringLookup and implementation BiFunctionStringLookup.
- Add org.apache.commons.text.StringSubstitutor.StringSubstitutor(StringSubstitutor).
- Add org.apache.commons.text.TextStringBuilder.TextStringBuilder(CharSequence).
- Add org.apache.commons.text.TextStringBuilder.drainChar(int).
- Add org.apache.commons.text.TextStringBuilder.drainChars(int, int, char[]. int).
- Add org.apache.commons.text.TextStringBuilder.isNotEmpty().
- Add org.apache.commons.text.TextStringBuilder.isReallocated().
- Add org.apache.commons.text.TextStringBuilder.readFrom(Reader, int).
- Add org.apache.commons.text.TextStringBuilder.set(String).
- Add org.apache.commons.text.TextStringBuilder.wrap(char[]).
- Add org.apache.commons.text.TextStringBuilder.wrap(char[], int).
- Add org.apache.commons.text.io.StringSubstitutorReader.
- Add org.apache.commons.text.lookup.StringLookupFactory.functionStringLookup(Function<String, V>).
- Add org.apache.commons.text.matcher.StringMatcher.isMatch(CharSequence, int).
- Add org.apache.commons.text.matcher.StringMatcher.isMatch(CharSequence, int, int, int).
- Add org.apache.commons.text.matcher.StringMatcherFactory.andMatcher(StringMatcher...).
- Add org.apache.commons.text.matcher.StringMatcherFactory.stringMatcher(char...).
- [build] Skip clirr since we use JApiCmp.
- [test] junit-jupiter 5.5.1 -> 5.5.2.
- [test] org.assertj:assertj-core 3.13.2 -> 3.16.1.
- [build] com.puppycrawl.tools:checkstyle 8.23 -> 8.34.
- [build] Update JUnit from 5.5.2 to 5.6.2.
- [build] commons.jacoco.version 0.8.4 -> 0.8.5.
- [build] commons.javadoc.version 3.1.1 -> 3.2.0.
- [build] commons.japicmp.version 0.14.1 -> 0.14.3.
- [build] checkstyle.plugin.version 3.1.0 -> 3.1.1.
- [build] checkstyle.version 8.27 -> 8.33.
- [build] org.apache.commons:commons-parent 48 -> 51.
- [build] maven-pmd-plugin 3.12.0 -> 3.13.0.
- [build] org.mockito 3.3.3 -> 3.4.4.
-
-
-
- commons-text web page missing "RELEASE-NOTES-1.7.txt"
- (doc) Fixed wrong value for Jaro-Winkler example #117
- Add helper factory method org.apache.commons.text.StringSubstitutor.createInterpolator().
- Add String lookup for host names and IP addresses (DnsStringLookup).
- StringLookupFactory.addDefaultStringLookups(Map) does not convert keys to lower case.
- Expand Javadoc for StringSubstitutor and friends.
- [site] checkstyle.version 8.21 -> 8.23.
-
-
-
- WordUtils.wrap must calculate offset increment from wrapOn pattern length
- Jaro Winkler Distance refers to similarity
- Add an enum to the lookup package that lists all StringLookups
- Add a toggle to throw an exception when a variable is unknown in StringSubstitutor
- TextStringBuilder append sub-sequence not consistent with Appendable.
- Fix possible infinite loop in WordUtils.wrap for a regex pattern that would trigger on a match of 0 length
- Make prefixSet in LookupTranslator a BitSet
- Fix the RegexTokenizer to use a static Pattern
- Remove rounding from JaccardDistance and JaccardSimilarity
- Fix the JaroWinklerSimilarity to use StringUtils.equals to test for CharSequence equality
- Add a generic IntersectionSimilarity measure
- Update Apache Commons Lang from 3.8.1 to 3.9.
- ResourceBundleStringLookup.lookup(String) throws MissingResourceException instead of returning null.
- Update tests from org.assertj:assertj-core 3.12.1 to 3.12.2.
- Update site from com.puppycrawl.tools:checkstyle 8.18 to 8.21.
-
-
-
- Add the resource string bundle string lookup to the default set of lookups
- Add StringLookupFactory methods for the URL encoder and decoder string lookups
- org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup() should reuse a singleton instance
- Add a Base64 encoder string lookup.
-
-
-
- Improve JaccardSimilarity computational cost
- JSON escaping incorrect for the delete control character
- Fixes JaroWinklerDistance: Wrong results due to precision of transpositions
- JaroWinklerDistance: Calculation deviates from definition
- Update Apache Commons Lang from 3.7 to 3.8.1
- Add a XML file XPath string lookup.
- Add a Properties file string lookup.
- Add a script string lookup.
- Add a file string lookup.
- Add a URL string lookup.
- Add a Base64 string lookup.
- Add org.apache.commons.text.lookup.StringLookupFactory.resourceBundleStringLookup(String).
- Add URL encoder and decoder string lookups.
- Add constant string lookup like the one in Apache Commons Configuration.
-
-
-
- StringEscapeUtils#unescapeJson does not unescape double quotes and forward slash
- Remove mention of SQL escaping from user guide
- Update Java requirement from version 7 to 8.
- Allow full customization with new API org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup>, StringLookup, boolean).
- WordUtils.wrap throws StringIndexOutOfBoundsException when wrapLength is Integer.MAX_VALUE.
-
-
-
- Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility
- Build failure with java 9-ea+159
- Add an interpolator string lookup: StringLookupFactory#interpolatorStringLookup()
- Add a StrSubstitutor replacement based on interfaces: StringSubstitutor
- Add a StrBuilder replacement based on the StringMatcher interface: TextStringBuilder
- Add a StrTokenizer replacement based on the StringMatcher interface: StringTokenizer
- Add a local host string lookup: LocalHostStringLookup
- StrLookup API confusing
-
-
-
- Upversion commons-lang to 3.7
- Exception thrown in ExtendedMessageFormat using quotes with custom registry
- StringEscapeUtils#UnEscapeJson doesn't recognize escape signs correctly
- StrSubstitutor: Ability to turn off substitution in values
- RandomStringGenerator able to pass multiple ranges to .withinRange()
- Deprecate isDelimiter and use HashSets for delimiter checks
- WordUtils.initials support for UTF-16 surrogate pairs
- WordUtils should treat an empty delimiter array as no delimiters
- Update RandomStringGenerator to accept a list of valid characters
- Add CharacterPredicates for ASCII letters (uppercase/lowercase) and arabic numerals
- Added CaseUtils class with camel case conversion support
- RandomStringGenerator should be able to generate a String with a random length
- Update commons-lang dependency to version 3.6
- Document that commons-csv should be used in preference to CsvTranslators
- NumericEntityUnescaper.options - fix TODO
- RandomStringGenerator claims to be immutable, but isn't
- Add StrLookup.resourceBundleLookup(ResourceBundle)
- Typo in LongestCommonSubsequence#logestCommonSubsequence
-
-
-
- WordUtils should use toXxxxCase(int) rather than toXxxxCase(char)
- WordUtils.abbreviate support
- Putting WordUtils back in to the codebase
- Add RandomStringGenerator
- RandomStringGenerator: allow users to provide source of randomness
- Correct round issue in Jaro Winkler implementation
- Similar to LANG-1025, clirr fails site build.
-
-
-
+
+ Improve test coverage #732.
+ TextStringBuilder.append(char[], int, int) uses wrong variable in exception message #735.
+
+
+ Bump org.apache.commons:commons-parent from 93 to 97.
+ Bump the level of test coverage checks.
+ Bump commons.bytebuddy.version from 1.18.2 to 1.18.4 #734.
+ Bump commons.bytebuddy.version from 1.18.4 to 1.18.7.
+
+
+
+ Fix exception message typo in XmlStringLookup.XmlStringLookup(Map, Path...).
+ Inserting at the end of a TextStringBuilder throws a StringIndexOutOfBoundsException.
+ Fix TextStringBuilderTest.testAppendToCharBuffer() to use proper argument type #724.
+ Fix Apache RAT plugin console warnings.
+ Fix site XML to use version 2.0.0 XML schema.
+ Removed unreachable threshold verification code in src/main/java/org/apache/commons/text/similarity #730.
+ Enable secure processing for the XML parser in XmlStringLookup in case the underlying JAXP implementation doesn't #729.
+
+ Add experimental CycloneDX VEX file #683.
+ Add Damerau-Levenshtein distance #687.
+ Add unit tests to increase coverage #719.
+ Add new test for CharSequenceTranslator#with() #725.
+ Add tests and assertions to org.apache.commons.text.similarity to get to 100% code coverage #727, #728.
+
+ Bump org.apache.commons:commons-parent from 85 to 93 #704, #723, #726.
+ Bump commons.bytebuddy.version from 1.17.6 to 1.18.2 #696, #722.
+ Bump graalvm.version from 24.2.2 to 25.0.1 #703, #716.
+ Bump org.apache.commons:commons-lang3 from 3.18.0 to 3.20.0.
+ Bump commons-io:commons-io from 2.20.0 to 2.21.0.
+
+
+
+ Fix PMD UnnecessaryFullyQualifiedName in StringLookupFactory.
+ Fix PMD UnnecessaryFullyQualifiedName in DefaultStringLookupsHolder.
+ Fix PMD UnnecessaryFullyQualifiedName in PropertiesStringLookup.
+ Fix PMD UnnecessaryFullyQualifiedName in JavaPlatformStringLookup.
+ Fix PMD UnnecessaryFullyQualifiedName in StringSubstitutor.
+ Fix PMD UnnecessaryFullyQualifiedName in StrSubstitutor.
+ Fix PMD UnnecessaryFullyQualifiedName in AlphabetConverter.
+ Fix PMD AvoidBranchingStatementAsLastInLoop in TextStringBuilder.
+ Fix PMD AvoidBranchingStatementAsLastInLoop in StrBuilder.
+ org.apache.commons.text.translate.LookupTranslator.LookupTranslator(Map CharSequence>) now throws NullPointerException instead of java.security.InvalidParameterException.
+
+ Interface StringLookup now extends UnaryOperator<String>.
+ Interface TextRandomProvider extends IntUnaryOperator.
+ Add RandomStringGenerator.Builder.usingRandom(IntUnaryOperator).
+ Add PMD check to default Maven goal.
+ Add org.apache.commons.text.RandomStringGenerator.Builder.setAccumulate(boolean).
+
+ Bump org.apache.commons:commons-parent from 81 to 85 #668.
+ Bump commons-io:commons-io from 2.18.0 to 2.20.0.
+ Bump graalvm.version from 24.2.0 to 24.2.2 #665, #681.
+ Bump commons.bytebuddy.version from 1.17.5 to 1.17.6 (#677).
+ Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 #680.
+
+
+
+ Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80).
+ Deprecate EntityArrays.EntityArrays().
+ StringLookupFactory.DefaultStringLookupsHolder.createDefaultStringLookups() maps DefaultStringLookup.LOCAL_HOST twice instead of once for LOCAL_HOST and LOOPBACK_ADDRESS.
+
+
+ Bump org.apache.commons:commons-parent from 79 to 81.
+ Bump commons.bytebuddy.version from 1.16.1 to 1.17.5 #643, #659, #660.
+ Bump graalvm.version from 24.1.2 to 24.2.0 #653.
+
+
+
+ Add StringLookupFactory.loopbackAddressStringLookup().
+ Add StringLookupFactory.KEY_LOOPBACK_ADDRESS.
+ Add DefaultStringLookup.LOOPBACK_ADDRESS.
+ Add richer inputs in package org.apache.commons.text.similarity with SimilarityInput.
+ Add HammingDistance.apply(SimilarityInput, SimilarityInput).
+ Add JaccardDistance.apply(SimilarityInput, SimilarityInput).
+ Add JaccardSimilarity.apply(SimilarityInput, SimilarityInput).
+ Add JaroWinklerDistance.apply(SimilarityInput, SimilarityInput).
+ Add JaroWinklerSimilarity.apply(SimilarityInput, SimilarityInput).
+ Add LevenshteinDetailedDistance.apply(SimilarityInput, SimilarityInput).
+ Add LevenshteinDistance.apply(SimilarityInput, SimilarityInput).
+
+ Fix build on Java 22.
+ Fix build on Java 23-ea.
+ Make package-private constructor private: StrLookup.MapStrLookup.MapStrLookup(Map).
+ Make package-private constructor private: StrLookup.SystemPropertiesStrLookup.SystemPropertiesStrLookup().
+ Make package-private class private and final: MapStrLookup.
+ Make package-private class private: StrMatcher.CharMatcher.
+ Make package-private class private: StrMatcher.CharSetMatcher.
+ Make package-private class private: StrMatcher.NoMatcher.
+ Make package-private class private: StrMatcher.StringMatcher.
+ Make package-private class private: StrMatcher.TrimMatcher.
+ Make package-private class private and final: IntersectionSimilarity.BagCount.
+ Make package-private class private and final: IntersectionSimilarity.TinyCount.
+ Deprecate LevenshteinDistance.LevenshteinDistance() in favor of LevenshteinDistance.getDefaultInstance().
+ Deprecate LevenshteinDetailedDistance.LevenshteinDetailedDistance() in favor of LevenshteinDetailedDistance.getDefaultInstance().
+ Improve StrBuilder documentation for new line text.
+ Improve TextStringBuilder documentation for new line text #547.
+ Required OSGi Import-Package version numbers in MANIFEST.MF #627.
+
+ Bump org.apache.commons:commons-parent from 69 to 78 #542, #557, #571, #581, #584, #593, #600, #603, #614.
+ Bump tests on Java >= 22 org.graalvm.*:* from 24.0.0 to 24.1.1 #592, #610.
+ Bump commons.bytebuddy.version from 1.14.13 to 1.16.1 #538, #548, #553, #565, #579, #582, #585, #596, #597, #604, #612, #620, #623, #625, #640.
+ Bump SpotBugs from 4.8.3 to 4.8.5.
+ Bump org.assertj:assertj-core from 3.25.3 to 3.26.3 #554, #566.
+ Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.2.1 #564, #611.
+ Bump org.apache.commons:commons-rng-simple from 1.5 to 1.6 #568.
+ Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #569, #575, #586.
+ Bump commons-io:commons-io from 2.16.1 to 2.18.0 #594, #628.
+
+
+
+ Add StringLookupFactory.fileStringLookup(Path...) and deprecated fileStringLookup().
+ Add StringLookupFactory.propertiesStringLookup(Path...) and deprecated propertiesStringLookup().
+ Add StringLookupFactory.xmlStringLookup(Map, Path...) and deprecated xmlStringLookup() and xmlStringLookup(Map).
+ Add StringLookupFactory.builder() for fencing Path resolution of the file, properties and XML lookups.
+ Add DoubleFormat.Builder.get() as Builder now implements Supplier.
+
+ WordUtils.containsAllWords() may throw PatternSyntaxException.
+ Fix regression for determining whitespace in WordUtils #519.
+ Deprecate Builder in favor of Supplier.
+
+ Bump commons-lang3 from 3.13.0 to 3.14.0.
+ Bump commons.bytebuddy.version from 1.14.9 to 1.14.13 #476, #482, #505, #521.
+ Bump org.codehaus.mojo:exec-maven-plugin from 3.1.0 to 3.2.0 #474, #508.
+ Bump commons-io from 2.15.0 to 2.16.1 #522, #527.
+ Bump commons-parent from 64 to 69 #524.
+ Bump org.assertj:assertj-core from 3.24.2 to 3.25.3.
+
+
+
+ Fix StringTokenizer.getTokenList to return an independent modifiable list
+ Fix Javadoc for StringEscapeUtils.escapeHtml4 #382
+ TextStringBuidler#hashCode() allocates a String on each call #387.
+ Fix Bundle-SymbolicName to use the package name org.apache.commons.text
+ Add and use a package-private singleton for RegexTokenizer.
+ Add and use a package-private singleton for CosineSimilarity.
+ Add and use a package-private singleton for LongestCommonSubsequence.
+ Add and use a package-private singleton for JaroWinklerSimilarity.
+ Add and use a package-private singleton for JaccardSimilarity.
+ [StepSecurity] ci: Harden GitHub Actions #428.
+ Improve AlphabetConverter Javadoc #429.
+ Fix exception message in IntersectionResult to make set-theoretic sense #438.
+ Add null-check in RandomStringGenerator#Builder#selectFrom() to avoid NullPointerException #434.
+ Add null-check in RandomStringGenerator#Builder#withinRange() to avoid NullPointerException.
+ Fix TextStringBuilder to over-allocate when ensuring capacity #452.
+ Constructor for ResourceBundleStringLookup should be private instead of package-private.
+ Constructor for UrlDecoderStringLookup should be private instead of package-private.
+ Constructor for UrlEncoderStringLookup should be private instead of package-private.
+ Javadoc of org.apache.commons.text.lookup.DefaultStringLookup.XML is incorrect.
+ Update DoubleFormat to state it is based on Double.toString. #467.
+
+ Set SecureProcessing feature in XmlStringLookup by default.
+ Add StringLookupFactory.xmlStringLookup(Map<String, Boolean>...).
+ Add @FunctionalInterface to FormatFactory.
+ Add RandomStringGenerator.builder().
+ Add XmlEncoderStringLookup/XmlDecoderStringLookup #449.
+ Add StringSubstitutor.toString().
+
+ Bump actions/cache.
+ Bump actions/setup-java.
+ Bump actions/checkout.
+ Bump pmd from 6.49.0 to 6.52.0 #364.
+ Bump commons-rng-simple from 1.4 to 1.5 #370.
+ Bump spotbugs-maven-plugin from 4.7.2.0 to 4.7.3.6 #371, #385.
+ Bump spotbugs from 4.7.2 to 4.7.3 #373.
+ Bump mockito-inline from 4.8.0 to 4.11.0 #380, #389, #396, #400.
+ Bump jmh.version from 1.35 to 1.37 #388.
+ Bump commons-parent from 54 to 64 #392, #401.
+ Bump assertj-core from 3.23.1 to 3.24.2 #405, #410.
+ Bump maven-checkstyle-plugin from 3.2.0 to 3.2.1 #407.
+ Bump commons-io from 2.11.0 to 2.15.0.
+ Bump commons-lang3 from 3.12.0 to 3.13.0.
+
+
+
+ Fix CaseUtils when the input string contains only delimiters
+ Add GraalVM test dependencies to fix test failures with Java 15.
+ Incorrect values for Jaccard similarity with empty strings.
+ StringSubstitutor map constructor throws NPE on 1.9 with null map.
+ JaroWinklerDistance returns the same values as JaroWinklerSimilarity.
+ Correct Javadoc in FileStringLookup.
+ Minor Improvements #192, #196.
+ Use StringUtils.INDEX_NOT_FOUND constant.
+ Remove redundant local variable.
+ Replace lambda with method reference.
+ Simplify statements.
+ Replace statement lambda with expression lambda.
+ Use static class inner class in tests.
+ Simplify assertion.
+ Extract duplicate code.
+ Set void return method.
+ Remove unused exception from TextStringBuilder.readFrom(CharBuffer). This preserves binary compatibility but not source compatibility.
+ StrBuilder.StrBuilderReader.skip(long): Throw an exception when an implicit narrowing conversion in a compound assignment would result in information loss or a numeric error such as an overflows.
+ TextStringBuilder.TextStringBuilderReader.skip(long): Throw an exception when an implicit narrowing conversion in a compound assignment would result in information loss or a numeric error such as an overflows.
+ TextStringBuilder.equals whatever the capacity is #281.
+ A More Efficient Implementation for Calculating Size of Longest Common Subsequence.
+ LookupTranslator returns count of chars consumed, not of codepoints consumed.
+ Use Math.min() call instead of doing it manually. #335.
+ TextStringBuilder: Throw OutOfMemoryError instead of NegativeArraySizeException.
+ TextStringBuilder: Can't grow to sizes up to Integer.MAX_VALUE.
+ Make default string lookups configurable via system property. Remove dns, url, and script lookups from defaults. If these lookups are required for use in StringSubstitutor.createInterpolator(), they must be enabled via system property. See StringLookupFactory for details.
+
+ Add DoubleFormat utility.
+ Document negative limit for WordUtils abbreviate method
+ Speed up LevenshteinDistance with threshold by exiting early
+ Release Notes page hasn't been updated for 1.9 release yet.
+ Add StrBuilder.isNotEmpty().
+
+ Bump actions/setup-java from v1.4.0 to 3 #147, #156, #155, #172, #215, #314.
+ Bump github/codeql-action from 1 to 2 #319.
+ Bump checkstyle from 8.34 to 9.3, #141, #168, #182, #188, #193, #201, #208, #211, #228, #235, #245, #253, #255, #262, #270, #280, #287, #299, #315, #321.
+ Bump spotbugs-maven-plugin from 4.0.0 to 4.7.2.0, #144, #150, #167, #176, #194, #210, #223, #250, #268, #273, #277, #278, #286, #293, #303, #320, #325, #338, #344, #354.
+ Bump spotbugs from 4.1.3 to 4.7.2 #175, 189, #209, #218, #247, #256, #264, #275, #284, #289, #296, #306, #355.
+ Bump mockito-inline from 3.4.4 to 4.8.0, #143, #148, #149, #152, #153, #154, #158, #159, #166, #177, #180, #187, #195, #197, #207, #216, #231, #236, #237, #243, #258, #259, #260, #261, #272, #285, #291, #305, #317, #330, #331, #347, #352.
+ Bump junit-jupiter from 5.6.2 to 5.9.1 #163, #204, #232, #265, #269, #288, #343, #357.
+ Bump assertj-core from 3.16.1 to 3.23.1 #151, #157, #160, #178, #184, #199, #244, #267, #294.
+ Bump commons-io from 2.7 to 2.11.0 #161 #251.
+ Bump commons-parent from 51 to 54 #145, #358.
+ Bump maven-pmd-plugin from 3.13.0 to 3.19.0 #186, #263, #302, #334, #349, #353.
+ Bump pmd from 6.42.0 to 6.46.0.
+ Bump graalvm.version from 20.2.0 to 22.0.0.2 #185, #198, #206, #227, #252, #276, #295, #300.
+ Bump commons.japicmp.version from 0.14.3 to 0.16.0.
+ Bump commons.jacoco.version 0.8.5 to 0.8.8; fixes Java 15 build.
+ Bump maven-checkstyle-plugin from 3.1.1 to 3.2.0 #202, #348.
+ Bump commons-lang3 3.11 -> 3.12.0.
+ Bump commons.javadoc.version from 3.2.0 to 3.4.1.
+ Bump commons.project-info.version from 3.1.0 to 3.1.2.
+ Bump jmh.version from 1.32 to 1.35 #254, #292, #313.
+ Bump commons-rng-simple from 1.3 to 1.4 #266.
+ Bump taglist-maven-plugin from 2.4 to 3.0.0 #297.
+ Bump commons.pmd-impl.version from 6.44.0 to 6.49.0 #323, #336, #345, #350.
+ Bump exec-maven-plugin from 3.0.0 to 3.1.0 #340.
+
+
+ Removed non-existing parameter from Javadocs and spelled out parameters in throws.
+ StringEscapeUtils.unescapeCsv doesn't remove quotes at begin and end of string.
+ ScriptStringLookup does not accept ":" #126.
+ StringSubstitutor incorrectly removes some escape characters.
+ Fix Javadocs #135.
+ Fix typos #137.
+ Make ConstantStringLookup.constantCache final #136.
+ Simplify if in CaseUtils #134.
+ [javadoc] Fix compiler warnings in Java code example in Javadoc #124.
+ Update from Apache Commons Lang 3.9 to 3.11.
+ Add StringMatcher.size().
+ Refactor TextStringBuilder.readFrom(Readable), extracting readFrom(CharBuffer) and readFrom(Reader).
+ Add BiStringLookup and implementation BiFunctionStringLookup.
+ Add org.apache.commons.text.StringSubstitutor.StringSubstitutor(StringSubstitutor).
+ Add org.apache.commons.text.TextStringBuilder.TextStringBuilder(CharSequence).
+ Add org.apache.commons.text.TextStringBuilder.drainChar(int).
+ Add org.apache.commons.text.TextStringBuilder.drainChars(int, int, char[]. int).
+ Add org.apache.commons.text.TextStringBuilder.isNotEmpty().
+ Add org.apache.commons.text.TextStringBuilder.isReallocated().
+ Add org.apache.commons.text.TextStringBuilder.readFrom(Reader, int).
+ Add org.apache.commons.text.TextStringBuilder.set(String).
+ Add org.apache.commons.text.TextStringBuilder.wrap(char[]).
+ Add org.apache.commons.text.TextStringBuilder.wrap(char[], int).
+ Add org.apache.commons.text.io.StringSubstitutorReader.
+ Add org.apache.commons.text.lookup.StringLookupFactory.functionStringLookup(Function<String, V>).
+ Add org.apache.commons.text.matcher.StringMatcher.isMatch(CharSequence, int).
+ Add org.apache.commons.text.matcher.StringMatcher.isMatch(CharSequence, int, int, int).
+ Add org.apache.commons.text.matcher.StringMatcherFactory.andMatcher(StringMatcher...).
+ Add org.apache.commons.text.matcher.StringMatcherFactory.stringMatcher(char...).
+ [build] Skip clirr since we use JApiCmp.
+ [test] junit-jupiter 5.5.1 -> 5.5.2.
+ [test] org.assertj:assertj-core 3.13.2 -> 3.16.1.
+ [build] com.puppycrawl.tools:checkstyle 8.23 -> 8.34.
+ [build] Update JUnit from 5.5.2 to 5.6.2.
+ [build] commons.jacoco.version 0.8.4 -> 0.8.5.
+ [build] commons.javadoc.version 3.1.1 -> 3.2.0.
+ [build] commons.japicmp.version 0.14.1 -> 0.14.3.
+ [build] checkstyle.plugin.version 3.1.0 -> 3.1.1.
+ [build] checkstyle.version 8.27 -> 8.33.
+ [build] org.apache.commons:commons-parent 48 -> 51.
+ [build] maven-pmd-plugin 3.12.0 -> 3.13.0.
+ [build] org.mockito 3.3.3 -> 3.4.4.
+
+
+ commons-text web page missing "RELEASE-NOTES-1.7.txt"
+ (doc) Fixed wrong value for Jaro-Winkler example #117
+ Add helper factory method org.apache.commons.text.StringSubstitutor.createInterpolator().
+ Add String lookup for host names and IP addresses (DnsStringLookup).
+ StringLookupFactory.addDefaultStringLookups(Map) does not convert keys to lower case.
+ Expand Javadoc for StringSubstitutor and friends.
+ [site] checkstyle.version 8.21 -> 8.23.
+
+
+ WordUtils.wrap must calculate offset increment from wrapOn pattern length
+ Jaro Winkler Distance refers to similarity
+ Add an enum to the lookup package that lists all StringLookups
+ Add a toggle to throw an exception when a variable is unknown in StringSubstitutor
+ TextStringBuilder append sub-sequence not consistent with Appendable.
+ Fix possible infinite loop in WordUtils.wrap for a regex pattern that would trigger on a match of 0 length
+ Make prefixSet in LookupTranslator a BitSet
+ Fix the RegexTokenizer to use a static Pattern
+ Remove rounding from JaccardDistance and JaccardSimilarity
+ Fix the JaroWinklerSimilarity to use StringUtils.equals to test for CharSequence equality
+ Add a generic IntersectionSimilarity measure
+ Update Apache Commons Lang from 3.8.1 to 3.9.
+ ResourceBundleStringLookup.lookup(String) throws MissingResourceException instead of returning null.
+ Update tests from org.assertj:assertj-core 3.12.1 to 3.12.2.
+ Update site from com.puppycrawl.tools:checkstyle 8.18 to 8.21.
+
+
+ Add the resource string bundle string lookup to the default set of lookups
+ Add StringLookupFactory methods for the URL encoder and decoder string lookups
+ org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup() should reuse a singleton instance
+ Add a Base64 encoder string lookup.
+
+
+ Improve JaccardSimilarity computational cost
+ JSON escaping incorrect for the delete control character
+ Fixes JaroWinklerDistance: Wrong results due to precision of transpositions
+ JaroWinklerDistance: Calculation deviates from definition
+ Update Apache Commons Lang from 3.7 to 3.8.1
+ Add a XML file XPath string lookup.
+ Add a Properties file string lookup.
+ Add a script string lookup.
+ Add a file string lookup.
+ Add a URL string lookup.
+ Add a Base64 string lookup.
+ Add org.apache.commons.text.lookup.StringLookupFactory.resourceBundleStringLookup(String).
+ Add URL encoder and decoder string lookups.
+ Add constant string lookup like the one in Apache Commons Configuration.
+
+
+ StringEscapeUtils#unescapeJson does not unescape double quotes and forward slash
+ Remove mention of SQL escaping from user guide
+ Update Java requirement from version 7 to 8.
+ Allow full customization with new API org.apache.commons.text.lookup.StringLookupFactory.interpolatorStringLookup(Map<String, StringLookup>, StringLookup, boolean).
+ WordUtils.wrap throws StringIndexOutOfBoundsException when wrapLength is Integer.MAX_VALUE.
+
+
+ Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility
+ Build failure with java 9-ea+159
+ Add an interpolator string lookup: StringLookupFactory#interpolatorStringLookup()
+ Add a StrSubstitutor replacement based on interfaces: StringSubstitutor
+ Add a StrBuilder replacement based on the StringMatcher interface: TextStringBuilder
+ Add a StrTokenizer replacement based on the StringMatcher interface: StringTokenizer
+ Add a local host string lookup: LocalHostStringLookup
+ StrLookup API confusing
+
+
+ Upversion commons-lang to 3.7
+ Exception thrown in ExtendedMessageFormat using quotes with custom registry
+ StringEscapeUtils#UnEscapeJson doesn't recognize escape signs correctly
+ StrSubstitutor: Ability to turn off substitution in values
+ RandomStringGenerator able to pass multiple ranges to .withinRange()
+ Deprecate isDelimiter and use HashSets for delimiter checks
+ WordUtils.initials support for UTF-16 surrogate pairs
+ WordUtils should treat an empty delimiter array as no delimiters
+ Update RandomStringGenerator to accept a list of valid characters
+ Add CharacterPredicates for ASCII letters (uppercase/lowercase) and arabic numerals
+ Added CaseUtils class with camel case conversion support
+ RandomStringGenerator should be able to generate a String with a random length
+ Update commons-lang dependency to version 3.6
+ Document that commons-csv should be used in preference to CsvTranslators
+ NumericEntityUnescaper.options - fix TODO
+ RandomStringGenerator claims to be immutable, but isn't
+ Add StrLookup.resourceBundleLookup(ResourceBundle)
+ Typo in LongestCommonSubsequence#logestCommonSubsequence
+
+
+ WordUtils should use toXxxxCase(int) rather than toXxxxCase(char)
+ WordUtils.abbreviate support
+ Putting WordUtils back in to the codebase
+ Add RandomStringGenerator
+ RandomStringGenerator: allow users to provide source of randomness
+ Correct round issue in Jaro Winkler implementation
+ Similar to LANG-1025, clirr fails site build.
+
+
- Investigate locale issue in ExtendedMessageFormatTest
- Resolve PMD/CMD Violations
- Escape HTML characters only once: revert
- Fixing the 200 checkstyle errors present in 1.0-beta-1
- Mutable fields should be private
-
-
-
- Incorporate suggestions from RC2 into 1.0 release
- Naming packages org.apache.commons.text.beta
- Upgrading Jacoco for Java 9-ea compatibility.
- Refactor EntityArrays to have unmodifiableMaps in leu of String[][]
- Prepare site for 1.0 release
- Move CvsTranslators out of StringEscapeUtils and make them DRY
- Remove WordUtils to be added back in an upcoming 1.X release
- Possible attacks through StringEscapeUtils.escapeEcmaScrip better javadoc
- Remove RandomStringGenerator to be added back in the 1.1 release
- Upgrade from commons-parent version 41 to version 42
- Escape HTML characters only once
- Global vs local source of randomness
- Fluent API in "RandomStringBuilder"
- Fix JaroWinklerDistance in the manner of LUCENE-1297
- Add LCS similarity and distance
- Add class to generate random strings
- Unfinished class Javadoc for CosineDistance
- Consolidating since tags at 1.0, removing deprecated methods
- Add a builder to StringEscapeUtils
- Add shell/XSI escape/unescape support
- LevenshteinDistance reduce memory consumption
- Remove org.apache.commons.text.names, for later release than 1.0
- Add Jaccard Index and Jaccard Distance
- Move org.apache.commons.lang3.StringEscapeUtils.java into text
- Moving from commons-lang, the package org.apache.commons.lang3.text
- A more complex Levenshtein distance
- Add coveralls and Travis.ci integration
- Add alphabet converter
- Create Commons Text logo
- Improve HumanNameParser
- IP clearance for the names package
- Write user guide
- Work on the string metric, distance, and similarity definitions for the project
- Human name parser
- Create StringDistanceFrom class that contains a StringMetric and the "left" side string. This would have a method that accepts the "right" side string to test.
- Add Cosine Similarity and Cosine Distance
- Change (R) StringMetric.compare(CS left, CS right) to "apply" so that it is consistent with BiFunction.
- Allow extra information (e.g. Levenshtein threshold) to be stored as (final) fields in the StringMetric instance.
- Port Myers algorithm from [collections]
- Add Hamming distance
- Incorporate String algorithms from Commons Lang
-
-
+ Investigate locale issue in ExtendedMessageFormatTest
+ Resolve PMD/CMD Violations
+ Escape HTML characters only once: revert
+ Fixing the 200 checkstyle errors present in 1.0-beta-1
+ Mutable fields should be private
+
+
+ Incorporate suggestions from RC2 into 1.0 release
+ Naming packages org.apache.commons.text.beta
+ Upgrading Jacoco for Java 9-ea compatibility.
+ Refactor EntityArrays to have unmodifiableMaps in leu of String[][]
+ Prepare site for 1.0 release
+ Move CvsTranslators out of StringEscapeUtils and make them DRY
+ Remove WordUtils to be added back in an upcoming 1.X release
+ Possible attacks through StringEscapeUtils.escapeEcmaScrip better javadoc
+ Remove RandomStringGenerator to be added back in the 1.1 release
+ Upgrade from commons-parent version 41 to version 42
+ Escape HTML characters only once
+ Global vs local source of randomness
+ Fluent API in "RandomStringBuilder"
+ Fix JaroWinklerDistance in the manner of LUCENE-1297
+ Add LCS similarity and distance
+ Add class to generate random strings
+ Unfinished class Javadoc for CosineDistance
+ Consolidating since tags at 1.0, removing deprecated methods
+ Add a builder to StringEscapeUtils
+ Add shell/XSI escape/unescape support
+ LevenshteinDistance reduce memory consumption
+ Remove org.apache.commons.text.names, for later release than 1.0
+ Add Jaccard Index and Jaccard Distance
+ Move org.apache.commons.lang3.StringEscapeUtils.java into text
+ Moving from commons-lang, the package org.apache.commons.lang3.text
+ A more complex Levenshtein distance
+ Add coveralls and Travis.ci integration
+ Add alphabet converter
+ Create Commons Text logo
+ Improve HumanNameParser
+ IP clearance for the names package
+ Write user guide
+ Work on the string metric, distance, and similarity definitions for the project
+ Human name parser
+ Create StringDistanceFrom class that contains a StringMetric and the "left" side string. This would have a method that accepts the "right" side string to test.
+ Add Cosine Similarity and Cosine Distance
+ Change (R) StringMetric.compare(CS left, CS right) to "apply" so that it is consistent with BiFunction.
+ Allow extra information (e.g. Levenshtein threshold) to be stored as (final) fields in the StringMetric instance.
+ Port Myers algorithm from [collections]
+ Add Hamming distance
+ Incorporate String algorithms from Commons Lang
+
diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm
index c9f6686a7e..35e7a381b8 100644
--- a/src/changes/release-notes.vm
+++ b/src/changes/release-notes.vm
@@ -32,7 +32,7 @@ See the License for the specific language governing permissions and
limitations under the License.
${project.name} ${version} Release Notes
-------------------------------------------------
+----------------------------------------
The ${developmentTeam} is pleased to announce the release of ${project.name} ${version}.
diff --git a/src/conf/checkstyle.xml b/src/conf/checkstyle.xml
index 7ae6627aff..0158804daa 100644
--- a/src/conf/checkstyle.xml
+++ b/src/conf/checkstyle.xml
@@ -85,6 +85,7 @@
+
diff --git a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
index 2baac548f0..4dcd957fe5 100644
--- a/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
+++ b/src/main/java/org/apache/commons/text/ExtendedMessageFormat.java
@@ -33,15 +33,20 @@
/**
* Extends {@link java.text.MessageFormat} to allow pluggable/additional formatting
- * options for embedded format elements. Client code should specify a registry
+ * options for embedded format elements.
+ *
+ * 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):
+ *
* 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/lookup/StringLookupFactory.java b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
index 863baa7f34..699b7deab7 100644
--- a/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
+++ b/src/main/java/org/apache/commons/text/lookup/StringLookupFactory.java
@@ -1718,15 +1718,14 @@ public StringLookup xmlStringLookup(final Map factoryFeatures)
*
{@code "com/domain/document.xml:/path/to/node"}
*
*
- * Secure processing is enabled by default and can be overridden with the system property {@code "XmlStringLookup.secure"} set to {@code false}. The secure
- * boolean String parsing follows the syntax defined by {@link Boolean#parseBoolean(String)}.
+ * Secure processing is enabled by default and can be overridden with this constructor.
*
*
* Using a {@link StringLookup} from the {@link StringLookupFactory} fenced by the current directory ({@code Paths.get("")}):
*
* To use a {@link StringLookup} fenced by the current directory, use:
diff --git a/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java b/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
index 85747eebc2..ee33441993 100644
--- a/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
+++ b/src/main/java/org/apache/commons/text/lookup/XmlStringLookup.java
@@ -30,7 +30,6 @@
import javax.xml.xpath.XPathFactory;
import org.apache.commons.lang3.StringUtils;
-import org.apache.commons.lang3.SystemProperties;
import org.w3c.dom.Document;
/**
@@ -42,8 +41,7 @@
*
{@code "com/domain/document.xml:/path/to/node"}
*
*
- * Secure processing is enabled by default and can be overridden with the system property {@code "XmlStringLookup.secure"} set to {@code false}. The secure
- * boolean String parsing follows the syntax defined by {@link Boolean#parseBoolean(String)}.
+ * Secure processing is enabled by default and can be overridden with {@link StringLookupFactory#xmlStringLookup(Map, Path...)}.
*
*
* @since 1.5
@@ -72,14 +70,13 @@ final class XmlStringLookup extends AbstractPathFencedLookup {
}
/**
- * Defines the singleton for this class with secure processing enabled.
+ * Defines the singleton for this class with secure processing enabled by default.
+ *
+ * Secure processing is enabled by default and can be overridden with {@link StringLookupFactory#xmlStringLookup(Map, Path...)}.
+ *
- * Secure processing is enabled by default. The secure boolean String parsing follows the syntax defined by {@link Boolean#parseBoolean(String)}. The secure
- * value in the key overrides instance settings given in the constructor.
+ * Secure processing is enabled by default and can be overridden with {@link StringLookupFactory#xmlStringLookup(Map, Path...)}.
*
*
* @param key the key to be looked up, may be null.
@@ -130,7 +126,6 @@ public String lookup(final String key) {
if (keyLen != KEY_PARTS_LEN) {
throw IllegalArgumentExceptions.format("Bad XML key format '%s'; the expected format is 'DocumentPath:XPath'.", key);
}
- final boolean secure = isSecure();
final String documentPath = keys[0];
final String xpath = StringUtils.substringAfterLast(key, SPLIT_CH);
final DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
@@ -138,14 +133,12 @@ public String lookup(final String key) {
for (final Entry p : xmlFactoryFeatures.entrySet()) {
dbFactory.setFeature(p.getKey(), p.getValue());
}
- dbFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, secure);
try (InputStream inputStream = Files.newInputStream(getPath(documentPath))) {
final Document doc = dbFactory.newDocumentBuilder().parse(inputStream);
final XPathFactory xpFactory = XPathFactory.newInstance();
for (final Entry p : xPathFactoryFeatures.entrySet()) {
xpFactory.setFeature(p.getKey(), p.getValue());
}
- xpFactory.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, secure);
return xpFactory.newXPath().evaluate(xpath, doc);
}
} catch (final Exception e) {
diff --git a/src/main/java/org/apache/commons/text/similarity/EditDistance.java b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
index 2b81d8d9c2..77b735dbd2 100644
--- a/src/main/java/org/apache/commons/text/similarity/EditDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/EditDistance.java
@@ -27,10 +27,10 @@
* the set {@code S}:
*
*
- *
{@code d(x,y) >= 0}, non-negativity or separation axiom
- *
{@code d(x,y) == 0}, if and only if, {@code x == y}
- *
{@code d(x,y) == d(y,x)}, symmetry, and
- *
{@code d(x,z) <= d(x,y) + d(y,z)}, the triangle inequality
+ *
{@code d(x, y) >= 0}, non-negativity or separation axiom
+ *
{@code d(x, y) == 0}, if and only if, {@code x == y}
*
*
diff --git a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
index 8bd8d7b7a8..e2e3d0df3f 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWinklerDistance.java
@@ -36,7 +36,8 @@ public class JaroWinklerDistance implements EditDistance {
* @param first the first string to be matched.
* @param second the second string to be matched.
* @return array containing: matches, half transpositions, and prefix
- * @deprecated Deprecated as of 1.7. This method will be removed in 2.0, and moved to a Jaro Winkler similarity class. TODO see TEXT-104.
+ * @deprecated Deprecated as of 1.7, use {@link JaroWinklerSimilarity#matches(CharSequence, CharSequence)}. This method will be removed in 2.0. TODO see
+ * TEXT-104.
*/
@Deprecated
protected static int[] matches(final CharSequence first, final CharSequence second) {
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.
*
* 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) {
*
* 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
*
*
*
* 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.
*
* 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.
*
* 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/ObjectSimilarityScore.java b/src/main/java/org/apache/commons/text/similarity/ObjectSimilarityScore.java
index 393518aed7..21ce3afbcb 100644
--- a/src/main/java/org/apache/commons/text/similarity/ObjectSimilarityScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/ObjectSimilarityScore.java
@@ -30,8 +30,8 @@
* A similarity score is the function {@code d: [X * X] -> [0, INFINITY)} with the following properties:
*
*
- *
{@code d(x,y) >= 0}, non-negativity or separation axiom
- *
{@code d(x,y) == d(y,x)}, symmetry.
+ *
{@code d(x, y) >= 0}, non-negativity or separation axiom
+ *
{@code d(x, y) == d(y, x)}, symmetry.
*
*
*
diff --git a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
index 4a2f7de7e3..dcd1dbaf46 100644
--- a/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
+++ b/src/main/java/org/apache/commons/text/similarity/SimilarityScore.java
@@ -27,8 +27,8 @@
* following properties:
*
*
- *
{@code d(x,y) >= 0}, non-negativity or separation axiom
- *
{@code d(x,y) == d(y,x)}, symmetry.
+ *
{@code d(x, y) >= 0}, non-negativity or separation axiom
+ *
{@code d(x, y) == d(y, x)}, symmetry.
*
*
* Notice, these are two of the properties that contribute to {@code d} being a metric.
diff --git a/src/main/java/org/apache/commons/text/similarity/package-info.java b/src/main/java/org/apache/commons/text/similarity/package-info.java
index 3a2273ff1b..a0cdec2daa 100644
--- a/src/main/java/org/apache/commons/text/similarity/package-info.java
+++ b/src/main/java/org/apache/commons/text/similarity/package-info.java
@@ -37,7 +37,7 @@
*
*
*
The {@link org.apache.commons.text.similarity.CosineDistance Cosine Distance}
- * utilises a {@link org.apache.commons.text.similarity.RegexTokenizer regular expression tokenizer (\w+)}.
+ * utilizes a {@link org.apache.commons.text.similarity.RegexTokenizer regular expression tokenizer (\w+)}.
* And the {@link org.apache.commons.text.similarity.LevenshteinDistance Levenshtein Distance}'s
* behavior can be changed to take into consideration a maximum throughput.
*
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/download_text.xml b/src/site/xdoc/download_text.xml
index 4f7cbc7c3a..e2a425aa83 100644
--- a/src/site/xdoc/download_text.xml
+++ b/src/site/xdoc/download_text.xml
@@ -58,7 +58,7 @@ limitations under the License.
-->
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd">
Download Apache Commons TextApache Commons Team
@@ -115,32 +115,32 @@ limitations under the License.
-
+