- java.lang.Object
-
- java.text.ParsePosition
-
public class ParsePosition extends Object
ParsePosition
is a simple class used byFormat
and its subclasses to keep track of the current position during parsing. TheparseObject
method in the variousFormat
classes requires aParsePosition
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
-
-
Constructor Summary
Constructors Constructor and Description ParsePosition(int index)
Create a new ParsePosition with the given initial index.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(Object obj)
Overrides equalsint
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.
-
-
-
Constructor Detail
-
ParsePosition
public ParsePosition(int index)
Create a new ParsePosition with the given initial index.
-
-
Method Detail
-
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.
-
setIndex
public void setIndex(int index)
Set 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.- 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.- Since:
- 1.2
-
equals
public boolean equals(Object obj)
Overrides equals- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
-
hashCode
public int hashCode()
Returns a hash code for this ParsePosition.- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/text/parseposition.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.