OpenJDK 27 · java.text.ParsePosition · APIdia, the JavaDoc alternative

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.

Modifier and Type	Field and Description
pack-priv int	errorIndex
pack-priv int	index Input: the place you start parsing.

Constructor Summary

Access	Constructor and Description
public	ParsePosition(int initial index index) Create a new ParsePosition with the given initial index.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Overrides equals
public int	Returns: the index at which an error occurred getErrorIndex() Retrieve the index at which an error occurred, or -1 if the error index has not been set.
public int	Returns: the current parse position getIndex() Retrieve the current parse position.
public int	Returns: a hash code for this ParsePosition hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this ParsePosition.
public void	setErrorIndex(int the index at which an error occurred ei) Set the index at which a parse error occurred.
public void	setIndex(int the current parse position index) Set the current parse position.
public String	Returns: a string representation of this object toString() Overrides java.lang.Object.toString. Return a string representation of this ParsePosition.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

errorIndex	back to summary
pack-priv int errorIndex

index	back to summary
pack-priv int index Input: the place you start parsing. Output: position where the parse stopped. This is designed to be used serially, with each call setting index up for the next one.

Constructor Detail

ParsePosition	back to summary
public ParsePosition(int index) Create a new ParsePosition with the given initial index. Parameters index:int initial index

ParsePosition

back to summary

public ParsePosition(int index)

Create a new ParsePosition with the given initial index.

Parameters

index:int: initial index

Method Detail

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Overrides equals Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Overrides equals

Annotations

@Override

getErrorIndex	back to summary
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 Since 1.2

getErrorIndex

back to summary

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
Since: 1.2

getIndex	back to summary
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

getIndex

back to summary

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	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this ParsePosition. Returns:int a hash code for this ParsePosition Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this ParsePosition.

Returns:int

a hash code for this ParsePosition

Annotations

@Override

setErrorIndex	back to summary
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 Since 1.2

setErrorIndex

back to summary

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

Since

1.2

setIndex	back to summary
public void setIndex(int index) Set the current parse position. Parameters index:int the current parse position

setIndex

back to summary

public void setIndex(int index)

Set the current parse position.

Parameters

index:int: the current parse position

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a string representation of this ParsePosition. Returns:String a string representation of this object

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a string representation of this ParsePosition.

Returns:String: a string representation of this object

public Class ParsePosition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail