java.text: public class: ParsePosition

java.text
public class: ParsePosition [javadoc | source]

java.lang.Object
   java.text.ParsePosition

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.

Also see:

java.text.Format

author: Mark - Davis

Field 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

Constructor:
public ParsePosition(int index) { this.index = index; } Create a new ParsePosition with the given initial index.

Constructor:

 public ParsePosition(int index) {
        this.index = index;
}

Create a new ParsePosition with the given initial index.

Method from java.text.ParsePosition Summary:
equals, getErrorIndex, getIndex, hashCode, setErrorIndex, setIndex, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.text.ParsePosition Detail:
public boolean equals(Object obj) { if (obj == null) return false; if (!(obj instanceof ParsePosition)) return false; ParsePosition other = (ParsePosition) obj; return (index == other.index && errorIndex == other.errorIndex); } Overrides equals
public int getErrorIndex() { return errorIndex; } Retrieve the index at which an error occurred, or -1 if the error index has not been set.
public int getIndex() { return index; } 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.
public int hashCode() { return (errorIndex < < 16) \| index; } Returns a hash code for this ParsePosition.
public void setErrorIndex(int ei) { errorIndex = 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.
public void setIndex(int index) { this.index = index; } Set the current parse position.
public String toString() { return getClass().getName() + "[index=" + index + ",errorIndex=" + errorIndex + ']'; } Return a string representation of this ParsePosition.

Method from java.text.ParsePosition Detail:

 public boolean equals(Object obj) {
        if (obj == null) return false;
        if (!(obj instanceof ParsePosition))
            return false;
        ParsePosition other = (ParsePosition) obj;
        return (index == other.index && errorIndex == other.errorIndex);
}

Overrides equals

 public int getErrorIndex() {
        return errorIndex;
}

Retrieve the index at which an error occurred, or -1 if the error index has not been set.

 public int getIndex() {
        return index;
}

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.

 public int hashCode() {
        return (errorIndex < <  16) | index;
}

Returns a hash code for this ParsePosition.

 public  void setErrorIndex(int ei) {
        errorIndex = 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.

 public  void setIndex(int index) {
        this.index = index;
}

Set the current parse position.

 public String toString() {
        return getClass().getName() +
            "[index=" + index +
            ",errorIndex=" + errorIndex + ']';
}

Return a string representation of this ParsePosition.