Apache Lucene.Net 2.4.0 Class Library API

DocIdSetIterator Members

DocIdSetIterator overview

Public Instance Methods

Doc Returns the current document number. This is invalid until Next() is called for the first time.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
Next Moves to the next docId in the set. Returns true, iff there is such a docId.
SkipTo Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns true iff there is such an entry. Behaves as if written:
 boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; } 
Some implementations are considerably more efficient than that.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

DocIdSetIterator Constructor Initializes a new instance of the DocIdSetIterator class.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

DocIdSetIterator Class | Lucene.Net.Search Namespace