CollationElementIterator.java, [...]: Merged copyright and documentation from classpath and rearranged some code.

2003-04-30  Michael Koch  <konqueror@gmx.de>

	* 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.

From-SVN: r66288

1 files changed, 104 insertions, 23 deletions

diff --git a/libjava/java/text/CollationElementIterator.java b/libjava/java/text/CollationElementIterator.java
index f8d4474..ba60f20 100644
--- a/libjava/java/text/CollationElementIterator.java
+++ b/libjava/java/text/CollationElementIterator.java
@@ -1,28 +1,93 @@
-// CollationElementIterator.java - Iterate over decomposed characters.
+/* CollationElementIterator.java -- Walks through collation elements
 
 /* Copyright (C) 1999, 2001  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 <tromey@cygnus.com>
- * @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 to JDK 1.1.
  */
 
+/**
+ * This class walks through the character collation elements of a 
+ * <code>String</code> as defined by the collation rules in an instance of 
+ * <code>RuleBasedCollator</code>.  There is no public constructor for
+ * this class.  An instance is created by calling the
+ * <code>getCollationElementIterator</code> method on 
+ * <code>RuleBasedCollator</code>.
+ *
+ * @author Aaron M. Renn <arenn@urbanophile.com>
+ * @author Tom Tromey <tromey@cygnus.com>
+ */
 public final class CollationElementIterator
 {
+  /**
+   * This is a constant value that is returned to indicate that the end of 
+   * the string was encountered.
+   */
   public static final int NULLORDER = 0xffffffff;
 
+  /**
+   * This is the RuleBasedCollator this object was created from.
+   */
+  RuleBasedCollator collator;
+
+  /**
+   * This is the String that is being iterated over.
+   */
+  String text;
+
+  /**
+   * This is the index into the String where we are currently scanning.
+   */
+  int index;
+
+  // A piece of lookahead.
+  boolean lookahead_set;
+  int lookahead;
+
+  /**
+   * This method returns the collation ordering value of the next character
+   * in the string.  This method will return <code>NULLORDER</code> if the
+   * end of the string was reached.
+   *
+   * @return The collation ordering value.
+   */
   public int next ()
   {
     if (index == text.length())
@@ -30,24 +95,51 @@ public final class CollationElementIterator
     return collator.ceiNext(this);
   }
 
-  // This one returns int while the others return short.
+  /**
+   * This method returns the primary order value for the given collation
+   * value.
+   *
+   * @param value The collation value returned from <code>next()</code> or <code>previous()</code>.
+   *
+   * @return The primary order value of the specified collation value.  This is the high 16 bits.
+   */
   public static final int primaryOrder (int order)
   {
     // From the JDK 1.2 spec.
     return order >>> 16;
   }
 
+  /**
+   * This method resets the internal position pointer to read from the
+   * beginning of the <code>String again.
+   */
   public void reset ()
   {
     index = 0;
   }
 
+  /**
+   * This method returns the secondary order value for the given collation
+   * value.
+   *
+   * @param value The collation value returned from <code>next()</code> or <code>previous()</code>.
+   *
+   * @return The secondary order value of the specified collation value.  This is the bits 8-15.
+   */
   public static final short secondaryOrder (int order)
   {
     // From the JDK 1.2 spec.
     return (short) ((order >>> 8) & 255);
   }
 
+  /**
+   * This method returns the tertiary order value for the given collation
+   * value.
+   *
+   * @param value The collation value returned from <code>next()</code> or <code>previous()</code>.
+   *
+   * @return The tertiary order value of the specified collation value.  This is the low eight bits.
+   */
   public static final short tertiaryOrder (int order)
   {
     // From the JDK 1.2 spec.
@@ -64,16 +156,5 @@ public final class CollationElementIterator
     this.collator = collator;
   }
 
-  // Text over which we iterate.
-  String text;
-
-  // Index of next character to examine in TEXT.
-  int index;
-
-  // A piece of lookahead.
-  boolean lookahead_set;
-  int lookahead;
+} // class CollationElementIterator
 
-  // The RuleBasedCollator which created this object.
-  RuleBasedCollator collator;
-}