java.lang.Object

co.elastic.clients.elasticsearch._types.analysis.TokenFilterDefinition

All Implemented Interfaces:: JsonpSerializable, OpenTaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>, TaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>

@JsonpDeserializable
public class TokenFilterDefinition
extends java.lang.Object
implements OpenTaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>, JsonpSerializable

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class TokenFilterDefinition.Builder

static class TokenFilterDefinition.Kind
TokenFilterDefinition variant kinds.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<TokenFilterDefinition> _DESERIALIZER

Constructor Summary

Constructors
Constructor	Description
`TokenFilterDefinition(TokenFilterDefinitionVariant value)`
`TokenFilterDefinition(java.lang.String kind, JsonData value)`	Build a custom plugin-defined `TokenFilterDefinition`, given its kind and some JSON data

Method Summary

Modifier and Type	Method	Description
`JsonData`	`_custom()`	Get the custom plugin-defined variant value.
`java.lang.String`	`_customKind()`	Get the actual kind when `_kind()` equals `TokenFilterDefinition.Kind._Custom` (plugin-defined variant).
`java.lang.Object`	`_get()`
`boolean`	`_isCustom()`	Is this a custom `TokenFilterDefinition` defined by a plugin?
`TokenFilterDefinition.Kind`	`_kind()`	Get the of the kind of variant held by this object.
`AsciiFoldingTokenFilter`	`asciifolding()`	Get the `asciifolding` variant value.
`CommonGramsTokenFilter`	`commonGrams()`	Get the `common_grams` variant value.
`ConditionTokenFilter`	`condition()`	Get the `condition` variant value.
`DelimitedPayloadTokenFilter`	`delimitedPayload()`	Get the `delimited_payload` variant value.
`DictionaryDecompounderTokenFilter`	`dictionaryDecompounder()`	Get the `dictionary_decompounder` variant value.
`EdgeNGramTokenFilter`	`edgeNgram()`	Get the `edge_ngram` variant value.
`ElisionTokenFilter`	`elision()`	Get the `elision` variant value.
`FingerprintTokenFilter`	`fingerprint()`	Get the `fingerprint` variant value.
`HunspellTokenFilter`	`hunspell()`	Get the `hunspell` variant value.
`HyphenationDecompounderTokenFilter`	`hyphenationDecompounder()`	Get the `hyphenation_decompounder` variant value.
`IcuCollationTokenFilter`	`icuCollation()`	Get the `icu_collation` variant value.
`IcuFoldingTokenFilter`	`icuFolding()`	Get the `icu_folding` variant value.
`IcuNormalizationTokenFilter`	`icuNormalizer()`	Get the `icu_normalizer` variant value.
`IcuTokenizer`	`icuTokenizer()`	Get the `icu_tokenizer` variant value.
`IcuTransformTokenFilter`	`icuTransform()`	Get the `icu_transform` variant value.
`boolean`	`isAsciifolding()`	Is this variant instance of kind `asciifolding`?
`boolean`	`isCommonGrams()`	Is this variant instance of kind `common_grams`?
`boolean`	`isCondition()`	Is this variant instance of kind `condition`?
`boolean`	`isDelimitedPayload()`	Is this variant instance of kind `delimited_payload`?
`boolean`	`isDictionaryDecompounder()`	Is this variant instance of kind `dictionary_decompounder`?
`boolean`	`isEdgeNgram()`	Is this variant instance of kind `edge_ngram`?
`boolean`	`isElision()`	Is this variant instance of kind `elision`?
`boolean`	`isFingerprint()`	Is this variant instance of kind `fingerprint`?
`boolean`	`isHunspell()`	Is this variant instance of kind `hunspell`?
`boolean`	`isHyphenationDecompounder()`	Is this variant instance of kind `hyphenation_decompounder`?
`boolean`	`isIcuCollation()`	Is this variant instance of kind `icu_collation`?
`boolean`	`isIcuFolding()`	Is this variant instance of kind `icu_folding`?
`boolean`	`isIcuNormalizer()`	Is this variant instance of kind `icu_normalizer`?
`boolean`	`isIcuTokenizer()`	Is this variant instance of kind `icu_tokenizer`?
`boolean`	`isIcuTransform()`	Is this variant instance of kind `icu_transform`?
`boolean`	`isKeep()`	Is this variant instance of kind `keep`?
`boolean`	`isKeepTypes()`	Is this variant instance of kind `keep_types`?
`boolean`	`isKeywordMarker()`	Is this variant instance of kind `keyword_marker`?
`boolean`	`isKstem()`	Is this variant instance of kind `kstem`?
`boolean`	`isKuromojiPartOfSpeech()`	Is this variant instance of kind `kuromoji_part_of_speech`?
`boolean`	`isKuromojiReadingform()`	Is this variant instance of kind `kuromoji_readingform`?
`boolean`	`isKuromojiStemmer()`	Is this variant instance of kind `kuromoji_stemmer`?
`boolean`	`isLength()`	Is this variant instance of kind `length`?
`boolean`	`isLimit()`	Is this variant instance of kind `limit`?
`boolean`	`isLowercase()`	Is this variant instance of kind `lowercase`?
`boolean`	`isMultiplexer()`	Is this variant instance of kind `multiplexer`?
`boolean`	`isNgram()`	Is this variant instance of kind `ngram`?
`boolean`	`isNoriPartOfSpeech()`	Is this variant instance of kind `nori_part_of_speech`?
`boolean`	`isPatternCapture()`	Is this variant instance of kind `pattern_capture`?
`boolean`	`isPatternReplace()`	Is this variant instance of kind `pattern_replace`?
`boolean`	`isPhonetic()`	Is this variant instance of kind `phonetic`?
`boolean`	`isPorterStem()`	Is this variant instance of kind `porter_stem`?
`boolean`	`isPredicateTokenFilter()`	Is this variant instance of kind `predicate_token_filter`?
`boolean`	`isRemoveDuplicates()`	Is this variant instance of kind `remove_duplicates`?
`boolean`	`isReverse()`	Is this variant instance of kind `reverse`?
`boolean`	`isShingle()`	Is this variant instance of kind `shingle`?
`boolean`	`isSnowball()`	Is this variant instance of kind `snowball`?
`boolean`	`isStemmer()`	Is this variant instance of kind `stemmer`?
`boolean`	`isStemmerOverride()`	Is this variant instance of kind `stemmer_override`?
`boolean`	`isStop()`	Is this variant instance of kind `stop`?
`boolean`	`isSynonym()`	Is this variant instance of kind `synonym`?
`boolean`	`isSynonymGraph()`	Is this variant instance of kind `synonym_graph`?
`boolean`	`isTrim()`	Is this variant instance of kind `trim`?
`boolean`	`isTruncate()`	Is this variant instance of kind `truncate`?
`boolean`	`isUnique()`	Is this variant instance of kind `unique`?
`boolean`	`isUppercase()`	Is this variant instance of kind `uppercase`?
`boolean`	`isWordDelimiter()`	Is this variant instance of kind `word_delimiter`?
`boolean`	`isWordDelimiterGraph()`	Is this variant instance of kind `word_delimiter_graph`?
`KeepWordsTokenFilter`	`keep()`	Get the `keep` variant value.
`KeepTypesTokenFilter`	`keepTypes()`	Get the `keep_types` variant value.
`KeywordMarkerTokenFilter`	`keywordMarker()`	Get the `keyword_marker` variant value.
`KStemTokenFilter`	`kstem()`	Get the `kstem` variant value.
`KuromojiPartOfSpeechTokenFilter`	`kuromojiPartOfSpeech()`	Get the `kuromoji_part_of_speech` variant value.
`KuromojiReadingFormTokenFilter`	`kuromojiReadingform()`	Get the `kuromoji_readingform` variant value.
`KuromojiStemmerTokenFilter`	`kuromojiStemmer()`	Get the `kuromoji_stemmer` variant value.
`LengthTokenFilter`	`length()`	Get the `length` variant value.
`LimitTokenCountTokenFilter`	`limit()`	Get the `limit` variant value.
`LowercaseTokenFilter`	`lowercase()`	Get the `lowercase` variant value.
`MultiplexerTokenFilter`	`multiplexer()`	Get the `multiplexer` variant value.
`NGramTokenFilter`	`ngram()`	Get the `ngram` variant value.
`NoriPartOfSpeechTokenFilter`	`noriPartOfSpeech()`	Get the `nori_part_of_speech` variant value.
`static TokenFilterDefinition`	`of(java.util.function.Function<TokenFilterDefinition.Builder,ObjectBuilder<TokenFilterDefinition>> fn)`
`PatternCaptureTokenFilter`	`patternCapture()`	Get the `pattern_capture` variant value.
`PatternReplaceTokenFilter`	`patternReplace()`	Get the `pattern_replace` variant value.
`PhoneticTokenFilter`	`phonetic()`	Get the `phonetic` variant value.
`PorterStemTokenFilter`	`porterStem()`	Get the `porter_stem` variant value.
`PredicateTokenFilter`	`predicateTokenFilter()`	Get the `predicate_token_filter` variant value.
`RemoveDuplicatesTokenFilter`	`removeDuplicates()`	Get the `remove_duplicates` variant value.
`ReverseTokenFilter`	`reverse()`	Get the `reverse` variant value.
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupTokenFilterDefinitionDeserializer(ObjectDeserializer<TokenFilterDefinition.Builder> op)`
`ShingleTokenFilter`	`shingle()`	Get the `shingle` variant value.
`SnowballTokenFilter`	`snowball()`	Get the `snowball` variant value.
`StemmerTokenFilter`	`stemmer()`	Get the `stemmer` variant value.
`StemmerOverrideTokenFilter`	`stemmerOverride()`	Get the `stemmer_override` variant value.
`StopTokenFilter`	`stop()`	Get the `stop` variant value.
`SynonymTokenFilter`	`synonym()`	Get the `synonym` variant value.
`SynonymGraphTokenFilter`	`synonymGraph()`	Get the `synonym_graph` variant value.
`java.lang.String`	`toString()`
`TrimTokenFilter`	`trim()`	Get the `trim` variant value.
`TruncateTokenFilter`	`truncate()`	Get the `truncate` variant value.
`UniqueTokenFilter`	`unique()`	Get the `unique` variant value.
`UppercaseTokenFilter`	`uppercase()`	Get the `uppercase` variant value.
`WordDelimiterTokenFilter`	`wordDelimiter()`	Get the `word_delimiter` variant value.
`WordDelimiterGraphTokenFilter`	`wordDelimiterGraph()`	Get the `word_delimiter_graph` variant value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<TokenFilterDefinition> _DESERIALIZER
Constructor Details
- TokenFilterDefinition
  
  public TokenFilterDefinition(TokenFilterDefinitionVariant value)
- TokenFilterDefinition
  
  public TokenFilterDefinition(java.lang.String kind, JsonData value)
  
  Build a custom plugin-defined TokenFilterDefinition, given its kind and some JSON data
Method Details
- _kind
  
  public final TokenFilterDefinition.Kind _kind()
  
  Description copied from interface: TaggedUnion
  
  Get the of the kind of variant held by this object.
  
  Specified by:
  
  _kind in interface TaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>
  
  Returns:
  
  the variant kind
- _get
  
  public final java.lang.Object _get()
  
  Specified by:
  
  _get in interface TaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>
- of
  
  public static TokenFilterDefinition of(java.util.function.Function<TokenFilterDefinition.Builder,ObjectBuilder<TokenFilterDefinition>> fn)
- isAsciifolding
  
  public boolean isAsciifolding()
  
  Is this variant instance of kind asciifolding?
- asciifolding
  
  public AsciiFoldingTokenFilter asciifolding()
  
  Get the asciifolding variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the asciifolding kind.
- isCommonGrams
  
  public boolean isCommonGrams()
  
  Is this variant instance of kind common_grams?
- commonGrams
  
  public CommonGramsTokenFilter commonGrams()
  
  Get the common_grams variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the common_grams kind.
- isCondition
  
  public boolean isCondition()
  
  Is this variant instance of kind condition?
- condition
  
  public ConditionTokenFilter condition()
  
  Get the condition variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the condition kind.
- isDelimitedPayload
  
  public boolean isDelimitedPayload()
  
  Is this variant instance of kind delimited_payload?
- delimitedPayload
  
  public DelimitedPayloadTokenFilter delimitedPayload()
  
  Get the delimited_payload variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the delimited_payload kind.
- isDictionaryDecompounder
  
  public boolean isDictionaryDecompounder()
  
  Is this variant instance of kind dictionary_decompounder?
- dictionaryDecompounder
  
  public DictionaryDecompounderTokenFilter dictionaryDecompounder()
  
  Get the dictionary_decompounder variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the dictionary_decompounder kind.
- isEdgeNgram
  
  public boolean isEdgeNgram()
  
  Is this variant instance of kind edge_ngram?
- edgeNgram
  
  public EdgeNGramTokenFilter edgeNgram()
  
  Get the edge_ngram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the edge_ngram kind.
- isElision
  
  public boolean isElision()
  
  Is this variant instance of kind elision?
- elision
  
  public ElisionTokenFilter elision()
  
  Get the elision variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the elision kind.
- isFingerprint
  
  public boolean isFingerprint()
  
  Is this variant instance of kind fingerprint?
- fingerprint
  
  public FingerprintTokenFilter fingerprint()
  
  Get the fingerprint variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the fingerprint kind.
- isHunspell
  
  public boolean isHunspell()
  
  Is this variant instance of kind hunspell?
- hunspell
  
  public HunspellTokenFilter hunspell()
  
  Get the hunspell variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the hunspell kind.
- isHyphenationDecompounder
  
  public boolean isHyphenationDecompounder()
  
  Is this variant instance of kind hyphenation_decompounder?
- hyphenationDecompounder
  
  public HyphenationDecompounderTokenFilter hyphenationDecompounder()
  
  Get the hyphenation_decompounder variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the hyphenation_decompounder kind.
- isIcuCollation
  
  public boolean isIcuCollation()
  
  Is this variant instance of kind icu_collation?
- icuCollation
  
  public IcuCollationTokenFilter icuCollation()
  
  Get the icu_collation variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the icu_collation kind.
- isIcuFolding
  
  public boolean isIcuFolding()
  
  Is this variant instance of kind icu_folding?
- icuFolding
  
  public IcuFoldingTokenFilter icuFolding()
  
  Get the icu_folding variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the icu_folding kind.
- isIcuNormalizer
  
  public boolean isIcuNormalizer()
  
  Is this variant instance of kind icu_normalizer?
- icuNormalizer
  
  public IcuNormalizationTokenFilter icuNormalizer()
  
  Get the icu_normalizer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the icu_normalizer kind.
- isIcuTokenizer
  
  public boolean isIcuTokenizer()
  
  Is this variant instance of kind icu_tokenizer?
- icuTokenizer
  
  public IcuTokenizer icuTokenizer()
  
  Get the icu_tokenizer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the icu_tokenizer kind.
- isIcuTransform
  
  public boolean isIcuTransform()
  
  Is this variant instance of kind icu_transform?
- icuTransform
  
  public IcuTransformTokenFilter icuTransform()
  
  Get the icu_transform variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the icu_transform kind.
- isKstem
  
  public boolean isKstem()
  
  Is this variant instance of kind kstem?
- kstem
  
  public KStemTokenFilter kstem()
  
  Get the kstem variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the kstem kind.
- isKeepTypes
  
  public boolean isKeepTypes()
  
  Is this variant instance of kind keep_types?
- keepTypes
  
  public KeepTypesTokenFilter keepTypes()
  
  Get the keep_types variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the keep_types kind.
- isKeep
  
  public boolean isKeep()
  
  Is this variant instance of kind keep?
- keep
  
  public KeepWordsTokenFilter keep()
  
  Get the keep variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the keep kind.
- isKeywordMarker
  
  public boolean isKeywordMarker()
  
  Is this variant instance of kind keyword_marker?
- keywordMarker
  
  public KeywordMarkerTokenFilter keywordMarker()
  
  Get the keyword_marker variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the keyword_marker kind.
- isKuromojiPartOfSpeech
  
  public boolean isKuromojiPartOfSpeech()
  
  Is this variant instance of kind kuromoji_part_of_speech?
- kuromojiPartOfSpeech
  
  public KuromojiPartOfSpeechTokenFilter kuromojiPartOfSpeech()
  
  Get the kuromoji_part_of_speech variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the kuromoji_part_of_speech kind.
- isKuromojiReadingform
  
  public boolean isKuromojiReadingform()
  
  Is this variant instance of kind kuromoji_readingform?
- kuromojiReadingform
  
  public KuromojiReadingFormTokenFilter kuromojiReadingform()
  
  Get the kuromoji_readingform variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the kuromoji_readingform kind.
- isKuromojiStemmer
  
  public boolean isKuromojiStemmer()
  
  Is this variant instance of kind kuromoji_stemmer?
- kuromojiStemmer
  
  public KuromojiStemmerTokenFilter kuromojiStemmer()
  
  Get the kuromoji_stemmer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the kuromoji_stemmer kind.
- isLength
  
  public boolean isLength()
  
  Is this variant instance of kind length?
- length
  
  public LengthTokenFilter length()
  
  Get the length variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the length kind.
- isLimit
  
  public boolean isLimit()
  
  Is this variant instance of kind limit?
- limit
  
  public LimitTokenCountTokenFilter limit()
  
  Get the limit variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the limit kind.
- isLowercase
  
  public boolean isLowercase()
  
  Is this variant instance of kind lowercase?
- lowercase
  
  public LowercaseTokenFilter lowercase()
  
  Get the lowercase variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the lowercase kind.
- isMultiplexer
  
  public boolean isMultiplexer()
  
  Is this variant instance of kind multiplexer?
- multiplexer
  
  public MultiplexerTokenFilter multiplexer()
  
  Get the multiplexer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the multiplexer kind.
- isNgram
  
  public boolean isNgram()
  
  Is this variant instance of kind ngram?
- ngram
  
  public NGramTokenFilter ngram()
  
  Get the ngram variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the ngram kind.
- isNoriPartOfSpeech
  
  public boolean isNoriPartOfSpeech()
  
  Is this variant instance of kind nori_part_of_speech?
- noriPartOfSpeech
  
  public NoriPartOfSpeechTokenFilter noriPartOfSpeech()
  
  Get the nori_part_of_speech variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the nori_part_of_speech kind.
- isPatternCapture
  
  public boolean isPatternCapture()
  
  Is this variant instance of kind pattern_capture?
- patternCapture
  
  public PatternCaptureTokenFilter patternCapture()
  
  Get the pattern_capture variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the pattern_capture kind.
- isPatternReplace
  
  public boolean isPatternReplace()
  
  Is this variant instance of kind pattern_replace?
- patternReplace
  
  public PatternReplaceTokenFilter patternReplace()
  
  Get the pattern_replace variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the pattern_replace kind.
- isPhonetic
  
  public boolean isPhonetic()
  
  Is this variant instance of kind phonetic?
- phonetic
  
  public PhoneticTokenFilter phonetic()
  
  Get the phonetic variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the phonetic kind.
- isPorterStem
  
  public boolean isPorterStem()
  
  Is this variant instance of kind porter_stem?
- porterStem
  
  public PorterStemTokenFilter porterStem()
  
  Get the porter_stem variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the porter_stem kind.
- isPredicateTokenFilter
  
  public boolean isPredicateTokenFilter()
  
  Is this variant instance of kind predicate_token_filter?
- predicateTokenFilter
  
  public PredicateTokenFilter predicateTokenFilter()
  
  Get the predicate_token_filter variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the predicate_token_filter kind.
- isRemoveDuplicates
  
  public boolean isRemoveDuplicates()
  
  Is this variant instance of kind remove_duplicates?
- removeDuplicates
  
  public RemoveDuplicatesTokenFilter removeDuplicates()
  
  Get the remove_duplicates variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the remove_duplicates kind.
- isReverse
  
  public boolean isReverse()
  
  Is this variant instance of kind reverse?
- reverse
  
  public ReverseTokenFilter reverse()
  
  Get the reverse variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the reverse kind.
- isShingle
  
  public boolean isShingle()
  
  Is this variant instance of kind shingle?
- shingle
  
  public ShingleTokenFilter shingle()
  
  Get the shingle variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the shingle kind.
- isSnowball
  
  public boolean isSnowball()
  
  Is this variant instance of kind snowball?
- snowball
  
  public SnowballTokenFilter snowball()
  
  Get the snowball variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the snowball kind.
- isStemmerOverride
  
  public boolean isStemmerOverride()
  
  Is this variant instance of kind stemmer_override?
- stemmerOverride
  
  public StemmerOverrideTokenFilter stemmerOverride()
  
  Get the stemmer_override variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the stemmer_override kind.
- isStemmer
  
  public boolean isStemmer()
  
  Is this variant instance of kind stemmer?
- stemmer
  
  public StemmerTokenFilter stemmer()
  
  Get the stemmer variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the stemmer kind.
- isStop
  
  public boolean isStop()
  
  Is this variant instance of kind stop?
- stop
  
  public StopTokenFilter stop()
  
  Get the stop variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the stop kind.
- isSynonymGraph
  
  public boolean isSynonymGraph()
  
  Is this variant instance of kind synonym_graph?
- synonymGraph
  
  public SynonymGraphTokenFilter synonymGraph()
  
  Get the synonym_graph variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the synonym_graph kind.
- isSynonym
  
  public boolean isSynonym()
  
  Is this variant instance of kind synonym?
- synonym
  
  public SynonymTokenFilter synonym()
  
  Get the synonym variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the synonym kind.
- isTrim
  
  public boolean isTrim()
  
  Is this variant instance of kind trim?
- trim
  
  public TrimTokenFilter trim()
  
  Get the trim variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the trim kind.
- isTruncate
  
  public boolean isTruncate()
  
  Is this variant instance of kind truncate?
- truncate
  
  public TruncateTokenFilter truncate()
  
  Get the truncate variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the truncate kind.
- isUnique
  
  public boolean isUnique()
  
  Is this variant instance of kind unique?
- unique
  
  public UniqueTokenFilter unique()
  
  Get the unique variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the unique kind.
- isUppercase
  
  public boolean isUppercase()
  
  Is this variant instance of kind uppercase?
- uppercase
  
  public UppercaseTokenFilter uppercase()
  
  Get the uppercase variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the uppercase kind.
- isWordDelimiterGraph
  
  public boolean isWordDelimiterGraph()
  
  Is this variant instance of kind word_delimiter_graph?
- wordDelimiterGraph
  
  public WordDelimiterGraphTokenFilter wordDelimiterGraph()
  
  Get the word_delimiter_graph variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the word_delimiter_graph kind.
- isWordDelimiter
  
  public boolean isWordDelimiter()
  
  Is this variant instance of kind word_delimiter?
- wordDelimiter
  
  public WordDelimiterTokenFilter wordDelimiter()
  
  Get the word_delimiter variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not of the word_delimiter kind.
- _isCustom
  
  public boolean _isCustom()
  
  Is this a custom TokenFilterDefinition defined by a plugin?
- _customKind
  
  @Nullable public final java.lang.String _customKind()
  
  Get the actual kind when _kind() equals TokenFilterDefinition.Kind._Custom (plugin-defined variant).
  
  Specified by:
  
  _customKind in interface OpenTaggedUnion<TokenFilterDefinition.Kind,java.lang.Object>
- _custom
  
  public JsonData _custom()
  
  Get the custom plugin-defined variant value.
  
  Throws:
  
  java.lang.IllegalStateException - if the current variant is not TokenFilterDefinition.Kind._Custom.
- serialize
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Specified by:
  
  serialize in interface JsonpSerializable
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- setupTokenFilterDefinitionDeserializer
  
  protected static void setupTokenFilterDefinitionDeserializer(ObjectDeserializer<TokenFilterDefinition.Builder> op)

Modifier and Type	Class	Description
`static class`	`TokenFilterDefinition.Builder`
`static class`	`TokenFilterDefinition.Kind`	`TokenFilterDefinition` variant kinds.

Class TokenFilterDefinition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

_DESERIALIZER

Constructor Details

TokenFilterDefinition

TokenFilterDefinition

Method Details

_kind

_get

of

isAsciifolding

asciifolding

isCommonGrams

commonGrams

isCondition

condition

isDelimitedPayload

delimitedPayload

isDictionaryDecompounder

dictionaryDecompounder

isEdgeNgram

edgeNgram

isElision

elision

isFingerprint

fingerprint

isHunspell

hunspell

isHyphenationDecompounder

hyphenationDecompounder

isIcuCollation

icuCollation

isIcuFolding

icuFolding

isIcuNormalizer

icuNormalizer

isIcuTokenizer

icuTokenizer

isIcuTransform

icuTransform

isKstem

kstem

isKeepTypes

keepTypes

isKeep

keep

isKeywordMarker

keywordMarker

isKuromojiPartOfSpeech

kuromojiPartOfSpeech

isKuromojiReadingform

kuromojiReadingform

isKuromojiStemmer

kuromojiStemmer

isLength

length

isLimit

limit

isLowercase

lowercase

isMultiplexer

multiplexer

isNgram

ngram

isNoriPartOfSpeech

noriPartOfSpeech

isPatternCapture

patternCapture

isPatternReplace

patternReplace

isPhonetic

phonetic

isPorterStem

porterStem

isPredicateTokenFilter