Class UnicodeEncoding

java.lang.Object

org.jcodings.Encoding

org.jcodings.AbstractEncoding

org.jcodings.MultiByteEncoding

org.jcodings.unicode.UnicodeEncoding

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BaseUTF8Encoding, CESU8Encoding, FixedWidthUnicodeEncoding, UTF16BEEncoding, UTF16LEEncoding

public abstract class UnicodeEncoding
extends MultiByteEncoding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	UnicodeEncoding.CaseFold
private static class	UnicodeEncoding.CaseMappingSpecials
private static class	UnicodeEncoding.CaseUnfold11
private static class	UnicodeEncoding.CaseUnfold12
private static class	UnicodeEncoding.CaseUnfold13
private static class	UnicodeEncoding.CodeList
(package private) static class	UnicodeEncoding.CTypeName

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final int	CASE_MAPPING_SLACK
(package private) static final int	DOT_ABOVE
(package private) static final int	DOTLESS_i
(package private) static final int	I_WITH_DOT_ABOVE
private static final int	PROPERTY_NAME_MAX_SIZE
(package private) static final short[]	UNICODE_ISO_8859_1_CTypeTable

Fields inherited from class MultiByteEncoding

A, EncLen, F, Trans, TransZero

Fields inherited from class Encoding

CHAR_INVALID, isUnicode, isUTF8, maxLength, minLength, NEW_LINE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnicodeEncoding(String name, int minLength, int maxLength, int[] EncLen)
protected	UnicodeEncoding(String name, int minLength, int maxLength, int[] EncLen, int[][] Trans)

Method Summary

Modifier and Type	Method	Description
void	applyAllCaseFold(int flag, ApplyAllCaseFoldFunction fun, Object arg)	onigenc_ascii_apply_all_case_fold / used also by multibyte encodings
CaseFoldCodeItem[]	caseFoldCodesByString(int flag, byte[] bytes, int p, int end)	onigenc_ascii_get_case_fold_codes_by_str / used also by multibyte encodings
final int	caseMap(IntHolder flagP, byte[] bytes, IntHolder pp, int end, byte[] to, int toP, int toEnd)	Oniguruma equivalent: case_map
protected final int[]	ctypeCodeRange(int ctype)
private static int	extractCode(int packed)
private static int	extractLength(int packed)
String	getCharsetName()	The name of the equivalent Java Charset for this encoding.
boolean	isCodeCType(int code, int ctype)	Perform a check whether given code is of given character type (e.g.
static boolean	isInCodeRange(UnicodeCodeRange range, int code)
int	mbcCaseFold(int flag, byte[] bytes, IntHolder pp, int end, byte[] fold)	onigenc_ascii_mbc_case_fold
int	propertyNameToCType(byte[] name, int p, int end)	onigenc_minimum_property_name_to_ctype notably overridden by unicode encodings
private static Object[]	readFoldN(int fromSize, String table)

Methods inherited from class MultiByteEncoding

isInRange, length, lengthForTwoUptoFour, mb2CodeToMbc, mb2CodeToMbcLength, mb2IsCodeCType, mb4CodeToMbc, mb4CodeToMbcLength, mb4IsCodeCType, mbnMbcCaseFold, mbnMbcToCode, missing, missing, safeLengthForUptoFour, safeLengthForUptoThree, safeLengthForUptoTwo, strCodeAt, strLength

Methods inherited from class AbstractEncoding

asciiApplyAllCaseFold, asciiCaseFoldCodesByString, asciiMbcCaseFold, isCodeCTypeInternal, isNewLine

Methods inherited from class Encoding

asciiToLower, asciiToUpper, codeToMbc, codeToMbcLength, ctypeCodeRange, digitVal, equals, getCharset, getIndex, getName, hashCode, isAlnum, isAlpha, isAscii, isAscii, isAsciiCompatible, isBlank, isCntrl, isDigit, isDummy, isFixedWidth, isGraph, isLower, isMbcAscii, isMbcCrnl, isMbcHead, isMbcWord, isNewLine, isPrint, isPunct, isReverseMatchAllowed, isSbWord, isSingleByte, isSpace, isUnicode, isUpper, isUTF8, isWord, isWordGraphPrint, isXDigit, leftAdjustCharHead, length, load, load, maxLength, maxLengthDistance, mbcodeStartPosition, mbcToCode, minLength, odigitVal, prevCharHead, rightAdjustCharHead, rightAdjustCharHeadWithPrev, setDummy, setName, setName, step, stepBack, strByteLengthNull, strLengthNull, strNCmp, toLowerCaseTable, toString, xdigitVal

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PROPERTY_NAME_MAX_SIZE

private static final int PROPERTY_NAME_MAX_SIZE

See Also:

• Constant Field Values

I_WITH_DOT_ABOVE

static final int I_WITH_DOT_ABOVE

See Also:

• Constant Field Values

DOTLESS_i

static final int DOTLESS_i

See Also:

• Constant Field Values

DOT_ABOVE

static final int DOT_ABOVE

See Also:

• Constant Field Values

CASE_MAPPING_SLACK

static final int CASE_MAPPING_SLACK

See Also:

• Constant Field Values

UNICODE_ISO_8859_1_CTypeTable

static final short[] UNICODE_ISO_8859_1_CTypeTable

Constructor Details

UnicodeEncoding

protected UnicodeEncoding(String name,
 int minLength,
 int maxLength,
 int[] EncLen,
 int[][] Trans)

UnicodeEncoding

protected UnicodeEncoding(String name,
 int minLength,
 int maxLength,
 int[] EncLen)

Method Details

getCharsetName

public String getCharsetName()

Description copied from class: Encoding

The name of the equivalent Java Charset for this encoding. Defaults to the name of the encoding. Subclasses can override this to provide a different name.

Overrides:

getCharsetName in class Encoding

Returns:

the name of the equivalent Java Charset for this encoding

isCodeCType

public boolean isCodeCType(int code,
 int ctype)

Description copied from class: Encoding

Perform a check whether given code is of given character type (e.g. used by isWord(someByte) and similar methods)

Specified by:

isCodeCType in class Encoding

Parameters:

code - a code point of a character

ctype - a character type to check against Oniguruma equivalent: is_code_ctype

isInCodeRange

public static boolean isInCodeRange(UnicodeCodeRange range,
 int code)

ctypeCodeRange

protected final int[] ctypeCodeRange(int ctype)

propertyNameToCType

public int propertyNameToCType(byte[] name,
 int p,
 int end)

Description copied from class: AbstractEncoding

onigenc_minimum_property_name_to_ctype notably overridden by unicode encodings

Overrides:

propertyNameToCType in class AbstractEncoding

mbcCaseFold

public int mbcCaseFold(int flag,
 byte[] bytes,
 IntHolder pp,
 int end,
 byte[] fold)

Description copied from class: AbstractEncoding

onigenc_ascii_mbc_case_fold

Overrides:

mbcCaseFold in class AbstractEncoding

Parameters:

flag - case fold flag

pp - an IntHolder that points at character head

fold - a buffer where to extract case folded character Oniguruma equivalent: mbc_case_fold

applyAllCaseFold

public void applyAllCaseFold(int flag,
 ApplyAllCaseFoldFunction fun,
 Object arg)

Description copied from class: AbstractEncoding

onigenc_ascii_apply_all_case_fold / used also by multibyte encodings

Overrides:

applyAllCaseFold in class AbstractEncoding

Parameters:

flag - case fold flag

fun - case folding functor (look at: ApplyCaseFold)

arg - case folding functor argument (look at: ApplyCaseFoldArg) Oniguruma equivalent: apply_all_case_fold

caseFoldCodesByString

public CaseFoldCodeItem[] caseFoldCodesByString(int flag,
 byte[] bytes,
 int p,
 int end)

Description copied from class: AbstractEncoding

onigenc_ascii_get_case_fold_codes_by_str / used also by multibyte encodings

Overrides:

caseFoldCodesByString in class AbstractEncoding

caseMap

public final int caseMap(IntHolder flagP,
 byte[] bytes,
 IntHolder pp,
 int end,
 byte[] to,
 int toP,
 int toEnd)

Description copied from class: Encoding

Oniguruma equivalent: case_map

Overrides:

caseMap in class MultiByteEncoding

readFoldN

private static Object[] readFoldN(int fromSize,
 String table)

extractLength

private static int extractLength(int packed)

extractCode

private static int extractCode(int packed)