Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-10603: Mark SortedSetDocValues#NO_MORE_ORDS deprecated (#969)

This commit is contained in:
Greg Miller 2022-06-21 09:05:15 -07:00 committed by GitHub
parent 68f77dbf53
commit 8f459eb0f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lucene/CHANGES.txt
View File

@ -71,7 +71,9 @@ Other
API Changes
---------------------
(No changes)
* LUCENE-10603: SortedSetDocValues#NO_MORE_ORDS marked @deprecated in favor of iterating with
SortedSetDocValues#docValueCount(). (Greg Miller)
New Features
---------------------

13
lucene/core/src/java/org/apache/lucene/index/SortedSetDocValues.java
View File

@ -32,13 +32,22 @@ public abstract class SortedSetDocValues extends DocValuesIterator {
/** Sole constructor. (For invocation by subclass constructors, typically implicit.) */
protected SortedSetDocValues() {}
/** When returned by {@link #nextOrd()} it means there are no more ordinals for the document. */
public static final long NO_MORE_ORDS = -1;
/**
* When returned by {@link #nextOrd()} it means there are no more ordinals for the document.
*
* @deprecated Will be removed in a future version. Please use {@link #docValueCount()} to know
* the number of doc values for the current document up-front.
*/
@Deprecated public static final long NO_MORE_ORDS = -1;
/**
* Returns the next ordinal for the current document. It is illegal to call this method after
* {@link #advanceExact(int)} returned {@code false}.
*
* <p>Note: Returns {@link #NO_MORE_ORDS} when the current document has no more ordinals. This
* behavior will be removed in a future version. Callers should use {@link #docValueCount()} to
* determine the number of values for the current document up-front.
*
* @return next ordinal for the document, or {@link #NO_MORE_ORDS}. ordinals are dense, start at
* 0, then increment by 1 for the next value in sorted order.
*/