common/org.gnit.lucenekmp.analysis.miscellaneous/LimitTokenPositionFilter

LimitTokenPositionFilter

class LimitTokenPositionFilter : TokenFilter

This TokenFilter limits its emitted tokens to those with positions that are not greater than the configured limit.

By default, this filter ignores any tokens in the wrapped `TokenStream` once the limit has been exceeded, which can result in `reset()` being called prior to `incrementToken()` returning `false`. For most `TokenStream` implementations this should be acceptable, and faster then consuming the full stream. If you are wrapping a `TokenStream` which requires that the full stream of tokens be exhausted in order to function properly, use the [LimitTokenPositionFilter] `consumeAllTokens` option.

Constructors

constructor(in: TokenStream, maxTokenPosition: Int)

Build a filter that only accepts tokens up to and including the given maximum position. This filter will not consume any tokens with position greater than the maxTokenPosition limit.

constructor(in: TokenStream, maxTokenPosition: Int, consumeAllTokens: Boolean)

Build a filter that limits the maximum position of tokens to emit.