svn commit: r798110 - /lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java

[us...@apache.org]

Author: uschindler
Date: Mon Jul 27 12:03:51 2009
New Revision: 798110

URL: http://svn.apache.org/viewvc?rev=798110&view=rev
Log:
LUCENE-1754: JavaDoc updates

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java?rev=798110&r1=798109&r2=798110&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/DocIdSet.java Mon Jul 27 12:03:51 2009
@@ -18,7 +18,6 @@
  */
 
 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 @@
  */
 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 @@
   };
     
   /** 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;
 }