ParsePosition

AI-generated Key Takeaways

• ParsePosition is a class used by Format and its subclasses to track the current position during parsing.

• It maintains an index to mark the parsing progress within a string.

• ParsePosition includes methods to set and retrieve the current parsing position and the error index.

• Format classes use ParsePosition as an argument in their parseObject method for efficient parsing.

• The same ParsePosition instance can be used across multiple formats due to its index-based tracking.

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.

See Also

• Format

Public Constructor Summary

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

Public Method Summary

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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public ParsePosition (int index)

Create a new ParsePosition with the given initial index.

Parameters

index	initial index

Public Methods

public boolean equals (Object obj)

Overrides equals

Parameters

obj	the object to compare this instance with.

Returns

• true if the specified object is equal to this Object; false otherwise.

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

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

public int hashCode ()

Returns a hash code for this ParsePosition.

Returns

• a hash code value for this object

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

public void setIndex (int index)

Set the current parse position.

Parameters

index	the current parse position

public String toString ()

Return a string representation of this ParsePosition.

Returns

• a string representation of this object