1 files changed, 118 insertions, 28 deletions

diff --git a/libjava/java/text/FieldPosition.java b/libjava/java/text/FieldPosition.java
index c149e0e..57ede5b 100644
--- a/libjava/java/text/FieldPosition.java
+++ b/libjava/java/text/FieldPosition.java
@@ -1,65 +1,155 @@
-/* Copyright (C) 1998, 1999  Free Software Foundation
+/* FieldPosition.java -- Keeps track of field positions while formatting
+   Copyright (C) 1998, 1999, 2001 Free Software Foundation, Inc.
 
-   This file is part of libgcj.
+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.
+
+As a special exception, if you link this library with other files to
+produce an executable, this library does not by itself cause the
+resulting executable to be covered by the GNU General Public License.
+This exception does not however invalidate any other reasons why the
+executable file might be covered by the GNU General Public License. */
 
-This software is copyrighted work licensed under the terms of the
-Libgcj License.  Please consult the file "LIBGCJ_LICENSE" for
-details.  */
 
 package java.text;
 
 /**
+ * This class is used by the java.text formatting classes to track
+ * field positions.  A field position is defined by an identifier value
+ * and begin and end index positions.  The formatting classes in java.text
+ * typically define constant values for the field identifiers.
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
  * @author Per Bothner <bothner@cygnus.com>
- * @date October 25, 1998.
- */
-/* Written using "Java Class Libraries", 2nd edition, plus online
- * API docs for JDK 1.2 beta from http://www.javasoft.com.
- * Status:  Believed complete and correct.
- *	    Includes JDK 1.2 methods.
  */
-
 public class FieldPosition
 {
-  int field;
-  int beginIndex;
-  int endIndex;
+  /**
+   * This is the field identifier value.
+   */
+  private int field_id;
+
+  /**
+   * This is the beginning index of the field.
+   */
+  private int begin;
+
+  /**
+   * This is the ending index of the field.
+   */
+  private int end;
 
-  public FieldPosition (int field)
+  /**
+   * This method initializes a new instance of <code>FieldPosition</code> to
+   * have the specified field id.
+   *
+   * @param field_id The field identifier value.
+   */
+  public FieldPosition (int field_id)
   {
-    this.field = field;
+    this.field_id = field_id;
   }
 
+  /**
+   * This method returns the field identifier value for this object.
+   *
+   * @return The field identifier.
+   */
   public int getField ()
   {
-    return field;
+    return field_id;
   }
 
+  /**
+   * This method returns the beginning index for this field.
+   *
+   * @return The beginning index.
+   */
   public int getBeginIndex ()
   {
-    return beginIndex;
+    return begin;
   }
 
-  public int getEndIndex ()
+  /**
+   * This method sets the beginning index of this field to the specified value.
+   *
+   * @param begin The new beginning index.
+   */
+  public void setBeginIndex (int begin)
   {
-    return endIndex;
+    this.begin = begin;
   }
 
-  public void setBeginIndex (int index)
+  /**
+   * This method returns the ending index for the field.
+   *
+   * @return The ending index.
+   */
+  public int getEndIndex ()
   {
-    beginIndex = index;
+    return end;
   }
 
-  public void setEndIndex (int index)
+  /**
+   * This method sets the ending index of this field to the specified value.
+   *
+   * @param end The new ending index.
+   */
+  public void setEndIndex (int end)
   {
-    endIndex = index;
+    this.end = end;
   }
 
+  /**
+   * This method tests this object for equality against the specified object.
+   * The objects will be considered equal if and only if:
+   * <p>
+   * <ul>
+   * <li>The specified object is not <code>null</code>.
+   * <li>The specified object is an instance of <code>FieldPosition</code>.
+   * <li>The specified object has the same field identifier and beginning
+   * and ending index as this object.
+   * </ul>
+   *
+   * @param obj The object to test for equality to this object.
+   *
+   * @return <code>true</code> if the specified object is equal to
+   * this object, <code>false</code> otherwise. 
+   */
   public boolean equals (Object obj)
   {
     if (! (obj instanceof FieldPosition))
       return false;
-    FieldPosition other = (FieldPosition) obj;
-    return (field == other.field
-	    && beginIndex == other.beginIndex && endIndex == other.endIndex);
+
+    FieldPosition fp = (FieldPosition) obj;
+    return (field_id == fp.field_id
+	    && begin == fp.begin
+	    && end == fp.end);
+  }
+
+  /**
+   * This method returns a <code>String</code> representation of this
+   * object.
+   *
+   * @return A <code>String</code> representation of this object.
+   */
+  public String toString ()
+  {
+    return (getClass ().getName () + "[field=" + getField () + ",beginIndex="
+	    + getBeginIndex () + ",endIndex=" + getEndIndex () + "]");
   }
 }