net.pwall.util

Interface CharMapper

All Known Implementing Classes:

MultiCharMapper

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CharMapper

Character mapper interface for "escape" functions.

Author:

Peter Wall

See Also:

Strings.escape(CharSequence, CharMapper), Strings.escape(String, CharMapper), Strings.escapeUTF16(CharSequence, CharMapper), Strings.escapeUTF16(String, CharMapper)

Method Summary

Modifier and Type	Method and Description
static String	arrayMapping(String[] array, int codePoint, int base) Map a range of contiguous code points into strings using an array.
static String	decimalMapping(int codePoint, String prefix, String suffix) Map a code point into a decimal string with prefix and optional suffix.
static String	hexMapping(int codePoint, int length, String prefix) Map a code point into a fixed-length hexadecimal string with prefix and no suffix.
static String	hexMapping(int codePoint, int length, String prefix, String suffix) Map a code point into a fixed-length hexadecimal string with prefix and optional suffix.
static String	lookupMapping(CharMapperEntry[] table, int codePoint) Map a code point using a lookup table.
static String	lookupMapping(String[][] table, int codePoint) Map a code point using a lookup table.
String	map(int codePoint) Map character to it's "escaped" string equivalent, for example '+' to "%2B" in URL encoding.

Method Detail

map

String map(int codePoint)

Map character to it's "escaped" string equivalent, for example '+' to "%2B" in URL encoding. Return null if the character does not need to be converted.

Parameters:

codePoint - the Unicode code point of the character to be mapped

Returns:

the escaped string equivalent, or null if no escape needed

arrayMapping

static String arrayMapping(String[] array,
                           int codePoint,
                           int base)

Map a range of contiguous code points into strings using an array. The first entry in the array represents the code point specified by the base, the second is base + 1 etc.

Parameters:

array - the array of strings

codePoint - the Unicode code point

base - the code point representing the first entry in the array

Returns:

the string representing the code point, or null if the code point is outside the range

lookupMapping

static String lookupMapping(String[][] table,
                            int codePoint)

Map a code point using a lookup table. The lookup uses a binary search so the table entries must be in ascending order by code point.

Parameters:

table - an array of mapping entries, each of which is an array of two strings: a single character string containing the character to be mapped, and the result string

codePoint - the Unicode code point

Returns:

the string representing the code point, or null if no entry exists in the table for the code point

lookupMapping

static String lookupMapping(CharMapperEntry[] table,
                            int codePoint)

Map a code point using a lookup table. The lookup uses a binary search so the table entries must be in ascending order by code point.

Parameters:

table - an array of mapping entries, each of which is an array of two strings: a single character string containing the character to be mapped, and the result string

codePoint - the Unicode code point

Returns:

the string representing the code point, or null if no entry exists in the table for the code point

decimalMapping

static String decimalMapping(int codePoint,
                             String prefix,
                             String suffix)

Map a code point into a decimal string with prefix and optional suffix.

Parameters:

codePoint - the Unicode code point

prefix - the prefix string

suffix - the suffix string (or null if no suffix needed)

Returns:

the decimal representation of the code point, with the specified prefix and optional suffix

hexMapping

static String hexMapping(int codePoint,
                         int length,
                         String prefix,
                         String suffix)

Map a code point into a fixed-length hexadecimal string with prefix and optional suffix.

Parameters:

codePoint - the Unicode code point

length - the number of hexadecimal digits

prefix - the prefix string

suffix - the suffix string (or null if no suffix needed)

Returns:

the hexadecimal representation of the code point, zero-padded to the required number of digits, with the specified prefix and optional suffix

hexMapping

static String hexMapping(int codePoint,
                         int length,
                         String prefix)

Map a code point into a fixed-length hexadecimal string with prefix and no suffix. This is an optimization of the common case of no suffix being required.

Parameters:

codePoint - the Unicode code point

length - the number of hexadecimal digits

prefix - the prefix string

Returns:

the hexadecimal representation of the code point, zero-padded to the required number of digits, with the specified prefix