Deprecate StringKeyAnalyzer.StringKeyAnalyzer() in favor of

StringKeyAnalyzer.INSTANCE
apache · Jun 23, 2024 · c30df24 · c30df24
1 parent 6c609f0
commit c30df24
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -29,6 +29,7 @@
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate AbstractEmptyIterator.add(E) without replacement.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">Add missing Javadocs.</action>
     <action type="fix" dev="ggregory" due-to="Gary Gregory">PatriciaTrie constructor reuse the stateless singleton StringKeyAnalyzer.INSTANCE.</action>
+    <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate StringKeyAnalyzer.StringKeyAnalyzer() in favor of StringKeyAnalyzer.INSTANCE.</action>
     <!-- ADD -->
     <!-- UPDATE -->
   </release>

diff --git a/src/main/java/org/apache/commons/collections4/trie/analyzer/StringKeyAnalyzer.java b/src/main/java/org/apache/commons/collections4/trie/analyzer/StringKeyAnalyzer.java
@@ -20,7 +20,9 @@
 
 /**
  * An {@link KeyAnalyzer} for {@link String}s.
- *
+ * <p>
+ * This class is stateless.
+ * </p>
  * @since 4.0
  */
 public class StringKeyAnalyzer extends KeyAnalyzer<String> {
@@ -41,6 +43,16 @@ private static int mask(final int bit) {
         return MSB >>> bit;
     }
 
+    /**
+     * Constructs a new instance.
+     *
+     * @deprecated Use {@link #INSTANCE}.
+     */
+    @Deprecated
+    public StringKeyAnalyzer() {
+        // empty
+    }
+
     @Override
     public int bitIndex(final String key, final int offsetInBits, final int lengthInBits,
                         final String other, final int otherOffsetInBits, final int otherLengthInBits) {