Class TransliteratingASCIIProvider

java.lang.Object

java.nio.charset.spi.CharsetProvider

com.maybeitssquid.safeascii.TransliteratingASCIIProvider

public class TransliteratingASCIIProvider
extends CharsetProvider

A CharsetProvider that supplies ASCII-safe character sets for encoding Unicode text. This provider offers five distinct character set implementations:

X-ASCII-Printable (alias: ASCII-Printable)

Strict printable ASCII: allows 0x20 through 0x7E inclusive. Control characters, including tabs and newlines, are reported as unmappable.

X-ASCII-Plain (alias: ASCII-Plain)

Printable ASCII with newline support: linefeed (0x0A) passes through; carriage return (0x0D) is unmappable so CRLF normalises to LF under the IGNORE error action. All other control characters are unmappable.

X-ASCII-Formatted (alias: ASCII-Formatted)

Printable ASCII with tab and newline support: tab (0x09) and linefeed (0x0A) pass through; carriage return (0x0D) is unmappable so CRLF normalises to LF under the IGNORE error action. All other control characters are unmappable.

X-Transliterating

Aggressive Unicode-to-ASCII transliteration using NFKD decomposition and character-name lookup. Output length may vary (one Unicode character may produce multiple ASCII bytes).

X-Transliterating-Single-Byte (alias: ACH)

Same transliteration as X-Transliterating but guarantees 1:1 character output. Any transliteration that would produce more or fewer than one character is rejected as unmappable.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACH_ALIAS	ACH alias for the single-byte transliterating character set.
static final String	ASCII_FORMATTED_ALIAS	Alias for ASCII_FORMATTED_CHARSET.
static final String	ASCII_FORMATTED_CHARSET	Canonical name for the printable ASCII character set with tab and newline support.
static final String	ASCII_PLAIN_ALIAS	Alias for ASCII_PLAIN_CHARSET.
static final String	ASCII_PLAIN_CHARSET	Canonical name for the printable ASCII character set with newline support.
static final String	ASCII_PRINTABLE_ALIAS	Alias for ASCII_PRINTABLE_CHARSET.
static final String	ASCII_PRINTABLE_CHARSET	Canonical name for the strict printable ASCII character set.
static final String	TRANSLITERATING_CHARSET	Canonical name for the transliterating character set.
static final String	TRANSLITERATING_SINGLE_BYTE_CHARSET	Canonical name for the single-byte transliterating character set.

Constructor Summary

Constructors

Constructor	Description
TransliteratingASCIIProvider()	Creates a new TransliteratingASCIIProvider instance.

Method Summary

Modifier and Type	Method	Description
Charset	charsetForName(String charsetName)	Retrieves a specific character set by name.
Iterator<Charset>	charsets()	Returns an iterator over all available character sets provided by this class.

Methods inherited from class Object

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

Field Details

ASCII_PRINTABLE_CHARSET

public static final String ASCII_PRINTABLE_CHARSET

Canonical name for the strict printable ASCII character set.

See Also:

• Constant Field Values

ASCII_PRINTABLE_ALIAS

public static final String ASCII_PRINTABLE_ALIAS

Alias for ASCII_PRINTABLE_CHARSET.

See Also:

• Constant Field Values

ASCII_PLAIN_CHARSET

public static final String ASCII_PLAIN_CHARSET

Canonical name for the printable ASCII character set with newline support.

See Also:

• Constant Field Values

ASCII_PLAIN_ALIAS

public static final String ASCII_PLAIN_ALIAS

Alias for ASCII_PLAIN_CHARSET.

See Also:

• Constant Field Values

ASCII_FORMATTED_CHARSET

public static final String ASCII_FORMATTED_CHARSET

Canonical name for the printable ASCII character set with tab and newline support.

See Also:

• Constant Field Values

ASCII_FORMATTED_ALIAS

public static final String ASCII_FORMATTED_ALIAS

Alias for ASCII_FORMATTED_CHARSET.

See Also:

• Constant Field Values

TRANSLITERATING_CHARSET

public static final String TRANSLITERATING_CHARSET

Canonical name for the transliterating character set.

See Also:

• Constant Field Values

TRANSLITERATING_SINGLE_BYTE_CHARSET

public static final String TRANSLITERATING_SINGLE_BYTE_CHARSET

Canonical name for the single-byte transliterating character set.

See Also:

• Constant Field Values

ACH_ALIAS

public static final String ACH_ALIAS

ACH alias for the single-byte transliterating character set.

See Also:

• Constant Field Values

Constructor Details

TransliteratingASCIIProvider

public TransliteratingASCIIProvider()

Creates a new TransliteratingASCIIProvider instance.

This provider will lazily initialize the available character sets upon the first request.

Method Details

charsets

public Iterator<Charset> charsets()

Returns an iterator over all available character sets provided by this class. The available charsets are: ASCII-Printable, ASCII-Plain, ASCII-Formatted, X-Transliterating, and X-Transliterating-Single-Byte.

Specified by:

charsets in class CharsetProvider

Returns:

Iterator containing all supported character sets @ThreadSafe This method is thread-safe and uses lazy initialization

charsetForName

public Charset charsetForName(String charsetName)

Retrieves a specific character set by name. Supported charset names are:

• X-ASCII-Printable (alias: ASCII-Printable)
• X-ASCII-Plain (alias: ASCII-Plain)
• X-ASCII-Formatted (alias: ASCII-Formatted)
• X-Transliterating
• X-Transliterating-Single-Byte (alias: ACH)

Specified by:

charsetForName in class CharsetProvider

Parameters:

charsetName - the name of the requested charset

Returns:

the corresponding Charset object, or null if the requested charset is not supported @ThreadSafe This method is thread-safe