001: /*
002: *
003: * @(#)ParsePosition.java 1.22 06/10/10
004: *
005: * Portions Copyright 2000-2006 Sun Microsystems, Inc. All Rights
006: * Reserved. Use is subject to license terms.
007: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
008: *
009: * This program is free software; you can redistribute it and/or
010: * modify it under the terms of the GNU General Public License version
011: * 2 only, as published by the Free Software Foundation.
012: *
013: * This program is distributed in the hope that it will be useful, but
014: * WITHOUT ANY WARRANTY; without even the implied warranty of
015: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
016: * General Public License version 2 for more details (a copy is
017: * included at /legal/license.txt).
018: *
019: * You should have received a copy of the GNU General Public License
020: * version 2 along with this work; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022: * 02110-1301 USA
023: *
024: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
025: * Clara, CA 95054 or visit www.sun.com if you need additional
026: * information or have any questions.
027: */
028:
029: /*
030: * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved
031: * (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved
032: *
033: * The original version of this source code and documentation is copyrighted
034: * and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These
035: * materials are provided under terms of a License Agreement between Taligent
036: * and Sun. This technology is protected by multiple US and International
037: * patents. This notice and attribution to Taligent may not be removed.
038: * Taligent is a registered trademark of Taligent, Inc.
039: *
040: */
041:
042: package java.text;
043:
044: /**
045: * <code>ParsePosition</code> is a simple class used by <code>Format</code>
046: * and its subclasses to keep track of the current position during parsing.
047: * The <code>parseObject</code> method in the various <code>Format</code>
048: * classes requires a <code>ParsePosition</code> object as an argument.
049: *
050: * <p>
051: * By design, as you parse through a string with different formats,
052: * you can use the same <code>ParsePosition</code>, since the index parameter
053: * records the current position.
054: *
055: * @version 1.22, 10/10/06
056: * @author Mark Davis
057: * @see java.text.Format
058: */
059:
060: public class ParsePosition {
061:
062: /**
063: * Input: the place you start parsing.
064: * <br>Output: position where the parse stopped.
065: * This is designed to be used serially,
066: * with each call setting index up for the next one.
067: */
068: int index = 0;
069: int errorIndex = -1;
070:
071: /**
072: * Retrieve the current parse position. On input to a parse method, this
073: * is the index of the character at which parsing will begin; on output, it
074: * is the index of the character following the last character parsed.
075: */
076: public int getIndex() {
077: return index;
078: }
079:
080: /**
081: * Set the current parse position.
082: */
083: public void setIndex(int index) {
084: this .index = index;
085: }
086:
087: /**
088: * Create a new ParsePosition with the given initial index.
089: */
090: public ParsePosition(int index) {
091: this .index = index;
092: }
093:
094: /**
095: * Set the index at which a parse error occurred. Formatters
096: * should set this before returning an error code from their
097: * parseObject method. The default value is -1 if this is not set.
098: * @since 1.2
099: */
100: public void setErrorIndex(int ei) {
101: errorIndex = ei;
102: }
103:
104: /**
105: * Retrieve the index at which an error occurred, or -1 if the
106: * error index has not been set.
107: * @since 1.2
108: */
109: public int getErrorIndex() {
110: return errorIndex;
111: }
112:
113: /**
114: * Overrides equals
115: */
116: public boolean equals(Object obj) {
117: if (obj == null)
118: return false;
119: if (!(obj instanceof ParsePosition))
120: return false;
121: ParsePosition other = (ParsePosition) obj;
122: return (index == other.index && errorIndex == other.errorIndex);
123: }
124:
125: /**
126: * Returns a hash code for this ParsePosition.
127: * @return a hash code value for this object
128: */
129: public int hashCode() {
130: return (errorIndex << 16) | index;
131: }
132:
133: /**
134: * Return a string representation of this ParsePosition.
135: * @return a string representation of this object
136: */
137: public String toString() {
138: return getClass().getName() + "[index=" + index
139: + ",errorIndex=" + errorIndex + ']';
140: }
141: }
|