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

LUCENE-1754: JavaDoc updates 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@798110 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Uwe Schindler 2009-07-27 12:03:51 +00:00
parent 45cf5ebe33
commit 72a17d83d3
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/java/org/apache/lucene/search/DocIdSet.java
View File

@ -18,7 +18,6 @@ package org.apache.lucene.search;
*/
import java.io.IOException;
import org.apache.lucene.util.SortedVIntList;
/**
* A DocIdSet contains a set of doc ids. Implementing classes must
@ -26,8 +25,7 @@ import org.apache.lucene.util.SortedVIntList;
*/
public abstract class DocIdSet {
/** An empty {@code DocIdSet} instance for easy use (this is currently
* implemented using a {@link SortedVIntList}). */
/** An empty {@code DocIdSet} instance for easy use, e.g. in Filters that hit no documents. */
public static final DocIdSet EMPTY_DOCIDSET = new DocIdSet() {
private final DocIdSetIterator iterator = new DocIdSetIterator() {
@ -42,7 +40,8 @@ public abstract class DocIdSet {
};
/** Provides a {@link DocIdSetIterator} to access the set.
* This may (but is not required to) return null if there
* This implementation can return <code>null</code> or
* <code>{@linkplain #EMPTY_DOCIDSET}.iterator()</code> if there
* are no docs that match. */
public abstract DocIdSetIterator iterator() throws IOException;
}