The Spans type exposes the following members.

Constructors

  NameDescription
Protected methodSpans
Initializes a new instance of the Spans class

Methods

  NameDescription
Public methodDoc
Returns the document number of the current match. Initially invalid.
Public methodEnd
Returns the end position of the current match. Initially invalid.
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 methodGetPayload
Returns the payload data for the current span. This is invalid until {@link #Next()} is called for the first time. This method must not be called more than once after each call of {@link #Next()}. However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.
Note that the return type is a collection, thus the ordering should not be relied upon.

WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsPayloadAvailable
Checks if a payload can be loaded at this position.

Payloads can only be loaded once per call to {@link #Next()}.

Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNext
Move to the next match, returning true iff any such exists.
Public methodSkipTo
Skips to the first match beyond the current, whose document number is greater than or equal to target.

Returns true iff there is such a match.

Behaves as if written:

            boolean skipTo(int target) {
            do {
            if (!next())
            return false;
            } while (target > doc());
            return true;
            }
            
Most implementations are considerably more efficient than that.
Public methodStart
Returns the start position of the current match. Initially invalid.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

See Also