```
public interface AnalysisPlugin
```
An additional extension point for Plugins that extends Elasticsearch's analysis functionality. To add an additional TokenFilter just implement the interface and implement the getTokenFilters() method:
```
 public class AnalysisPhoneticPlugin extends Plugin implements AnalysisPlugin {
     &#64;Override
     public Map<String, AnalysisProvider<TokenFilterFactory>> getTokenFilters() {
         return singletonMap("phonetic", PhoneticTokenFilterFactory::new);
     }
 }
 
```
Elasticsearch doesn't have any automatic mechanism to share these components between indexes. If any component is heavy enough to warrant such sharing then it is the Plugin's responsibility to do it in their AnalysisModule.AnalysisProvider implementation. We recommend against doing this unless absolutely necessary because it can be difficult to get the caching right given things like behavior changes across versions.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<AnalyzerProvider<? extends org.apache.lucene.analysis.Analyzer>>>`	`getAnalyzers()`	Override to add additional `Analyzer`s.
`default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<CharFilterFactory>>`	`getCharFilters()`	Override to add additional `CharFilter`s.
`default java.util.Map<java.lang.String,org.apache.lucene.analysis.hunspell.Dictionary>`	`getHunspellDictionaries()`	Override to add additional hunspell `Dictionary`s.
`default java.util.List<PreBuiltAnalyzerProviderFactory>`	`getPreBuiltAnalyzerProviderFactories()`	Override to add additional pre-configured `Analyzer`s.
`default java.util.List<PreConfiguredCharFilter>`	`getPreConfiguredCharFilters()`	Override to add additional pre-configured `CharFilter`s.
`default java.util.List<PreConfiguredTokenFilter>`	`getPreConfiguredTokenFilters()`	Override to add additional pre-configured `TokenFilter`s.
`default java.util.List<PreConfiguredTokenizer>`	`getPreConfiguredTokenizers()`	Override to add additional pre-configured `Tokenizer`.
`default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<TokenFilterFactory>>`	`getTokenFilters()`	Override to add additional `TokenFilter`s.
`default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<TokenizerFactory>>`	`getTokenizers()`	Override to add additional `Tokenizer`s.
`static <T> AnalysisModule.AnalysisProvider<T>`	`requiresAnalysisSettings(AnalysisModule.AnalysisProvider<T> provider)`	Mark an `AnalysisModule.AnalysisProvider` as requiring the index's settings.

- Method Detail
  - getCharFilters
```
default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<CharFilterFactory>> getCharFilters()
```
    Override to add additional CharFilters. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.
  - getTokenFilters
```
default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<TokenFilterFactory>> getTokenFilters()
```
    Override to add additional TokenFilters. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.
  - getTokenizers
```
default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<TokenizerFactory>> getTokenizers()
```
    Override to add additional Tokenizers. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.
  - getAnalyzers
```
default java.util.Map<java.lang.String,AnalysisModule.AnalysisProvider<AnalyzerProvider<? extends org.apache.lucene.analysis.Analyzer>>> getAnalyzers()
```
    Override to add additional Analyzers. See requiresAnalysisSettings(AnalysisProvider) how to on get the configuration from the index.
  - getPreBuiltAnalyzerProviderFactories
```
default java.util.List<PreBuiltAnalyzerProviderFactory> getPreBuiltAnalyzerProviderFactories()
```
    Override to add additional pre-configured Analyzers.
  - getPreConfiguredCharFilters
```
default java.util.List<PreConfiguredCharFilter> getPreConfiguredCharFilters()
```
    Override to add additional pre-configured CharFilters.
  - getPreConfiguredTokenFilters
```
default java.util.List<PreConfiguredTokenFilter> getPreConfiguredTokenFilters()
```
    Override to add additional pre-configured TokenFilters.
  - getPreConfiguredTokenizers
```
default java.util.List<PreConfiguredTokenizer> getPreConfiguredTokenizers()
```
    Override to add additional pre-configured Tokenizer.
  - getHunspellDictionaries
```
default java.util.Map<java.lang.String,org.apache.lucene.analysis.hunspell.Dictionary> getHunspellDictionaries()
```
    Override to add additional hunspell Dictionarys.
  - requiresAnalysisSettings
```
static <T> AnalysisModule.AnalysisProvider<T> requiresAnalysisSettings(AnalysisModule.AnalysisProvider<T> provider)
```
    Mark an AnalysisModule.AnalysisProvider as requiring the index's settings.

Interface AnalysisPlugin

Method Summary

Method Detail

getCharFilters

getTokenFilters

getTokenizers

getAnalyzers

getPreBuiltAnalyzerProviderFactories

getPreConfiguredCharFilters

getPreConfiguredTokenFilters

getPreConfiguredTokenizers

getHunspellDictionaries

requiresAnalysisSettings