public final Class Collation

The secondary/tertiary lower limit for tailoring before any root elements.

Builder data, used only in the CollationDataBuilder, not in runtime data. If bit 8 is 0: Builder context, points to a list of context-sensitive mappings. Bits 31..13: Index to the builder's list of ConditionalCE32 for this character. Bits 12.. 9: Unused, 0. If bit 8 is 1 (IS_BUILDER_JAMO_CE32): Builder-only jamoCE32 value. The builder fetches the Jamo CE32 from the trie. Bits 31..13: Jamo code point. Bits 12.. 9: Unused, 0.

Case bits and tertiary bits.

Default secondary/tertiary weight lead byte.

Middle 16 bits of a CE with a common secondary weight.

Lower 16 bits of a CE with a common tertiary weight.

Set if the first character of every contraction suffix has lccc!=0.

Set if there is no match for the single (no-suffix) character itself. This is only possible if there is a prefix. In this case, discontiguous contraction matching cannot add combining marks starting from an empty suffix. The default CE32 is used anyway if there is no suffix match.

Set if any contraction suffix ends with lccc!=0.

Points to contraction data. Bits 31..13: Index into prefix/contraction data. Bits 12..11: Unused, 0. Bit 10: CONTRACT_TRAILING_CCC flag. Bit 9: CONTRACT_NEXT_CCC flag. Bit 8: CONTRACT_SINGLE_CP_NO_MATCH flag.

Decimal digit. Bits 31..13: Index into int table for non-numeric-collation CE32. Bit 12: Unused, 0. Bits 11.. 8: Digit value 0..9.

Points to one or more simple/long-primary/long-secondary 32-bit CE32s. Bits 31..13: Index into int table. Bits 12.. 8: Length=1..31.

Points to one or more 64-bit CEs. Bits 31..13: Index into CE table. Bits 12.. 8: Length=1..31.

Fall back to the base collator. This is the tag value in SPECIAL_CE32_LOW_BYTE and FALLBACK_CE32. Bits 31..8: Unused, 0.

First unassigned: AlphabeticIndex overflow boundary. We want a 3-byte primary so that it fits into the root elements table. This 3-byte primary will not collide with any unassigned-implicit 4-byte primaries because the first few hundred Unicode code points all have real mappings.

For HANGUL_TAG: None of its Jamo CE32s isSpecialCE32().

Tag for a Hangul syllable. Bits 31..9: Unused, 0. Bit 8: HANGUL_NO_SPECIAL_JAMO flag.

Implicit CE tag. Compute an unassigned-implicit CE. All bits are set (UNASSIGNED_CE32=0xffffffff).

Latin mini expansions of two simple CEs [pp, 05, tt] [00, ss, 05]. Bits 31..24: Single-byte primary weight pp of the first CE. Bits 23..16: Tertiary weight tt of the first CE. Bits 15.. 8: Secondary weight ss of the second CE.

Tag for a lead surrogate code unit. Optional optimization for UTF-16 string processing. Bits 31..10: Unused, 0. 9.. 8: =0: All associated supplementary code points are unassigned-implicit. =1: All associated supplementary code points fall back to the base data. else: (Normally 2) Look up the data for the supplementary code point.

Low byte of a long-primary special CE32.

Long-primary CE with COMMON_SEC_AND_TER_CE. Bits 31..8: Three-byte primary.

Long-secondary CE with zero primary. Bits 31..16: Secondary weight. Bits 15.. 8: Tertiary weight.

We limit the number of CEs in an expansion so that we can use a small number of length bits in the data structure, and so that an implementation can copy CEs at runtime without growing a destination buffer.

No CE: End of input. Only used in runtime code, not stored in data.

Sort key level flags: xx_FLAG = 1 << xx_LEVEL. In Java, use enum Level with flag() getters, or use EnumSet rather than hand-made bit sets.

Tag for CEs with primary weights in code point order. Bits 31..13: Index into CE table, for one data "CE". Bits 12.. 8: Unused, 0. This data "CE" has the following bit fields: Bits 63..32: Three-byte primary pppppp00. 31.. 8: Start/base code point of the in-order range. 7: Flag isCompressible primary. 6.. 0: Per-code point primary-weight increment.

Only the secondary & tertiary bits; no case, no quaternary.

Points to prefix trie. Bits 31..13: Index into prefix/contraction data. Bits 12.. 8: Unused, 0.

Unused. May be used in the future for single-byte secondary CEs (SHORT_SECONDARY_TAG), storing the secondary in bits 31..24, the ccc in bits 23..16, and the tertiary in bits 15..8.

A CE32 is special if its low byte is this or greater. Impossible case bits 11 mark special CE32s. This value itself is used to indicate a fallback to the base collator.

Tag for U+0000, for moving the NUL-termination handling from the regular fastpath into specials-handling code. Bits 31..8: Unused, 0.

Returns a 64-bit CE from a simple/long-primary/long-secondary CE32.

Returns a 64-bit CE from a simple CE32 (not special).

Decrements a 3-byte primary by one range step (1..0x7f).

Decrements a 2-byte primary by one range step (1..0x7f).

Returns the digit value from a DIGIT_TAG ce32.

Computes a 3-byte primary for c's OFFSET_TAG data "CE".

Returns the data index from a special CE32.

Returns:boolean

true if the ce32 yields one or more CEs without further data lookups

Get the first of the two Latin-expansion CEs encoded in ce32.

See Also

LATIN_EXPANSION_TAG

Get the second of the two Latin-expansion CEs encoded in ce32.

See Also

LATIN_EXPANSION_TAG

Returns the data length from a ce32.

Creates a CE from a primary weight, 16-bit secondary/tertiary weights, and a 2-bit quaternary.

Makes a special CE32 with only tag and index.

Makes a special CE32 with tag, index and length.

Turns the long-primary CE32 into a primary weight pppppp00.

Returns the unassigned-character implicit primary weight for any valid code point c.