Simple class wrapper to store the internal byte representation of a CollationKey. Unlike the CollationKey, this class do not contain information on the source string the sort order represents. RawCollationKey is mutable and users can reuse its objects with the method in RuleBasedCollator.getRawCollationKey(..).
Please refer to the documentation on CollationKey for a detail description on the internal byte representation. Note the internal byte representation is always null-terminated.
Example of use:
String str[] = {.....};
RuleBasedCollator collator = (RuleBasedCollator)Collator.getInstance();
RawCollationKey key = new RawCollationKey(128);
for (int i = 0; i < str.length; i ++) {
collator.getRawCollationKey(str[i], key);
// do something with key.bytes
}
Note
Comparison between RawCollationKeys created by different Collators might return incorrect results. See class documentation for Collator.
RuleBasedCollator, CollationKey
| Access | Constructor and Description |
|---|---|
| public | |
| public | RawCollationKey(int
length of internal byte array capacity)RawCollationKey created with an empty internal byte array of length capacity. |
| public | RawCollationKey(byte[]
byte array to be adopted by RawCollationKey bytes)RawCollationKey created, adopting bytes as the internal byte array. |
| public | RawCollationKey(byte[]
the byte array to adopt bytesToAdopt, int the length of valid data in the byte array size)Construct a RawCollationKey from a byte array and size. |
| Modifier and Type | Method and Description |
|---|---|
| public int | Returns: -1, 0, or 1 as this compares less than, equal to, or greater than rhs.the RawCollationKey to compare to. rhs)Implements java. |
| RawCollationKey | back to summary |
|---|---|
| public RawCollationKey() Default constructor, internal byte array is null and its size set to 0.
| |
| RawCollationKey | back to summary |
|---|---|
| public RawCollationKey(int capacity) RawCollationKey created with an empty internal byte array of length capacity. Size of the internal byte array will be set to 0.
| |
| RawCollationKey | back to summary |
|---|---|
| public RawCollationKey(byte[] bytes) RawCollationKey created, adopting bytes as the internal byte array. Size of the internal byte array will be set to 0.
| |
| RawCollationKey | back to summary |
|---|---|
| public RawCollationKey(byte[] bytesToAdopt, int size) Construct a RawCollationKey from a byte array and size.
| |
| compareTo | back to summary |
|---|---|
| public int compareTo(RawCollationKey rhs) Implements java. Compare this RawCollationKey to another, which must not be null. This overrides the inherited implementation to ensure the returned values are -1, 0, or 1.
| |