libjava/java/text/ParsePosition.java

   1 /* ParsePosition.java -- Keep track of position while parsing.
   2    Copyright (C) 1998, 1999, 2001, 2005  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.text;
  40
  41 /**
  42  * This class is used to keep track of the current position during parsing
  43  * operations.
  44  *
  45  * @author Aaron M. Renn (arenn@urbanophile.com)
  46  * @author Per Bothner (bothner@cygnus.com)
  47  */
  48 public class ParsePosition
  49 {
  50   /**
  51    * This is the index of the current parse position.
  52    */
  53   private int index;
  54
  55   /**
  56    * This is the index of the position where an error occurred during parsing.
  57    */
  58   private int error_index;
  59
  60   /**
  61    * This method initializes a new instance of <code>ParsePosition</code> to
  62    * have the specified initial index value.
  63    *
  64    * @param index The initial parsing index.
  65    */
  66   public ParsePosition (int index)
  67   {
  68     this.index = index;
  69     error_index = -1;
  70   }
  71
  72   /**
  73    * This method returns the current parsing index.
  74    *
  75    * @return The current parsing index
  76    */
  77   public int getIndex ()
  78   {
  79     return index;
  80   }
  81
  82   /**
  83    * This method sets the current parsing index to the specified value.
  84    *
  85    * @param index The new parsing index.
  86    */
  87   public void setIndex (int index)
  88   {
  89     this.index = index;
  90   }
  91
  92   /**
  93    * This method returns the error index value.  This value defaults to -1
  94    * unless explicitly set to another value.
  95    *
  96    * @return The error index.
  97    */
  98   public int getErrorIndex ()
  99   {
 100     return error_index;
 101   }
 102
 103   /**
 104    * This method sets the error index to the specified value.
 105    *
 106    * @param error_index The new error index
 107    */
 108   public void setErrorIndex (int error_index)
 109   {
 110     this.error_index = error_index;
 111   }
 112
 113   /**
 114    * This method tests the specified object for equality with this
 115    * object.  The two objects will be considered equal if and only if
 116    * all of the following conditions are met.
 117    * <p>
 118    * <ul>
 119    * <li>The specified object is not <code>null</code>.</li>
 120    * <li>The specified object is an instance of <code>ParsePosition</code>.</li>
 121    * <li>The specified object has the same index and error index as
 122    *     this object.</li>
 123    * </ul>
 124    *
 125    * @param obj The <code>Object</code> to test for equality against
 126    *            this object.
 127    *
 128    * @return <code>true</code> if the specified object is equal to
 129    * this object, <code>false</code> otherwise.
 130    */
 131   public boolean equals (Object obj)
 132   {
 133     if (! (obj instanceof ParsePosition))
 134       return false;
 135
 136     ParsePosition other = (ParsePosition) obj;
 137     return index == other.index && error_index == other.error_index;
 138   }
 139
 140   /**
 141    * This method returns a <code>String</code> representation of this
 142    * object.
 143    *
 144    * @return A <code>String</code> that represents this object.
 145    */
 146   public String toString ()
 147   {
 148     return (getClass ().getName () + "[index=" + getIndex ()
 149             + ",errorIndex=" + getErrorIndex () + "]");
 150   }
 151 }