OffsetLimitTokenFilter (Lucene 9.3.0 highlighter API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.search.highlight.OffsetLimitTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Unwrappable<TokenStream>
```
public final class OffsetLimitTokenFilter
extends TokenFilter
```
This TokenFilter limits the number of tokens while indexing by adding up the current offset.

- Nested Class Summary
  - Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
    AttributeSource.State
- Field Summary
  - Fields inherited from class org.apache.lucene.analysis.TokenFilter
    input
  - Fields inherited from class org.apache.lucene.analysis.TokenStream
    DEFAULT_TOKEN_ATTRIBUTE_FACTORY
- Constructor Summary
  
  Constructors
  Constructor Description
  
  OffsetLimitTokenFilter(TokenStream input, int offsetLimit)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean incrementToken()
  
  void reset()
  - Methods inherited from class org.apache.lucene.analysis.TokenFilter
    close, end, unwrap
  - Methods inherited from class org.apache.lucene.util.AttributeSource
    addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OffsetLimitTokenFilter

public OffsetLimitTokenFilter(TokenStream input,
                              int offsetLimit)

Method Detail
- incrementToken
```
public boolean incrementToken()
                       throws IOException
```
  Specified by:
  
  incrementToken in class TokenStream
  
  Throws:
  
  IOException
- reset
```
public void reset()
           throws IOException
```
  Overrides:
  
  reset in class TokenFilter
  
  Throws:
  
  IOException