Class RawCollationKey

  • All Implemented Interfaces:
    Comparable<ByteArrayWrapper>

    public final class RawCollationKey
    extends ByteArrayWrapper

    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, CollationKey
    • Constructor Detail

      • RawCollationKey

        public RawCollationKey()
        Default constructor, internal byte array is null and its size set to 0.
      • RawCollationKey

        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.
        Parameters:
        capacity - length of internal byte array
      • RawCollationKey

        public RawCollationKey​(byte[] bytes)
        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)
        Construct a RawCollationKey from a byte array and size.
        Parameters:
        bytesToAdopt - the byte array to adopt
        size - the length of valid data in the byte array
        Throws:
        IndexOutOfBoundsException - if bytesToAdopt == null and size != 0, or size < 0, or size > bytesToAdopt.length.
    • Method Detail

      • compareTo

        public int compareTo​(RawCollationKey rhs)
        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.
        Returns:
        -1, 0, or 1 as this compares less than, equal to, or greater than rhs.
        Throws:
        ClassCastException - if the other object is not a RawCollationKey.