net.pwall.util

Interface CharUnmapper

public interface CharUnmapper

Character unmapper interface for "unescape" functions.

Author:

Peter Wall

See Also:

Strings.unescape(CharSequence, CharUnmapper), Strings.unescape(String, CharUnmapper)

Method Summary

Modifier and Type	Method and Description
boolean	isEscape(CharSequence s, int offset) Test whether the character at offset in the CharSequence s is the start of an escape sequence.
int	unmap(StringBuilder sb, CharSequence s, int offset) Map the characters starting at offset in the CharSequence s with any of the possible escape sequences.

Method Detail

isEscape

boolean isEscape(CharSequence s,
                 int offset)

Test whether the character at offset in the CharSequence s is the start of an escape sequence.

Parameters:

s - the CharSequence containing the input

offset - the offset within the input

Returns:

true if the character is the start of an escape

See Also:

Strings.unescape(String, CharUnmapper), Strings.unescape(CharSequence, CharUnmapper)

unmap

int unmap(StringBuilder sb,
          CharSequence s,
          int offset)

Map the characters starting at offset in the CharSequence s with any of the possible escape sequences. If successful, store the character (or possibly the two-character surrogate sequence) in StringBuilder sb and return the length of the sequence; otherwise return 0 to indicate no match.

Parameters:

sb - the StringBuilder in which to store the output

s - the CharSequence containing the input

offset - the offset within the input

Returns:

the length of the mapped sequence

Throws:

IllegalArgumentException - if the escape sequence is invalid

See Also:

Strings.unescape(String, CharUnmapper), Strings.unescape(CharSequence, CharUnmapper)