Class ParsePosition

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

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 Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

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 - Object the object to compare with this object.

Returns:

boolean true if the object is the same as this object false if it is different from this object.

See Also:

• Object.hashCode()

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(Object)

toString

public String toString()

Return a string representation of this ParsePosition.

Overrides:

toString in class Object

Returns:

a string representation of this object