(opennlp) branch OPENNLP-1588-Clean-out-deprecated-code-marked-for-removal created (now c6331d5e)

[ma...@apache.org]

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

mawiesne pushed a change to branch OPENNLP-1588-Clean-out-deprecated-code-marked-for-removal
in repository https://gitbox.apache.org/repos/asf/opennlp.git


      at c6331d5e OPENNLP-1588 Clean out deprecated code marked for removal - removes deprecated getters in several records - removes a very long time deprecated constructor of TokenizerME - marks a constructor of ADNameSampleStream as "for removal" to indicate actual removal is more likely in upcoming releases - marks deprecated 'NameFinderEventStream#generateOutcomes(..)' as "for removal" to indicate actual removal is more likely in upcoming releases

This branch includes the following new commits:

     new c6331d5e OPENNLP-1588 Clean out deprecated code marked for removal - removes deprecated getters in several records - removes a very long time deprecated constructor of TokenizerME - marks a constructor of ADNameSampleStream as "for removal" to indicate actual removal is more likely in upcoming releases - marks deprecated 'NameFinderEventStream#generateOutcomes(..)' as "for removal" to indicate actual removal is more likely in upcoming releases

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

(opennlp) 01/01: OPENNLP-1588 Clean out deprecated code marked for removal - removes deprecated getters in several records - removes a very long time deprecated constructor of TokenizerME - marks a constructor of ADNameSampleStream as "for removal" to indicate actual removal is more likely in upcoming releases - marks deprecated 'NameFinderEventStream#generateOutcomes(..)' as "for removal" to indicate actual removal is more likely in upcoming releases

[ma...@apache.org]

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

mawiesne pushed a commit to branch OPENNLP-1588-Clean-out-deprecated-code-marked-for-removal
in repository https://gitbox.apache.org/repos/asf/opennlp.git

commit c6331d5e32e72449aba9ca2d8ec52b9af5660228
Author: Martin Wiesner <ma...@hs-heilbronn.de>
AuthorDate: Wed Jul 3 22:22:17 2024 +0200

    OPENNLP-1588 Clean out deprecated code marked for removal
    - removes deprecated getters in several records
    - removes a very long time deprecated constructor of TokenizerME
    - marks a constructor of ADNameSampleStream as "for removal" to indicate actual removal is more likely in upcoming releases
    - marks deprecated 'NameFinderEventStream#generateOutcomes(..)' as "for removal" to indicate actual removal is more likely in upcoming releases
---
 opennlp-dl/src/main/java/opennlp/dl/SpanEnd.java   | 10 --------
 opennlp-dl/src/main/java/opennlp/dl/Tokens.java    | 19 --------------
 .../opennlp/tools/dictionary/serializer/Entry.java |  9 -------
 .../tools/formats/ad/ADNameSampleStream.java       |  2 +-
 .../opennlp/tools/langdetect/LanguageSample.java   | 14 +++-------
 .../langdetect/ProbingLanguageDetectionResult.java |  9 -------
 .../tools/namefind/NameFinderEventStream.java      |  2 +-
 .../java/opennlp/tools/tokenize/TokenizerME.java   | 30 ----------------------
 .../src/main/java/opennlp/tools/util/TokenTag.java | 15 -----------
 9 files changed, 5 insertions(+), 105 deletions(-)

diff --git a/opennlp-dl/src/main/java/opennlp/dl/SpanEnd.java b/opennlp-dl/src/main/java/opennlp/dl/SpanEnd.java
index d8b02cbc..2c91c192 100644
--- a/opennlp-dl/src/main/java/opennlp/dl/SpanEnd.java
+++ b/opennlp-dl/src/main/java/opennlp/dl/SpanEnd.java
@@ -19,16 +19,6 @@ package opennlp.dl;
 
 public record SpanEnd(int index, int characterEnd) {
 
-  @Deprecated(forRemoval = true)
-  public int getIndex() {
-    return index;
-  }
-  
-  @Deprecated(forRemoval = true)
-  public int getCharacterEnd() {
-    return characterEnd;
-  }
-
   @Override
   public String toString() {
     return "index: " + index + "; character end: " + characterEnd;
diff --git a/opennlp-dl/src/main/java/opennlp/dl/Tokens.java b/opennlp-dl/src/main/java/opennlp/dl/Tokens.java
index 45a12491..f5c105fe 100644
--- a/opennlp-dl/src/main/java/opennlp/dl/Tokens.java
+++ b/opennlp-dl/src/main/java/opennlp/dl/Tokens.java
@@ -27,23 +27,4 @@ package opennlp.dl;
  */
 public record Tokens(String[] tokens, long[] ids, long[] mask, long[] types) {
 
-  @Deprecated(forRemoval = true)
-  public String[] getTokens() {
-    return tokens;
-  }
-
-  @Deprecated(forRemoval = true)
-  public long[] getIds() {
-    return ids;
-  }
-
-  @Deprecated(forRemoval = true)
-  public long[] getMask() {
-    return mask;
-  }
-
-  @Deprecated(forRemoval = true)
-  public long[] getTypes() {
-    return types;
-  }
 }
diff --git a/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/Entry.java b/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/Entry.java
index e8d5ef65..d4cbf79c 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/Entry.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/dictionary/serializer/Entry.java
@@ -31,13 +31,4 @@ import opennlp.tools.util.StringList;
  */
 public record Entry(StringList tokens, Attributes attributes) {
 
-  @Deprecated(forRemoval = true)
-  public StringList getTokens() {
-    return tokens;
-  }
-  
-  @Deprecated(forRemoval = true)
-  public Attributes getAttributes() {
-    return attributes;
-  }
 }
diff --git a/opennlp-tools/src/main/java/opennlp/tools/formats/ad/ADNameSampleStream.java b/opennlp-tools/src/main/java/opennlp/tools/formats/ad/ADNameSampleStream.java
index ab5b54f6..dae804be 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/formats/ad/ADNameSampleStream.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/formats/ad/ADNameSampleStream.java
@@ -184,7 +184,7 @@ public class ADNameSampleStream implements ObjectStream<NameSample> {
    * @param splitHyphenatedTokens If {@code true} hyphenated tokens will be separated:
    *                              "carros-monstro" &gt; "carros" "-" "monstro".
    */
-  @Deprecated
+  @Deprecated(forRemoval = true)
   public ADNameSampleStream(InputStreamFactory in, String charsetName,
       boolean splitHyphenatedTokens) throws IOException {
     this(new PlainTextByLineStream(in, charsetName), splitHyphenatedTokens);
diff --git a/opennlp-tools/src/main/java/opennlp/tools/langdetect/LanguageSample.java b/opennlp-tools/src/main/java/opennlp/tools/langdetect/LanguageSample.java
index dca39734..3926c95b 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/langdetect/LanguageSample.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/langdetect/LanguageSample.java
@@ -17,6 +17,7 @@
 
 package opennlp.tools.langdetect;
 
+import java.io.Serial;
 import java.io.Serializable;
 import java.util.Objects;
 
@@ -25,23 +26,14 @@ import java.util.Objects;
  */
 public record LanguageSample(Language language, CharSequence context) implements Serializable {
 
-  private static final long serialVersionUID = -2222893493240468729L;
+  @Serial
+  private static final long serialVersionUID = -4791295976215940258L;
 
   public LanguageSample(Language language, CharSequence context) {
     this.language = Objects.requireNonNull(language, "language must not be null");
     this.context = Objects.requireNonNull(context, "context must not be null");
   }
 
-  @Deprecated(forRemoval = true)
-  public Language getLanguage() {
-    return language;
-  }
-
-  @Deprecated(forRemoval = true)
-  public CharSequence getContext() {
-    return context;
-  }
-
   @Override
   public String toString() {
     return language.getLang() + '\t' + context;
diff --git a/opennlp-tools/src/main/java/opennlp/tools/langdetect/ProbingLanguageDetectionResult.java b/opennlp-tools/src/main/java/opennlp/tools/langdetect/ProbingLanguageDetectionResult.java
index 7500336a..42857751 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/langdetect/ProbingLanguageDetectionResult.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/langdetect/ProbingLanguageDetectionResult.java
@@ -25,13 +25,4 @@ package opennlp.tools.langdetect;
  */
 public record ProbingLanguageDetectionResult(Language[] languages, int length) {
 
-  @Deprecated(forRemoval = true)
-  public Language[] getLanguages() {
-    return languages;
-  }
-
-  @Deprecated(forRemoval = true)
-  public int getLength() {
-    return length;
-  }
 }
diff --git a/opennlp-tools/src/main/java/opennlp/tools/namefind/NameFinderEventStream.java b/opennlp-tools/src/main/java/opennlp/tools/namefind/NameFinderEventStream.java
index a77bfbf6..d6361b34 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/namefind/NameFinderEventStream.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/namefind/NameFinderEventStream.java
@@ -83,7 +83,7 @@ public class NameFinderEventStream extends opennlp.tools.util.AbstractEventStrea
    *
    * @deprecated use the {@link BioCodec} implementation of the SequenceValidator instead!
    */
-  @Deprecated
+  @Deprecated(forRemoval = true)
   public static String[] generateOutcomes(Span[] names, String type, int length) {
     String[] outcomes = new String[length];
     Arrays.fill(outcomes, NameFinderME.OTHER);
diff --git a/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java b/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java
index 6664ef27..1c88f84b 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/tokenize/TokenizerME.java
@@ -19,11 +19,9 @@ package opennlp.tools.tokenize;
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 import java.util.regex.Pattern;
 
 import opennlp.tools.dictionary.Dictionary;
@@ -31,7 +29,6 @@ import opennlp.tools.ml.EventTrainer;
 import opennlp.tools.ml.TrainerFactory;
 import opennlp.tools.ml.model.Event;
 import opennlp.tools.ml.model.MaxentModel;
-import opennlp.tools.tokenize.lang.Factory;
 import opennlp.tools.util.DownloadUtil;
 import opennlp.tools.util.ObjectStream;
 import opennlp.tools.util.Span;
@@ -143,33 +140,6 @@ public class TokenizerME extends AbstractTokenizer {
     tokProbs = new ArrayList<>(50);
   }
 
-  /**
-   * @deprecated use {@link TokenizerFactory} to extend the Tokenizer
-   *             functionality
-   */
-  @Deprecated
-  public TokenizerME(TokenizerModel model, Factory factory) {
-    String languageCode = model.getLanguage();
-
-    this.alphanumeric = factory.getAlphanumeric(languageCode);
-    this.cg = factory.createTokenContextGenerator(languageCode,
-        getAbbreviations(model.getAbbreviations()));
-
-    this.model = model.getMaxentModel();
-    useAlphaNumericOptimization = model.useAlphaNumericOptimization();
-
-    abbDict = model.getAbbreviations();
-    newTokens = new ArrayList<>();
-    tokProbs = new ArrayList<>(50);
-  }
-
-  private static Set<String> getAbbreviations(Dictionary abbreviations) {
-    if (abbreviations == null) {
-      return Collections.emptySet();
-    }
-    return abbreviations.asStringSet();
-  }
-
   /**
    * @return the probabilities associated with the most recent calls to
    *         {@link TokenizerME#tokenize(String)} or {@link TokenizerME#tokenizePos(String)}.
diff --git a/opennlp-tools/src/main/java/opennlp/tools/util/TokenTag.java b/opennlp-tools/src/main/java/opennlp/tools/util/TokenTag.java
index 575efe2f..9bd22a64 100644
--- a/opennlp-tools/src/main/java/opennlp/tools/util/TokenTag.java
+++ b/opennlp-tools/src/main/java/opennlp/tools/util/TokenTag.java
@@ -32,21 +32,6 @@ public record TokenTag(String token, String tag, String[] additionalData) {
     }
   }
 
-  @Deprecated(forRemoval = true)
-  public String getToken() {
-    return token;
-  }
-
-  @Deprecated(forRemoval = true)
-  public String getTag() {
-    return tag;
-  }
-
-  @Deprecated(forRemoval = true)
-  public String[] getAdditionalData() {
-    return additionalData;
-  }
-
   public static String[] extractTokens(TokenTag[] tuples) {
     String[] tokens = new String[tuples.length];
     for (int i = 0; i < tuples.length; i++) {