java.text
Class CollationKey
- Comparable<T>
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.
int | compareTo(CollationKey ck)- This method compares the specified object to this one.
|
boolean | equals(Object obj)- This method tests the specified
Object for equality with
this object.
|
String | getSourceString()- This method returns the
String that this object was created
from.
|
int | hashCode()- This method returns a hash value for this object.
|
byte[] | toByteArray()- This method returns the collation bit sequence as a byte array.
|
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
compareTo
public int compareTo(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.
ck - The CollationKey to compare against this one.
- A negative integer if this object is less than the specified object, 0 if it is equal or a positive integer if it is greater than the specified object.
equals
public boolean equals(Object obj)
This method tests the specified
Object for equality with
this object. This will be true if and only if:
- The specified object must not be
null - The specified object is an instance of
CollationKey. - The specified object was created from the same
Collator
as this object. - The specified object has the same source string and bit key as
this object.
- equals in interface Object
obj - The Object to test for equality.
true if the specified object is equal to this one, false otherwise.
getSourceString
public String getSourceString()
This method returns the String that this object was created
from.
- The source
String for this object.
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.
- hashCode in interface Object
- A hash value for this object.
toByteArray
public byte[] toByteArray()
This method returns the collation bit sequence as a byte array.
- A byte array containing the collation bit sequence.
CollationKey.java -- Precomputed collation value
Copyright (C) 1998, 1999, 2000, 2003, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.