1. Description
2. Constructor Summary
3. Method Summary
4. Constructor Details
   1. ParsePosition(int)
5. Method Details
   1. getIndex()
   2. setIndex(int)
   3. setErrorIndex(int)
   4. getErrorIndex()
   5. equals(Object)
   6. hashCode()
   7. toString()

• Constructor Summary

  Constructors
  Constructor

  Description

  ParsePosition(int index)

  Create a new ParsePosition with the given initial index.

• Method Summary

  All MethodsInstance MethodsConcrete 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 declared in class java.lang.Object

  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

• Constructor Details

  • ParsePosition

    public ParsePosition(int index)

    Create a new ParsePosition with the given initial index.

    Parameters:

    index - initial index

• Method Details

  • 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 obj)

    Overrides equals

    Overrides:

    equals in class Object

    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()
    • HashMap

  • hashCode

    public int hashCode()

    Returns a hash code for this ParsePosition.

    Overrides:

    hashCode in class Object

    Returns:

    a hash code for this ParsePosition

    See Also:

    • Object.equals(java.lang.Object)
    • System.identityHashCode(java.lang.Object)

  • toString

    public String toString()

    Return a string representation of this ParsePosition.

    Overrides:

    toString in class Object

    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. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, 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.