public class

ParsePosition

extends Object
java.lang.Object
   ↳ java.text.ParsePosition

Class Overview

Tracks the current position in a parsed string. In case of an error the error index can be set to the position where the error occurred without having to change the parse position.

Summary

Public Constructors
ParsePosition(int index)
Constructs a new ParsePosition with the specified index.
Public Methods
boolean equals(Object object)
Compares the specified object to this ParsePosition and indicates if they are equal.
int getErrorIndex()
Returns the index at which the parse could not continue.
int getIndex()
Returns the current parse position.
int hashCode()
Returns an integer hash code for this object.
void setErrorIndex(int index)
Sets the index at which the parse could not continue.
void setIndex(int index)
Sets the current parse position.
String toString()
Returns the string representation of this parse position.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ParsePosition (int index)

Since: API Level 1

Constructs a new ParsePosition with the specified index.

Parameters
index the index to begin parsing.

Public Methods

public boolean equals (Object object)

Since: API Level 1

Compares the specified object to this ParsePosition and indicates if they are equal. In order to be equal, object must be an instance of ParsePosition and it must have the same index and error index.

Parameters
object the object to compare with this object.
Returns
  • true if the specified object is equal to this ParsePosition; false otherwise.
See Also

public int getErrorIndex ()

Since: API Level 1

Returns the index at which the parse could not continue.

Returns
  • the index of the parse error or -1 if there is no error.

public int getIndex ()

Since: API Level 1

Returns the current parse position.

Returns
  • the current position.

public int hashCode ()

Since: API Level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public void setErrorIndex (int index)

Since: API Level 1

Sets the index at which the parse could not continue.

Parameters
index the index of the parse error.

public void setIndex (int index)

Since: API Level 1

Sets the current parse position.

Parameters
index the current parse position.

public String toString ()

Since: API Level 1

Returns the string representation of this parse position.

Returns
  • the string representation of this parse position.