(commons-text) 02/02: Deprecate LevenshteinDistance.LevenshteinDistance() in favor of LevenshteinDistance.getDefaultInstance()

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-text.git

commit 62935d5324cb153a6739133d9f345587f6aadba2
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon May 6 09:23:24 2024 -0400

    Deprecate LevenshteinDistance.LevenshteinDistance() in favor of
    LevenshteinDistance.getDefaultInstance()
---
 src/changes/changes.xml                                                 | 1 +
 .../org/apache/commons/text/similarity/LevenshteinDetailedDistance.java | 2 +-
 .../java/org/apache/commons/text/similarity/LevenshteinDistance.java    | 2 ++
 3 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index a2d5b73a..4afd0be8 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -59,6 +59,7 @@ The <action> type attribute can be add,update,fix,remove.
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Make 
package-private class private: StrMatcher.TrimMatcher.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Make 
package-private class private and final: 
IntersectionSimilarity.BagCount.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Make 
package-private class private and final: 
IntersectionSimilarity.TinyCount.</action>
+    <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate 
LevenshteinDistance.LevenshteinDistance() in favor of 
LevenshteinDistance.getDefaultInstance().</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate 
LevenshteinDetailedDistance.LevenshteinDetailedDistance() in favor of 
LevenshteinDetailedDistance.getDefaultInstance().</action>
     <!-- UPDATE -->
     <action type="udpate" dev="ggregory" due-to="Gary Gregory">Bump tests on 
Java >= 22 org.graalvm.*:* from 24.0.0 to 24.0.1.</action>
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 ed4a0cca..f56317d5 100644
--- 
a/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
+++ 
b/src/main/java/org/apache/commons/text/similarity/LevenshteinDetailedDistance.java
@@ -452,7 +452,7 @@ public class LevenshteinDetailedDistance implements 
EditDistance<LevenshteinResu
      * </p>
      *
      * @see LevenshteinDetailedDistance#getDefaultInstance()
-     * @deprecated Use {@link #getDefaultInstance()}
+     * @deprecated Use {@link #getDefaultInstance()}.
      */
     @Deprecated
     public LevenshteinDetailedDistance() {
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 570b45ed..b1f74921 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
@@ -327,7 +327,9 @@ public class LevenshteinDistance implements 
EditDistance<Integer> {
      * of the algorithm that does not use a threshold parameter.
      *
      * @see LevenshteinDistance#getDefaultInstance()
+     * @deprecated Use {@link #getDefaultInstance()}.
      */
+    @Deprecated
     public LevenshteinDistance() {
         this(null);
     }