Module io.github.mmm.text.ascii

Package io.github.mmm.text.ascii

Interface AsciiConverter

public interface AsciiConverter

AsciiConverter converts Unicode to simple 7-bit ASCII characters. It strips diacritic marks and transliterates non-Latin letters and glyphs to ASCII. It is optimized for performance and does not implement perfectly correct transliteration (e.g. it has no state to transliterate a code-point dependening on its predecessors).
However, it is very helpful to decode strings for use-cases like indexing and searching or if you want to build a String to be used for restricted environments (names of files, folders, etc.) where special characters could cause problems.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
String	convert(int codePoint)
default String	convert(CharSequence text)
String	convert(CharSequence text, AsciiConverterConfig config)
static AsciiConverter	get()

Method Details

convert

String convert(int codePoint)

Parameters:

codePoint - the codePoint to convert.

text - the (unicode) String to convert.

Returns:

the converted ASCII representation of the given codePoint.

convert

default String convert(CharSequence text)

Parameters:

text - the (unicode) CharSequence to convert.

Returns:

the converted ASCII representation of the given text.

convert

String convert(CharSequence text,
 AsciiConverterConfig config)

Parameters:

text - the (unicode) CharSequence to convert.

config - the AsciiConverterConfig.

Returns:

the converted ASCII representation of the given text.

get

static AsciiConverter get()

Returns:

the singleton instance of AsciiConverter.