# ParsePosition

public class **ParsePosition** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
`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

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/text/Format.html`

### Public Constructor Summary

|---|---|
|   | [ParsePosition](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#ParsePosition(int))(int index) Create a new ParsePosition with the given initial index. |

### Public Method Summary

|---|---|
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Overrides equals |
| int | [getErrorIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#getErrorIndex())() Retrieve the index at which an error occurred, or -1 if the error index has not been set. |
| int | [getIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#getIndex())() Retrieve the current parse position. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#hashCode())() Returns a hash code for this ParsePosition. |
| void | [setErrorIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#setErrorIndex(int))(int ei) Set the index at which a parse error occurred. |
| void | [setIndex](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#setIndex(int))(int index) Set the current parse position. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/text/ParsePosition.html#toString())() Return a string representation of this ParsePosition. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()

Return a string representation of this ParsePosition.

##### Returns

- a string representation of this object