ParsePosition
open class ParsePosition
| kotlin.Any | |
| ↳ | 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.
Summary
| Public constructors | |
|---|---|
ParsePosition(index: Int)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 |
getIndex()Retrieve the current parse position. |
| open Int |
hashCode()Returns a hash code for this ParsePosition. |
| open Unit |
setErrorIndex(ei: Int)Set the index at which a parse error occurred. |
| open Unit |
Set the current parse position. |
| open String |
toString()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 |