ParsePosition.java 4.58 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9
/* ParsePosition.java -- Keep track of position while parsing.
   Copyright (C) 1998, 1999, 2001, 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.
10

Tom Tromey committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
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. */


package java.text;

/**
 * This class is used to keep track of the current position during parsing
 * operations.
 *
 * @author Aaron M. Renn (arenn@urbanophile.com)
 * @author Per Bothner (bothner@cygnus.com)
 */
public class ParsePosition
{
  /**
   * This is the index of the current parse position.
   */
  private int index;

  /**
   * This is the index of the position where an error occurred during parsing.
   */
  private int error_index;

  /**
   * This method initializes a new instance of <code>ParsePosition</code> to
   * have the specified initial index value.
   *
   * @param index The initial parsing index.
   */
  public ParsePosition (int index)
  {
    this.index = index;
    error_index = -1;
  }

  /**
   * This method returns the current parsing index.
   *
   * @return The current parsing index
   */
  public int getIndex ()
  {
    return index;
  }

  /**
   * This method sets the current parsing index to the specified value.
   *
   * @param index The new parsing index.
   */
  public void setIndex (int index)
  {
    this.index = index;
  }

  /**
   * This method returns the error index value.  This value defaults to -1
   * unless explicitly set to another value.
   *
   * @return The error index.
   */
  public int getErrorIndex ()
  {
    return error_index;
  }

  /**
   * This method sets the error index to the specified value.
   *
   * @param error_index The new error index
   */
  public void setErrorIndex (int error_index)
  {
    this.error_index = error_index;
  }

  /**
   * This method tests the specified object for equality with this
   * object.  The two objects will be considered equal if and only if
   * all of the following conditions are met.
   * <p>
   * <ul>
   * <li>The specified object is not <code>null</code>.</li>
   * <li>The specified object is an instance of <code>ParsePosition</code>.</li>
   * <li>The specified object has the same index and error index as
   *     this object.</li>
   * </ul>
   *
   * @param obj The <code>Object</code> to test for equality against
126
   *            this object.
Tom Tromey committed
127 128 129 130 131 132 133 134 135 136 137 138
   *
   * @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 ParsePosition))
      return false;

    ParsePosition other = (ParsePosition) obj;
    return index == other.index && error_index == other.error_index;
  }
139

140 141 142 143 144 145 146 147
  /**
   * Return the hash code for this object.
   * @return the hash code
   */
  public int hashCode()
  {
    return index ^ error_index;
  }
Tom Tromey committed
148 149 150 151 152 153 154 155 156 157

  /**
   * This method returns a <code>String</code> representation of this
   * object.
   *
   * @return A <code>String</code> that represents this object.
   */
  public String toString ()
  {
    return (getClass ().getName () + "[index=" + getIndex ()
158
            + ",errorIndex=" + getErrorIndex () + "]");
Tom Tromey committed
159 160
  }
}