Stay organized with collections
Save and categorize content based on your preferences.
ParsePosition
open class 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.
Summary
| Public constructors |
|
Create a new ParsePosition with the given initial index.
|
| Public methods |
| open Boolean |
Overrides equals
|
| open Int |
Retrieve the index at which an error occurred, or -1 if the error index has not been set.
|
| open Int |
Retrieve the current parse position.
|
| open Int |
Returns a hash code for this ParsePosition.
|
| open Unit |
Set the index at which a parse error occurred.
|
| open Unit |
Set the current parse position.
|
| open String |
Return a string representation of this ParsePosition.
|
Public constructors
ParsePosition
ParsePosition(index: Int)
Create a new ParsePosition with the given initial index.
| Parameters |
index |
Int: initial index |
Public methods
equals
open fun equals(other: Any?): Boolean
Overrides equals
| Parameters |
obj |
the reference object with which to compare. |
| Return |
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getErrorIndex
open fun getErrorIndex(): Int
Retrieve the index at which an error occurred, or -1 if the error index has not been set.
| Return |
Int |
the index at which an error occurred |
getIndex
open fun getIndex(): Int
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 |
Int |
the current parse position |
hashCode
open fun hashCode(): Int
Returns a hash code for this ParsePosition.
| Return |
Int |
a hash code value for this object |
setErrorIndex
open fun setErrorIndex(ei: Int): Unit
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 |
setIndex
open fun setIndex(index: Int): Unit
Set the current parse position.
| Parameters |
index |
Int: the current parse position |
toString
open fun toString(): String
Return a string representation of this ParsePosition.
| Return |
String |
a string representation of this object |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# ParsePosition\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nParsePosition\n=============\n\n```\nopen class ParsePosition\n```\n\n|---|------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.text.ParsePosition](#) |\n\n`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.\n\nBy design, as you parse through a string with different formats, you can use the same `ParsePosition`, since the index parameter records the current position.\n\nSummary\n-------\n\n| Public constructors ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [ParsePosition](#ParsePosition(kotlin.Int))`(`index:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Create a new ParsePosition with the given initial index. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Overrides equals |\n| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getErrorIndex](#getErrorIndex())`()` Retrieve the index at which an error occurred, or -1 if the error index has not been set. |\n| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getIndex](#getIndex())`()` Retrieve the current parse position. |\n| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` Returns a hash code for this ParsePosition. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setErrorIndex](#setErrorIndex(kotlin.Int))`(`ei:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the index at which a parse error occurred. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setIndex](#setIndex(kotlin.Int))`(`index:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set the current parse position. |\n| open [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](#toString())`()` Return a string representation of this ParsePosition. |\n\nPublic constructors\n-------------------\n\n### ParsePosition\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nParsePosition(index: Int)\n```\n\nCreate a new ParsePosition with the given initial index.\n\n| Parameters ||\n|---------|-------------------------------------------------------------------------------------------|\n| `index` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): initial index |\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun equals(other: Any?): Boolean\n```\n\nOverrides equals\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### getErrorIndex\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getErrorIndex(): Int\n```\n\nRetrieve the index at which an error occurred, or -1 if the error index has not been set.\n\n| Return ||\n|----------------------------------------------------------------------------|--------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the index at which an error occurred |\n\n### getIndex\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun getIndex(): Int\n```\n\nRetrieve 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.\n\n| Return ||\n|----------------------------------------------------------------------------|----------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | the current parse position |\n\n### hashCode\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun hashCode(): Int\n```\n\nReturns a hash code for this ParsePosition.\n\n| Return ||\n|----------------------------------------------------------------------------|-----------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object |\n\n### setErrorIndex\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun setErrorIndex(ei: Int): Unit\n```\n\nSet 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.\n\n| Parameters ||\n|------|------------------------------------------------------------------------------------------------------------------|\n| `ei` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the index at which an error occurred |\n\n### setIndex\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun setIndex(index: Int): Unit\n```\n\nSet the current parse position.\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------|\n| `index` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): the current parse position |\n\n### toString\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun toString(): String\n```\n\nReturn a string representation of this ParsePosition.\n\n| Return ||\n|----------------------------------------------------------------------------------|----------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of this object |"]]
