Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.text

Class CollationKey

java.lang.Object
|
+--java.text.CollationKey

All Implemented Interfaces:

Comparable


public final class CollationKey

extends Object

implements Comparable

This class represents a pre-computed series of bits representing a String for under a particular Collator. This value may be compared bitwise against another CollationKey representing a different String under the same Collator in a manner than is usually more efficient than using the raw Collator compare methods. There is overhead associated with calculating this value, so it is generally not advisable to compute CollationKey's unless multiple comparisons against a String will be done. (For example, in a sort routine).

This class cannot be instantiated directly. Instead, a CollationKey is created by calling the getCollationKey method on an instance of Collator.

Author:

Method Summary

intcompareTo(java.lang.Object obj)

This method compares the specified object to this one.
intcompareTo(java.text.CollationKey ck)

This method compares the specified object to this one.
booleanequals(java.lang.Object obj)

This method tests the specified Object for equality with this object.
java.lang.StringgetSourceString()

This method returns the String that this object was created from.
inthashCode()

This method returns a hash value for this object.
byte[]toByteArray()

This method returns the collation bit sequence as a byte array.

Method Details

compareTo

public int compareTo(java.lang.Object obj)

This method compares the specified object to this one. The specified object must be an instance of CollationKey or an exception will be thrown. An integer is returned which indicates whether the specified object is less than, greater than, or equal to this object.

Parameters:

Returns:


compareTo

public int compareTo(java.text.CollationKey ck)

This method compares the specified object to this one. An integer is returned which indicates whether the specified object is less than, greater than, or equal to this object.

Parameters:

Returns:


equals

public boolean equals(java.lang.Object obj)

This method tests the specified Object for equality with this object. This will be true if and only if:

Parameters:

Returns:


getSourceString

public String getSourceString()

This method returns the String that this object was created from.

Returns:


hashCode

public int hashCode()

This method returns a hash value for this object. The hash value returned will be the hash code of the bit key so that identical bit keys will return the same value.

Returns:


toByteArray

public byte[] toByteArray()

This method returns the collation bit sequence as a byte array.