added in API level 1

ParsePosition

public class ParsePosition
extends Object

java.lang.Object
   ↳ java.text.ParsePosition


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.

See also:

Summary

Public constructors

ParsePosition(int index)

Create a new ParsePosition with the given initial index.

Public methods

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.

Inherited methods

Public constructors

ParsePosition

added in API level 1
public ParsePosition (int index)

Create a new ParsePosition with the given initial index.

Parameters
index int: initial index

Public methods

equals

added in API level 1
public boolean equals (Object obj)

Overrides equals

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getErrorIndex

added in API level 1
public int getErrorIndex ()

Retrieve the index at which an error occurred, or -1 if the error index has not been set.

Returns
int the index at which an error occurred

getIndex

added in API level 1
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
int the current parse position

hashCode

added in API level 1
public int hashCode ()

Returns a hash code for this ParsePosition.

Returns
int a hash code value for this object

setErrorIndex

added in API level 1
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 int: the index at which an error occurred

setIndex

added in API level 1
public void setIndex (int index)

Set the current parse position.

Parameters
index int: the current parse position

toString

added in API level 1
public String toString ()

Return a string representation of this ParsePosition.

Returns
String a string representation of this object