ParsePosition (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.text.ParsePosition

• ---

public class ParsePosition
extends Object
ParsePosition is a simple class used by Format and its subclasses to keep track of the current position during parsing. The parseObject method in the various Format classes requires a ParsePosition object as an argument.
By design, as you parse through a string with different formats, you can use the same ParsePosition, since the index parameter records the current position.
Since:
1.1
See Also:
Format

• • Constructor Summary

  Constructors

  Constructor	Description
  ParsePosition​(int index)	Create a new ParsePosition with the given initial index.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	equals​(Object obj)	Overrides equals
  int	getErrorIndex​()	Retrieve the index at which an error occurred, or -1 if the error index has not been set.
  int	getIndex​()	Retrieve the current parse position.
  int	hashCode​()	Returns a hash code for this ParsePosition.
  void	setErrorIndex​(int ei)	Set the index at which a parse error occurred.
  void	setIndex​(int index)	Set the current parse position.
  String	toString​()	Return a string representation of this ParsePosition.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### ParsePosition  
     public ParsePosition​(int index)  
     Create a new ParsePosition with the given initial index.  
     Parameters:  
     `index` \- initial index  

  • Method Detail

    * #### getIndex  
    public int getIndex​()  
    Retrieve the current parse position. On input to a parse method, this is the index of the character at which parsing will begin; on output, it is the index of the character following the last character parsed.  
    Returns:  
    the current parse position  
    * #### setIndex  
    public void setIndex​(int index)  
    Set the current parse position.  
    Parameters:  
    `index` \- the current parse position  
    * #### setErrorIndex  
    public void setErrorIndex​(int ei)  
    Set the index at which a parse error occurred. Formatters should set this before returning an error code from their parseObject method. The default value is -1 if this is not set.  
    Parameters:  
    `ei` \- the index at which an error occurred  
    Since:  
    1.2  
    * #### getErrorIndex  
    public int getErrorIndex​()  
    Retrieve the index at which an error occurred, or -1 if the error index has not been set.  
    Returns:  
    the index at which an error occurred  
    Since:  
    1.2  
    * #### equals  
    public boolean equals​([Object](../../java/lang/Object.html "class in java.lang") obj)  
    Overrides equals  
    Overrides:  
    `[equals](../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Parameters:  
    `obj` \- the reference object with which to compare.  
    Returns:  
    `true` if this object is the same as the obj argument; `false` otherwise.  
    See Also:  
    [Object.hashCode()](../../java/lang/Object.html#hashCode--), [HashMap](../../java/util/HashMap.html "class in java.util")  
    * #### hashCode  
    public int hashCode​()  
    Returns a hash code for this ParsePosition.  
    Overrides:  
    `[hashCode](../../java/lang/Object.html#hashCode--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a hash code value for this object  
    See Also:  
    [Object.equals(java.lang.Object)](../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../java/lang/System.html#identityHashCode-java.lang.Object-)  
    * #### toString  
    public [String](../../java/lang/String.html "class in java.lang") toString​()  
    Return a string representation of this ParsePosition.  
    Overrides:  
    `[toString](../../java/lang/Object.html#toString--)` in class `[Object](../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a string representation of this object

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.