Class Overview
CollationKey represents the collation order of a particular String for a
specific Collator. CollationKeys can be compared to determine the relative
ordering of their source Strings. This is useful when the Strings must be
compared multiple times, as in sorting.
Summary
| Public Methods |
|---|
|
int
|
compareTo(CollationKey value)
Compare the receiver to the specified CollationKey to determine the
relative ordering.
|
|
boolean
|
equals(Object object)
Compares the specified object to this CollationKey and answer if they are
equal.
|
|
String
|
getSourceString()
Answer the String from which this CollationKey was created.
|
|
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
byte[]
|
toByteArray()
Answer the collation key as a byte array.
|
|
[Expand]
Inherited Methods |
|---|
From class java.lang.Object
|
Object
|
clone()
Returns a new instance of the same class as the receiver, whose slots
have been filled in with the values in the slots of the receiver.
|
|
boolean
|
equals(Object o)
Compares the argument to the receiver, and returns true if they represent
the same object using a class specific comparison.
|
|
void
|
finalize()
Called by the virtual machine when there are no longer any (non-weak)
references to the receiver.
|
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of java.lang.Class which represents the class
of the receiver.
|
|
int
|
hashCode()
Returns an integer hash code for the receiver.
|
|
final
void
|
notify()
Causes one thread which is wait ing on the receiver to be
made ready to run.
|
|
final
void
|
notifyAll()
Causes all threads which are wait ing on the receiver to
be made ready to run.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of the
receiver.
|
|
final
void
|
wait(long time, int frac)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait(long time)
Causes the thread which sent this message to be made not ready to run
either pending some change in the receiver (as indicated by
notify or notifyAll) or the expiration of
the timeout.
|
|
final
void
|
wait()
Causes the thread which sent this message to be made not ready to run
pending some change in the receiver (as indicated by notify
or notifyAll).
|
|
From interface java.lang.Comparable
|
abstract
int
|
compareTo(T another)
Returns an integer indicating the relative positions of the receiver and
the argument in the natural order of elements of the receiver's class.
|
|
Public Methods
public
int
compareTo
(CollationKey value)
Compare the receiver to the specified CollationKey to determine the
relative ordering.
Returns
- an int < 0 if this CollationKey is less than the specified
CollationKey, 0 if they are equal, and > 0 if this CollationKey
is greater
public
boolean
equals
(Object object)
Compares the specified object to this CollationKey and answer if they are
equal. The object must be an instance of CollationKey and have the same
source string and collation key. The instances of CollationKey must have
been created by the same Collator.
Parameters
| object
| the object to compare with this object |
Returns
- true if the specified object is equal to this CollationKey, false
otherwise
public
String
getSourceString
()
Answer the String from which this CollationKey was created.
public
int
hashCode
()
Returns an integer hash code for the receiver. Objects which are equal
answer the same value for this method.
public
byte[]
toByteArray
()
Answer the collation key as a byte array.
