CharFilterFactory (The Adobe Experience Manager SDK 2022.5.7575.20220530T152407Z-220500)

java.lang.Object
- org.apache.lucene.analysis.util.AbstractAnalysisFactory
- - org.apache.lucene.analysis.util.CharFilterFactory

Direct Known Subclasses:

HTMLStripCharFilterFactory, MappingCharFilterFactory, PatternReplaceCharFilterFactory, PersianCharFilterFactory
```
public abstract class CharFilterFactory
extends AbstractAnalysisFactory
```
Abstract parent class for analysis factories that create CharFilter instances.

Field Summary
- Fields inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
  LUCENE_MATCH_VERSION_PARAM

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static Set<String>`	`availableCharFilters()`	returns a list of all available charfilter names
`abstract Reader`	`create(Reader input)`	Wraps the given Reader with a CharFilter.
`static CharFilterFactory`	`forName(String name, Map<String,String> args)`	looks up a charfilter by name from context classpath
`static Class<? extends CharFilterFactory>`	`lookupClass(String name)`	looks up a charfilter class by name from context classpath
`static void`	`reloadCharFilters(ClassLoader classloader)`	Reloads the factory list from the given `ClassLoader`.

Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory
get, get, get, get, get, getChar, getClassArg, getLuceneMatchVersion, getOriginalArgs, getSet, isExplicitLuceneMatchVersion, require, require, require, requireChar, setExplicitLuceneMatchVersion

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

- Method Detail
  - forName
```
public static CharFilterFactory forName(String name,
                                        Map<String,String> args)
```
    looks up a charfilter by name from context classpath
  - lookupClass
```
public static Class<? extends CharFilterFactory> lookupClass(String name)
```
    looks up a charfilter class by name from context classpath
  - availableCharFilters
```
public static Set<String> availableCharFilters()
```
    returns a list of all available charfilter names
  - reloadCharFilters
```
public static void reloadCharFilters(ClassLoader classloader)
```
    Reloads the factory list from the given ClassLoader. Changes to the factories are visible after the method ends, all iterators (availableCharFilters(),...) stay consistent.
    NOTE: Only new factories are added, existing ones are never removed or replaced.
    This method is expensive and should only be called for discovery of new factories on the given classpath/classloader!
  - create
```
public abstract Reader create(Reader input)
```
    Wraps the given Reader with a CharFilter.