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

LUCENE-6271: docs: TermsEnum.postings(...) will not return null

This commit is contained in:
David Smiley 2018-03-02 13:59:58 -05:00
parent c5938f79e5
commit 79c2988547
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lucene/core/src/java/org/apache/lucene/index/TermsEnum.java
View File

@ -159,8 +159,7 @@ public abstract class TermsEnum implements BytesRefIterator {
/** Get {@link PostingsEnum} for the current term, with /** Get {@link PostingsEnum} for the current term, with
* control over whether freqs, positions, offsets or payloads * control over whether freqs, positions, offsets or payloads
* are required. Do not call this when the enum is * are required. Do not call this when the enum is
* unpositioned. This method may return null if the postings * unpositioned. This method will not return null.
* information required is not available from the index
* <p> * <p>
* <b>NOTE</b>: the returned iterator may return deleted documents, so * <b>NOTE</b>: the returned iterator may return deleted documents, so
* deleted documents have to be checked on top of the {@link PostingsEnum}. * deleted documents have to be checked on top of the {@link PostingsEnum}.