TypeAsPayloadTokenFilter (Lucene 8.5.1 API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.analysis.payloads.TypeAsPayloadTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class TypeAsPayloadTokenFilter
extends TokenFilter
```
Makes the TypeAttribute a payload. Encodes the type using String.getBytes(String) with "UTF-8" as the encoding

- 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
  
  TypeAsPayloadTokenFilter(TokenStream input)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean incrementToken()
  - Methods inherited from class org.apache.lucene.analysis.TokenFilter
    close, end, reset
  - 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

TypeAsPayloadTokenFilter

public TypeAsPayloadTokenFilter(TokenStream input)

Method Detail
- incrementToken
```
public final boolean incrementToken()
                             throws IOException
```
  Specified by:
  
  incrementToken in class TokenStream
  
  Throws:
  
  IOException