ParsePosition
is a simple class used by Format
and its subclasses to keep track of the current position during parsing.
More...
#include <parsepos.h>
Inheritance diagram for ParsePosition:
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. | |
UBool | operator== (const ParsePosition &that) const |
Equality operator. | |
UBool | operator!= (const ParsePosition &that) const |
Equality operator. | |
ParsePosition * | clone () const |
Clone this object. | |
int32_t | getIndex (void) 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 (void) const |
Retrieve the index at which an error occurred, or -1 if the error index has not been set. | |
virtual UClassID | getDynamicClassID () const |
ICU "poor man's RTTI", returns a UClassID for the actual class. | |
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 47 of file parsepos.h.
ParsePosition::ParsePosition | ( | ) | [inline] |
Default constructor, the index starts with 0 as default.
Definition at line 53 of file parsepos.h.
ParsePosition::ParsePosition | ( | int32_t | newIndex | ) | [inline] |
Create a new ParsePosition with the given initial index.
newIndex | the new text offset. |
Definition at line 64 of file parsepos.h.
ParsePosition::ParsePosition | ( | const ParsePosition & | copy | ) | [inline] |
Copy constructor.
copy | the object to be copied from. |
Definition at line 75 of file parsepos.h.
virtual ParsePosition::~ParsePosition | ( | ) | [virtual] |
ParsePosition & ParsePosition::operator= | ( | const ParsePosition & | copy | ) | [inline] |
Assignment operator.
Definition at line 183 of file parsepos.h.
References errorIndex, and index.
UBool ParsePosition::operator== | ( | const ParsePosition & | that | ) | const [inline] |
Equality operator.
Definition at line 191 of file parsepos.h.
References errorIndex, FALSE, index, and TRUE.
Referenced by operator!=().
UBool ParsePosition::operator!= | ( | const ParsePosition & | that | ) | const [inline] |
Equality operator.
Definition at line 200 of file parsepos.h.
References operator==().
ParsePosition* ParsePosition::clone | ( | ) | const |
Clone this object.
Clones can be used concurrently in multiple threads. If an error occurs, then NULL is returned. The caller must delete the clone.
int32_t ParsePosition::getIndex | ( | void | ) | const [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 206 of file parsepos.h.
void ParsePosition::setIndex | ( | int32_t | index | ) | [inline] |
Set the current parse position.
index | the new index. |
Definition at line 212 of file parsepos.h.
void ParsePosition::setErrorIndex | ( | int32_t | ei | ) | [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 224 of file parsepos.h.
int32_t ParsePosition::getErrorIndex | ( | void | ) | const [inline] |
Retrieve the index at which an error occurred, or -1 if the error index has not been set.
Definition at line 218 of file parsepos.h.
static UClassID ParsePosition::getStaticClassID | ( | ) | [static] |
virtual UClassID ParsePosition::getDynamicClassID | ( | ) | const [virtual] |