[lucene] branch main updated: Deprecate TermInSetQuery#getTermData (#12173)

[gs...@apache.org]

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

gsmiller pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new c8741f7c586 Deprecate TermInSetQuery#getTermData (#12173)
c8741f7c586 is described below

commit c8741f7c586bf3230f0a2e1c1d933c8df66c0ff0
Author: Greg Miller <gs...@gmail.com>
AuthorDate: Wed Mar 1 05:42:39 2023 -0800

    Deprecate TermInSetQuery#getTermData (#12173)
---
 lucene/CHANGES.txt                                                | 3 +++
 lucene/core/src/java/org/apache/lucene/search/TermInSetQuery.java | 8 +++++++-
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index dc7ffdcb265..6650543ea8d 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -112,6 +112,9 @@ API Changes
 * GITHUB#12129: Move DocValuesTermsQuery from sandbox to SortedDocValuesField#newSlowSetQuery
   and SortedSetDocValuesField#newSlowSetQuery. (Robert Muir)
 
+* GITHUB#12173: TermInSetQuery#getTermData has been deprecated. This exposes internal implementation details that we
+  may want to change in the future, and users shouldn't rely on the encoding directly. (Greg Miller)
+
 New Features
 ---------------------
 
diff --git a/lucene/core/src/java/org/apache/lucene/search/TermInSetQuery.java b/lucene/core/src/java/org/apache/lucene/search/TermInSetQuery.java
index 9d482369975..ecffb438112 100644
--- a/lucene/core/src/java/org/apache/lucene/search/TermInSetQuery.java
+++ b/lucene/core/src/java/org/apache/lucene/search/TermInSetQuery.java
@@ -178,7 +178,13 @@ public class TermInSetQuery extends MultiTermQuery implements Accountable {
     return 31 * classHash() + termDataHashCode;
   }
 
-  /** Returns the terms wrapped in a PrefixCodedTerms. */
+  /**
+   * Returns the terms wrapped in a PrefixCodedTerms.
+   *
+   * @deprecated the encoded terms will no longer be exposed in a future major version; this is an
+   *     implementation detail that could change at some point and shouldn't be relied on directly
+   */
+  @Deprecated
   public PrefixCodedTerms getTermData() {
     return termData;
   }