ICU 76.1 76.1
|
ParsePosition
is a simple class used by Format
and its subclasses to keep track of the current position during parsing.
More...
#include <parsepos.h>
Public Member Functions | |
ParsePosition () | |
Default constructor, the index starts with 0 as default. | |
ParsePosition (int32_t newIndex) | |
Create a new ParsePosition with the given initial index. | |
ParsePosition (const ParsePosition ©) | |
Copy constructor. | |
virtual | ~ParsePosition () |
Destructor. | |
ParsePosition & | operator= (const ParsePosition ©) |
Assignment operator. | |
bool | operator== (const ParsePosition &that) const |
Equality operator. | |
bool | operator!= (const ParsePosition &that) const |
Equality operator. | |
ParsePosition * | clone () const |
Clone this object. | |
int32_t | getIndex () const |
Retrieve the current parse position. | |
void | setIndex (int32_t index) |
Set the current parse position. | |
void | setErrorIndex (int32_t ei) |
Set the index at which a parse error occurred. | |
int32_t | getErrorIndex () const |
Retrieve the index at which an error occurred, or -1 if the error index has not been set. | |
virtual UClassID | getDynamicClassID () const override |
ICU "poor man's RTTI", returns a UClassID for the actual class. | |
![]() | |
virtual | ~UObject () |
Destructor. | |
Static Public Member Functions | |
static UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. | |
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.
The ParsePosition class is not suitable for subclassing.
Definition at line 52 of file parsepos.h.
|
inline |
Default constructor, the index starts with 0 as default.
Definition at line 58 of file parsepos.h.
Referenced by clone(), operator!=(), operator=(), operator==(), ParsePosition(), and ~ParsePosition().
|
inline |
Create a new ParsePosition with the given initial index.
newIndex | the new text offset. |
Definition at line 69 of file parsepos.h.
|
inline |
Copy constructor.
copy | the object to be copied from. |
Definition at line 80 of file parsepos.h.
References ParsePosition().
|
virtual |
ParsePosition * icu::ParsePosition::clone | ( | ) | const |
Clone this object.
Clones can be used concurrently in multiple threads. If an error occurs, then nullptr is returned. The caller must delete the clone.
References getErrorIndex(), getIndex(), ParsePosition(), setErrorIndex(), and setIndex().
|
overridevirtual |
ICU "poor man's RTTI", returns a UClassID for the actual class.
Reimplemented from icu::UObject.
|
inline |
Retrieve the index at which an error occurred, or -1 if the error index has not been set.
Definition at line 223 of file parsepos.h.
References getErrorIndex().
Referenced by clone(), and getErrorIndex().
|
inline |
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.
Definition at line 211 of file parsepos.h.
References getIndex().
Referenced by clone(), and getIndex().
|
static |
|
inline |
Equality operator.
Definition at line 205 of file parsepos.h.
References operator!=(), operator==(), and ParsePosition().
Referenced by operator!=().
|
inline |
Assignment operator.
Definition at line 188 of file parsepos.h.
References operator=(), and ParsePosition().
Referenced by operator=(), and ~ParsePosition().
|
inline |
Equality operator.
Definition at line 196 of file parsepos.h.
References operator==(), and ParsePosition().
Referenced by operator!=(), and operator==().
|
inline |
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.
Definition at line 229 of file parsepos.h.
References setErrorIndex().
Referenced by clone(), and setErrorIndex().
|
inline |
Set the current parse position.
index | the new index. |
Definition at line 217 of file parsepos.h.
References setIndex().
Referenced by clone(), and setIndex().