| java.lang.Object
 com.ibm.icu.util.ByteArrayWrapper
com.ibm.icu.text.RawCollationKey
| RawCollationKey | | final public class RawCollationKey extends ByteArrayWrapper (Code) | |
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.
See Also: RuleBasedCollator
See Also: CollationKey |
| Constructor Summary | |
| public | RawCollationKey()
Default constructor, internal byte array is null and its size set to 0. | | public | RawCollationKey(int capacity)
RawCollationKey created with an empty internal byte array of length
capacity. | | public | RawCollationKey(byte[] bytes)
RawCollationKey created, adopting bytes as the internal byte array. | | public | RawCollationKey(byte[] bytesToAdopt, int size)
Construct a RawCollationKey from a byte array and size. |
| Method Summary | |
| public int | compareTo(Object rhs)
Compare this RawCollationKey to another, which must not be null. |
| RawCollationKey | | public RawCollationKey()(Code) | | Default constructor, internal byte array is null and its size set to 0.
|
| RawCollationKey | | public RawCollationKey(int capacity)(Code) | | RawCollationKey created with an empty internal byte array of length
capacity. Size of the internal byte array will be set to 0.
Parameters:
capacity - length of internal byte array |
| RawCollationKey | | public RawCollationKey(byte[] bytes)(Code) | | RawCollationKey created, adopting bytes as the internal byte array.
Size of the internal byte array will be set to 0.
Parameters:
bytes - byte array to be adopted by RawCollationKey |
| RawCollationKey | | public RawCollationKey(byte[] bytesToAdopt, int size)(Code) | | Construct a RawCollationKey from a byte array and size.
Parameters:
bytesToAdopt - the byte array to adopt
Parameters:
size - the length of valid data in the byte array
throws:
IndexOutOfBoundsException - if bytesToAdopt == null and size != 0, orsize < 0, or size > bytesToAdopt.length. |
| compareTo | | public int compareTo(Object rhs)(Code) | | 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.
Parameters:
rhs - the RawCollationKey to compare to. -1, 0, or 1 as this compares less than, equal to, orgreater than rhs.
throws:
ClassCastException - if the other object is not a RawCollationKey. |
|
|