ICUNormalizer2CharFilterFactory

java.lang.Object
- org.apache.lucene.analysis.AbstractAnalysisFactory
- - org.apache.lucene.analysis.CharFilterFactory
  - - org.apache.lucene.analysis.icu.ICUNormalizer2CharFilterFactory

```
public class ICUNormalizer2CharFilterFactory
extends CharFilterFactory
```
Factory for ICUNormalizer2CharFilter
Supports the following attributes:
- form: A Unicode Normalization Form, one of 'nfc','nfkc', 'nfkc_cf'. Default is nfkc_cf.
- mode: Either 'compose' or 'decompose'. Default is compose. Use "decompose" with nfc or nfkc, to get nfd or nfkd, respectively.
- filter: A UnicodeSet pattern. Codepoints outside the set are always left unchanged. Default is [] (the null set, no filtering).
Since:

4.10.0

See Also:

ICUNormalizer2CharFilter, Normalizer2, FilteredNormalizer2

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String NAME
SPI name

private com.ibm.icu.text.Normalizer2 normalizer
- Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
  LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors
Constructor	Description
`ICUNormalizer2CharFilterFactory()`	Default ctor for compatibility with SPI
`ICUNormalizer2CharFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)`	Creates a new ICUNormalizer2CharFilterFactory

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.io.Reader`	`create(java.io.Reader input)`	Wraps the given Reader with a CharFilter.
`java.io.Reader`	`normalize(java.io.Reader input)`	Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate to `create` method.

Methods inherited from class org.apache.lucene.analysis.CharFilterFactory
availableCharFilters, findSPIName, forName, lookupClass, reloadCharFilters

Methods inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
defaultCtorException, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    SPI name
    
    See Also:
    
    Constant Field Values
  - normalizer
```
private final com.ibm.icu.text.Normalizer2 normalizer
```
- Constructor Detail
  - ICUNormalizer2CharFilterFactory
```
public ICUNormalizer2CharFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)
```
    Creates a new ICUNormalizer2CharFilterFactory
  - ICUNormalizer2CharFilterFactory
```
public ICUNormalizer2CharFilterFactory()
```
    Default ctor for compatibility with SPI
- Method Detail
  - create
```
public java.io.Reader create(java.io.Reader input)
```
    Description copied from class: CharFilterFactory
    
    Wraps the given Reader with a CharFilter.
    
    Specified by:
    
    create in class CharFilterFactory
  - normalize
```
public java.io.Reader normalize(java.io.Reader input)
```
    Description copied from class: CharFilterFactory
    
    Normalize the specified input Reader While the default implementation returns input unchanged, char filters that should be applied at normalization time can delegate to create method.
    
    Overrides:
    
    normalize in class CharFilterFactory