151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 26e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (C) Copyright IBM Corp. 1996 - 1998 - All Rights Reserved 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The original version of this source code and documentation is copyrighted 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * materials are provided under terms of a License Agreement between Taligent 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and Sun. This technology is protected by multiple US and International 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * patents. This notice and attribution to Taligent may not be removed. 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Taligent is a registered trademark of Taligent, Inc. 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.text; 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ParsePosition</code> is a simple class used by <code>Format</code> 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and its subclasses to keep track of the current position during parsing. 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The <code>parseObject</code> method in the various <code>Format</code> 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * classes requires a <code>ParsePosition</code> object as an argument. 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * By design, as you parse through a string with different formats, 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * you can use the same <code>ParsePosition</code>, since the index parameter 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * records the current position. 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Mark Davis 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.text.Format 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic class ParsePosition { 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Input: the place you start parsing. 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <br>Output: position where the parse stopped. 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This is designed to be used serially, 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with each call setting index up for the next one. 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int index = 0; 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int errorIndex = -1; 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Retrieve the current parse position. On input to a parse method, this 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is the index of the character at which parsing will begin; on output, it 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is the index of the character following the last character parsed. 726e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * 736e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * @return the current parse position 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int getIndex() { 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return index; 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Set the current parse position. 816e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * 826e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * @param index the current parse position 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void setIndex(int index) { 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.index = index; 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Create a new ParsePosition with the given initial index. 906e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * 916e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * @param index initial index 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public ParsePosition(int index) { 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.index = index; 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Set the index at which a parse error occurred. Formatters 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * should set this before returning an error code from their 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * parseObject method. The default value is -1 if this is not set. 1006e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * 1016e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * @param ei the index at which an error occurred 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.2 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void setErrorIndex(int ei) 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski errorIndex = ei; 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Retrieve the index at which an error occurred, or -1 if the 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * error index has not been set. 1126e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * 1136e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin * @return the index at which an error occurred 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.2 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int getErrorIndex() 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return errorIndex; 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 1206e42190c7f7d7cf3d8b787c918de0d797c6ddbbaPaul Duffin 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Overrides equals 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean equals(Object obj) 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (obj == null) return false; 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!(obj instanceof ParsePosition)) 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ParsePosition other = (ParsePosition) obj; 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (index == other.index && errorIndex == other.errorIndex); 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a hash code for this ParsePosition. 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a hash code value for this object 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int hashCode() { 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (errorIndex << 16) | index; 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Return a string representation of this ParsePosition. 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a string representation of this object 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toString() { 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getClass().getName() + 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "[index=" + index + 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ",errorIndex=" + errorIndex + ']'; 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 151