com.ibm.icu.impl.coll

Class Collation

java.lang.Object

com.ibm.icu.impl.coll.Collation

public final class Collation
extends Object

Collation v2 basic definitions and static helper functions. Data structures except for expansion tables store 32-bit CEs which are either specials (see tags below) or are compact forms of 64-bit CEs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASE_AND_QUATERNARY_MASK Case bits and quaternary bits.
static int	CASE_LEVEL
static int	CASE_MASK
static int	COMMON_SEC_AND_TER_CE Lower 32 bits of a CE with common secondary and tertiary weights.
static int	COMMON_WEIGHT16
static int	EQUAL
static long	FFFD_PRIMARY
static int	GREATER
static int	IDENTICAL_LEVEL
static int	LESS
static int	LEVEL_SEPARATOR_BYTE
static long	MAX_PRIMARY
static int	MERGE_SEPARATOR_BYTE Merge-sort-key separator.
static long	MERGE_SEPARATOR_PRIMARY
static long	NO_CE
static int	NO_LEVEL Unspecified level.
static int	ONLY_TERTIARY_MASK Only the 2*6 bits for the pure tertiary weight.
static int	PRIMARY_COMPRESSION_HIGH_BYTE Primary compression high terminator.
static int	PRIMARY_COMPRESSION_LOW_BYTE Primary compression low terminator, must be greater than MERGE_SEPARATOR_BYTE.
static int	PRIMARY_LEVEL
static int	QUATERNARY_LEVEL
static int	QUATERNARY_MASK
static int	SECONDARY_LEVEL
static int	SENTINEL_CP UChar32 U_SENTINEL.
static int	TERMINATOR_BYTE
static int	TERTIARY_LEVEL
static int	ZERO_LEVEL Beyond sort key bytes.

Constructor Summary

Constructors

Constructor and Description
Collation()

Method Summary

Modifier and Type	Method and Description
static long	incThreeBytePrimaryByOffset(long basePrimary, boolean isCompressible, int offset) Increments a 3-byte primary by a code point offset.
static long	incTwoBytePrimaryByOffset(long basePrimary, boolean isCompressible, int offset) Increments a 2-byte primary by a code point offset.
static long	makeCE(long p) Creates a CE from a primary weight.

Methods inherited from class java.lang.Object

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

Field Detail

SENTINEL_CP

public static final int SENTINEL_CP

UChar32 U_SENTINEL. TODO: Create a common, public constant?

See Also:

Constant Field Values

LESS

public static final int LESS

See Also:

Constant Field Values

EQUAL

public static final int EQUAL

See Also:

Constant Field Values

GREATER

public static final int GREATER

See Also:

Constant Field Values

TERMINATOR_BYTE

public static final int TERMINATOR_BYTE

See Also:

Constant Field Values

LEVEL_SEPARATOR_BYTE

public static final int LEVEL_SEPARATOR_BYTE

See Also:

Constant Field Values

MERGE_SEPARATOR_BYTE

public static final int MERGE_SEPARATOR_BYTE

Merge-sort-key separator. Same as the unique primary and identical-level weights of U+FFFE. Must not be used as primary compression low terminator. Otherwise usable.

See Also:

Constant Field Values

MERGE_SEPARATOR_PRIMARY

public static final long MERGE_SEPARATOR_PRIMARY

See Also:

Constant Field Values

PRIMARY_COMPRESSION_LOW_BYTE

public static final int PRIMARY_COMPRESSION_LOW_BYTE

Primary compression low terminator, must be greater than MERGE_SEPARATOR_BYTE. Reserved value in primary second byte if the lead byte is compressible. Otherwise usable in all CE weight bytes.

See Also:

Constant Field Values

PRIMARY_COMPRESSION_HIGH_BYTE

public static final int PRIMARY_COMPRESSION_HIGH_BYTE

Primary compression high terminator. Reserved value in primary second byte if the lead byte is compressible. Otherwise usable in all CE weight bytes.

See Also:

Constant Field Values

COMMON_WEIGHT16

public static final int COMMON_WEIGHT16

See Also:

Constant Field Values

COMMON_SEC_AND_TER_CE

public static final int COMMON_SEC_AND_TER_CE

Lower 32 bits of a CE with common secondary and tertiary weights.

See Also:

Constant Field Values

CASE_MASK

public static final int CASE_MASK

See Also:

Constant Field Values

ONLY_TERTIARY_MASK

public static final int ONLY_TERTIARY_MASK

Only the 2*6 bits for the pure tertiary weight.

See Also:

Constant Field Values

QUATERNARY_MASK

public static final int QUATERNARY_MASK

See Also:

Constant Field Values

CASE_AND_QUATERNARY_MASK

public static final int CASE_AND_QUATERNARY_MASK

Case bits and quaternary bits.

See Also:

Constant Field Values

MAX_PRIMARY

public static final long MAX_PRIMARY

See Also:

Constant Field Values

FFFD_PRIMARY

public static final long FFFD_PRIMARY

See Also:

Constant Field Values

NO_CE

public static final long NO_CE

See Also:

Constant Field Values

NO_LEVEL

public static final int NO_LEVEL

Unspecified level.

See Also:

Constant Field Values

PRIMARY_LEVEL

public static final int PRIMARY_LEVEL

See Also:

Constant Field Values

SECONDARY_LEVEL

public static final int SECONDARY_LEVEL

See Also:

Constant Field Values

CASE_LEVEL

public static final int CASE_LEVEL

See Also:

Constant Field Values

TERTIARY_LEVEL

public static final int TERTIARY_LEVEL

See Also:

Constant Field Values

QUATERNARY_LEVEL

public static final int QUATERNARY_LEVEL

See Also:

Constant Field Values

IDENTICAL_LEVEL

public static final int IDENTICAL_LEVEL

See Also:

Constant Field Values

ZERO_LEVEL

public static final int ZERO_LEVEL

Beyond sort key bytes.

See Also:

Constant Field Values

Constructor Detail

Collation

public Collation()

Method Detail

makeCE

public static long makeCE(long p)

Creates a CE from a primary weight.

incTwoBytePrimaryByOffset

public static long incTwoBytePrimaryByOffset(long basePrimary,
                                             boolean isCompressible,
                                             int offset)

Increments a 2-byte primary by a code point offset.

incThreeBytePrimaryByOffset

public static long incThreeBytePrimaryByOffset(long basePrimary,
                                               boolean isCompressible,
                                               int offset)

Increments a 3-byte primary by a code point offset.