LUCENE-6271: add verbosity to sugar method on LeafReader too

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/branches/lucene6271@1670419 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Muir 2015-03-31 18:32:13 +00:00
parent 78c1239c98
commit 15b0596939
1 changed files with 8 additions and 1 deletions

View File

@ -223,7 +223,14 @@ public abstract class LeafReader extends IndexReader {
}
/** Returns {@link PostingsEnum} for the specified term
* with {@link PostingsEnum#FREQS}. */
* with {@link PostingsEnum#FREQS}.
* <p>
* Use this method if you only require documents and frequencies,
* and do not need any proximity data.
* This method is equivalent to
* {@link #postings(Term, int) postings(term, PostingsEnum.FREQS)}
* @see #postings(Term, int)
*/
public final PostingsEnum postings(Term term) throws IOException {
return postings(term, PostingsEnum.FREQS);
}