Package com.maybeitssquid.safeascii

Class Categorize

java.lang.Object

com.maybeitssquid.safeascii.Chainable

com.maybeitssquid.safeascii.Categorize

All Implemented Interfaces:

IntFunction<CharSequence>

Direct Known Subclasses:

Name

public class Categorize
extends Chainable

Converts Unicode characters to their ASCII equivalents based on character categories.

• Nd Character.DECIMAL_DIGIT_NUMBER are converted to their ASCII digit equivalents 0-9
• Zs Character.SPACE_SEPARATOR are converted to ASCII space
• Zl, Zp, U+0085 Character.LINE_SEPARATOR, Character.PARAGRAPH_SEPARATOR and UNICODE_NEL are converted to line separator. Carriage return U+000D and line feed U+000A are passed as-is.
• Pd Character.DASH_PUNCTUATION are converted to ASCII hyphen-minus -
• Ps Character.START_PUNCTUATION are converted to ASCII open parenthesis (
• Pe Character.END_PUNCTUATION are converted to ASCII close parenthesis )
• Pc Character.CONNECTOR_PUNCTUATION are converted to ASCII underscore _
• Pi, Pf Character.INITIAL_QUOTE_PUNCTUATION and Character.FINAL_QUOTE_PUNCTUATION are converted to ASCII double quote "
• U+FFFD UNICODE_REPLACEMENT is converted to ASCII question mark ?

Field Summary

Fields

Modifier and Type	Field	Description
protected static final IntFunction<CharSequence>	identity	Identity function that converts a codepoint to its string representation without transformation.
static final int	UNICODE_NEL	The UNICODE line separator character
static final char	UNICODE_REPLACEMENT	The UNICODE replacement character

Fields inherited from class com.maybeitssquid.safeascii.Chainable

ASCII, delegate

Constructor Summary

Constructors

Constructor	Description
Categorize()	Creates a new Categorizer instance with an identity delegate and default line separator.
Categorize(IntFunction<CharSequence> delegate)	Creates a new Categorizer instance with the specified delegate and default line separator.
Categorize(IntFunction<CharSequence> delegate, CharSequence lineSeparator)	Creates a new Categorize instance with the specified delegate and line separator.

Method Summary

Modifier and Type	Method	Description
CharSequence	apply(int value)	Applies the categorization logic to the input value.
protected CharSequence	endPunctuation(int codepoint)	Converts end punctuation codepoints to their ASCII equivalent.
CharSequence	getLineSeparator()	Retrieves the configured line separator.
protected CharSequence	process(int codepoint)	Transforms a codepoint based on its Unicode category.
protected CharSequence	quotePunctuation(int codepoint)	Converts quote punctuation codepoints to their ASCII equivalent.
protected CharSequence	startPunctuation(int codepoint)	Converts start punctuation codepoints to their ASCII equivalent.

Methods inherited from class com.maybeitssquid.safeascii.Chainable

delegate

Methods inherited from class java.lang.Object

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

Field Details

UNICODE_REPLACEMENT

public static final char UNICODE_REPLACEMENT

The UNICODE replacement character

See Also:

• Constant Field Values

UNICODE_NEL

public static final int UNICODE_NEL

The UNICODE line separator character

See Also:

• Constant Field Values

identity

protected static final IntFunction<CharSequence> identity

Identity function that converts a codepoint to its string representation without transformation.

Constructor Details

Categorize

public Categorize(IntFunction<CharSequence> delegate,
 CharSequence lineSeparator)

Creates a new Categorize instance with the specified delegate and line separator.

Parameters:

delegate - the next step in the processing chain

lineSeparator - the string to use for line separators

Categorize

public Categorize(IntFunction<CharSequence> delegate)

Creates a new Categorizer instance with the specified delegate and default line separator.

Parameters:

delegate - the next step in the processing chain

Categorize

public Categorize()

Creates a new Categorizer instance with an identity delegate and default line separator.

Method Details

getLineSeparator

public CharSequence getLineSeparator()

Retrieves the configured line separator.

Returns:

the character sequence used for line separation (e.g. for UNICODE_NEL).

startPunctuation

protected CharSequence startPunctuation(int codepoint)

Converts start punctuation codepoints to their ASCII equivalent.

Parameters:

codepoint - the start punctuation codepoint

Returns:

ASCII open parenthesis (

endPunctuation

protected CharSequence endPunctuation(int codepoint)

Converts end punctuation codepoints to their ASCII equivalent.

Parameters:

codepoint - the end punctuation codepoint

Returns:

ASCII close parenthesis )

quotePunctuation

protected CharSequence quotePunctuation(int codepoint)

Converts quote punctuation codepoints to their ASCII equivalent.

Parameters:

codepoint - the quote punctuation codepoint

Returns:

ASCII double quote "

process

protected CharSequence process(int codepoint)

Transforms a codepoint based on its Unicode category.

This method maps specific Unicode categories (like punctuation and separators) to their ASCII equivalents. Characters falling into unhandled categories are returned as-is via identity.

Specified by:

process in class Chainable

Parameters:

codepoint - the Unicode codepoint to process

Returns:

the transformed string or the original character

See Also:

• Character.getType(int)

apply

public CharSequence apply(int value)

Applies the categorization logic to the input value.

This method includes an optimization for ASCII characters (values < Chainable.ASCII). If the input is already ASCII, it skips the categorization process and immediately delegates to the next step in the chain.

Specified by:

apply in interface IntFunction<CharSequence>

Overrides:

apply in class Chainable

Parameters:

value - the input codepoint

Returns:

the processed character sequence