The SegmentTermEnum type exposes the following members.

Methods

  NameDescription
Public methodClone
Public methodClose
Closes the enumeration to further activity, freeing resources.
(Overrides TermEnum..::..Close()()()().)
Public methodDocFreq
Returns the docFreq from the current TermInfo in the enumeration. Initially invalid, valid after next() called for the first time.
(Overrides TermEnum..::..DocFreq()()()().)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNext
Increments the enumeration to the next element. True if one exists.
(Overrides TermEnum..::..Next()()()().)
Public methodPrev
Returns the previous Term enumerated. Initially null.
Public methodSkipTo Obsolete.
Skips terms to the first beyond the current whose value is greater or equal to target.

Returns true iff there is such an entry.

Behaves as if written:

            public boolean skipTo(Term target) {
            do {
            if (!next())
            return false;
            } while (target > term());
            return true;
            }
            
Some implementations *could* be considerably more efficient than a linear scan. Check the implementation to be sure.
(Inherited from TermEnum.)
Public methodTerm
Returns the current Term in the enumeration. Initially invalid, valid after next() called for the first time.
(Overrides TermEnum..::..Term()()()().)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

See Also