Package org.apache.lucene.analysis.core

# Class KeywordTokenizer

java.lang.Object
org.apache.lucene.util.AttributeSource
org.apache.lucene.analysis.TokenStream
org.apache.lucene.analysis.Tokenizer
org.apache.lucene.analysis.core.KeywordTokenizer

All Implemented Interfaces:
  `Closeable`, `AutoCloseable`

public final class KeywordTokenizer extends Tokenizer
Emits the entire input as a single token.

## Nested Class Summary

## Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource

`AttributeSource.State`

## Field Summary

Fields
Modifier and Type
Field
Description
`static final int`
`DEFAULT_BUFFER_SIZE`
Default read buffer size

### Fields inherited from class org.apache.lucene.analysis.Tokenizer

`input`

### Fields inherited from class org.apache.lucene.analysis.TokenStream

`DEFAULT_TOKEN_ATTRIBUTE_FACTORY`

## Constructor Summary

Constructors
Constructor
Description
`KeywordTokenizer()`
`KeywordTokenizer(int bufferSize)`
`KeywordTokenizer(AttributeFactory factory, int bufferSize)`

## Method Summary

Modifier and Type
Method
Description
`final void`
`end()`
`final boolean`
`incrementToken()`
`void`
`reset()`

### Methods inherited from class org.apache.lucene.analysis.Tokenizer

`close, correctOffset, setReader, setReaderTestPoint`

### 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`

## Field Details

### DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE
Default read buffer size

See Also:
  - Constant Field Values

## Constructor Details

### KeywordTokenizer

public KeywordTokenizer()

### KeywordTokenizer

public KeywordTokenizer(int bufferSize)

### KeywordTokenizer

public KeywordTokenizer(AttributeFactory factory, int bufferSize)

## Method Details

### incrementToken

public final boolean incrementToken() throws IOException

Specified by:
  `incrementToken` in class `TokenStream`
Throws:
  `IOException`

### end

public final void end() throws IOException

Overrides:
  `end` in class `TokenStream`
Throws:
  `IOException`

### reset

public void reset() throws IOException

Overrides:
  `reset` in class `Tokenizer`
Throws:
  `IOException`