From e55f2c65386ca95f2ad9ececae863627d8f77ac9 Mon Sep 17 00:00:00 2001 From: mkoch Date: Wed, 30 Apr 2003 13:09:40 +0000 Subject: 2003-04-30 Michael Koch * java/text/CollationElementIterator.java, java/text/CollationKey.java, java/text/RuleBasedCollator.java: Merged copyright and documentation from classpath and rearranged some code. No code changes done. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@66288 138bc75d-0d04-0410-961f-82ee72b054a4 --- libjava/java/text/CollationKey.java | 183 ++++++++++++++++++++++++++++-------- 1 file changed, 142 insertions(+), 41 deletions(-) (limited to 'libjava/java/text/CollationKey.java') diff --git a/libjava/java/text/CollationKey.java b/libjava/java/text/CollationKey.java index 966c64d1c3f..ff57446d804 100644 --- a/libjava/java/text/CollationKey.java +++ b/libjava/java/text/CollationKey.java @@ -1,44 +1,150 @@ -// CollationKey.java - Sort key for locale-sensitive String. +/* CollationKey.java -- Precomputed collation value /* Copyright (C) 1999, 2000 Free Software Foundation +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., 59 Temple Place, Suite 330, Boston, MA +02111-1307 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. */ - This file is part of libgcj. - -This software is copyrighted work licensed under the terms of the -Libgcj License. Please consult the file "LIBGCJ_LICENSE" for -details. */ package java.text; -/** - * @author Tom Tromey - * @date March 25, 1999 - */ /* Written using "Java Class Libraries", 2nd edition, plus online * API docs for JDK 1.2 from http://www.javasoft.com. * Status: Believed complete and correct. */ +/** + * 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 Aaron M. Renn + * @author Tom Tromey + */ public final class CollationKey implements Comparable { - public int compareTo (CollationKey target) + /** + * This is the String this object represents. + */ + private String originalText; + + /** + * This is the bit value for this key. + */ + private int[] key; + + CollationKey (CollationElementIterator iter, String originalText, + int strength) + { + this.originalText = originalText; + + // Compute size of required array. + int size = 0; + while (RuleBasedCollator.next(iter, strength) + != CollationElementIterator.NULLORDER) + ++size; + + iter.reset(); + key = new int[size]; + for (int i = 0; i < size; i++) + key[i] = RuleBasedCollator.next(iter, strength); + } + + /** + * 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. + * + * @param ck The CollationKey to compare against this one. + * + * @return 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. + */ + public int compareTo (CollationKey ck) { - int max = Math.min(key.length, target.key.length); + int max = Math.min (key.length, ck.key.length); for (int i = 0; i < max; ++i) { - if (key[i] != target.key[i]) - return key[i] - target.key[i]; + if (key[i] != ck.key[i]) + return key[i] - ck.key[i]; } - return key.length - target.key.length; + return key.length - ck.key.length; } - public int compareTo (Object o) + /** + * 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. + * + * @param obj The Object to compare against this one. + * + * @return 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. + */ + public int compareTo (Object obj) { - return compareTo ((CollationKey) o); + return compareTo ((CollationKey) 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. + *
+ * + * @param obj The Object to test for equality. + * + * @return true if the specified object is equal to this one, false otherwise. + */ public boolean equals (Object obj) { if (! (obj instanceof CollationKey)) @@ -56,11 +162,24 @@ public final class CollationKey implements Comparable return true; } + /** + * This method returns the String that this object was created + * from. + * + * @return The source String for this object. + */ public String getSourceString () { return originalText; } + /** + * 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. + * + * @return A hash value for this object. + */ public int hashCode () { // We just follow BitSet instead of thinking up something new. @@ -69,7 +188,12 @@ public final class CollationKey implements Comparable h ^= key[i] * (i + 1); return (int) ((h >> 32) ^ h); } - + + /** + * This method returns the collation bit sequence as a byte array. + * + * @param A byte array containing the collation bit sequence. + */ public byte[] toByteArray () { byte[] r = new byte[4 * key.length]; @@ -83,27 +207,4 @@ public final class CollationKey implements Comparable } return r; } - - CollationKey (CollationElementIterator iter, String originalText, - int strength) - { - this.originalText = originalText; - - // Compute size of required array. - int size = 0; - while (RuleBasedCollator.next(iter, strength) - != CollationElementIterator.NULLORDER) - ++size; - - iter.reset(); - key = new int[size]; - for (int i = 0; i < size; i++) - key[i] = RuleBasedCollator.next(iter, strength); - } - - // Original string. - private String originalText; - - // Collation key. - private int[] key; } -- cgit v1.2.1