# Package org.apache.lucene.analysis.tokenattributes

General-purpose attributes for text analysis.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  BytesTermAttribute | This attribute can be used if you have the raw term bytes to be indexed.
  CharTermAttribute | The term text of a Token.
  FlagsAttribute | This attribute can be used to pass different flags down the `Tokenizer` chain, e.g.
  KeywordAttribute | This attribute can be used to mark a token as a keyword.
  OffsetAttribute | The start and end character offset of a Token.
  PayloadAttribute | The payload of a Token.
  PositionIncrementAttribute | Determines the position of this token relative to the previous Token in a TokenStream, used in phrase searching.
  PositionLengthAttribute | Determines how many positions this token spans.
  TermFrequencyAttribute | Sets the custom term frequency of a term within one document.
  TermToBytesRefAttribute | This attribute is requested by TermsHashPerField to index the contents.
  TypeAttribute | A Token's lexical type.

- Class Summary
  Class | Description
  --- | ---
  BytesTermAttributeImpl | Implementation class for `BytesTermAttribute`.
  CharTermAttributeImpl | Default implementation of `CharTermAttribute`.
  FlagsAttributeImpl | Default implementation of `FlagsAttribute`.
  KeywordAttributeImpl | Default implementation of `KeywordAttribute`.
  OffsetAttributeImpl | Default implementation of `OffsetAttribute`.
  PackedTokenAttributeImpl | Default implementation of the common attributes used by Lucene: `CharTermAttribute` `TypeAttribute` `PositionIncrementAttribute` `PositionLengthAttribute` `OffsetAttribute` `TermFrequencyAttribute`
  PayloadAttributeImpl | Default implementation of `PayloadAttribute`.
  PositionIncrementAttributeImpl | Default implementation of `PositionIncrementAttribute`.
  PositionLengthAttributeImpl | Default implementation of `PositionLengthAttribute`.
  TermFrequencyAttributeImpl | Default implementation of `TermFrequencyAttribute`.
  TypeAttributeImpl | Default implementation of `TypeAttribute`.

## Package org.apache.lucene.analysis.tokenattributes Description

General-purpose attributes for text analysis.

Copyright © 2000-2024 Apache Software Foundation. All Rights Reserved.