FileDocCategorySizeDatePackage
ParsePosition.javaAPI DocJava SE 5 API3564Fri Aug 26 14:57:20 BST 2005java.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.

version
1.19 12/19/03
author
Mark Davis
see
java.text.Format

Fields Summary
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.
int
errorIndex
Constructors Summary
public ParsePosition(int index)
Create a new ParsePosition with the given initial index.

        this.index = index;
    
Methods Summary
public booleanequals(java.lang.Object obj)
Overrides equals

        if (obj == null) return false;
        if (!(obj instanceof ParsePosition))
            return false;
        ParsePosition other = (ParsePosition) obj;
        return (index == other.index && errorIndex == other.errorIndex);
    
public intgetErrorIndex()
Retrieve the index at which an error occurred, or -1 if the error index has not been set.

since
1.2

        return errorIndex;
    
public intgetIndex()
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.


                                               
       
        return index;
    
public inthashCode()
Returns a hash code for this ParsePosition.

return
a hash code value for this object

        return (errorIndex << 16) | index;
    
public voidsetErrorIndex(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

        errorIndex = ei;
    
public voidsetIndex(int index)
Set the current parse position.

        this.index = index;
    
public java.lang.StringtoString()
Return a string representation of this ParsePosition.

return
a string representation of this object

        return getClass().getName() +
            "[index=" + index +
            ",errorIndex=" + errorIndex + ']";