ICU 76.1 76.1
icu::ParsePosition Class Reference

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 icu::ParsePosition:
icu::UObject icu::UMemory

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)
 Copy constructor.
 
virtual ~ParsePosition ()
 Destructor.
 
ParsePositionoperator= (const ParsePosition &copy)
 Assignment operator.
 
bool operator== (const ParsePosition &that) const
 Equality operator.
 
bool operator!= (const ParsePosition &that) const
 Equality operator.
 
ParsePositionclone () 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.
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor.
 

Static Public Member Functions

static UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class.
 

Detailed Description

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.

Version
1.3 10/30/97
Author
Mark Davis, Helena Shih
See also
java.text.Format

Definition at line 52 of file parsepos.h.

Constructor & Destructor Documentation

◆ ParsePosition() [1/3]

icu::ParsePosition::ParsePosition ( )
inline

Default constructor, the index starts with 0 as default.

Stable
ICU 2.0

Definition at line 58 of file parsepos.h.

◆ ParsePosition() [2/3]

icu::ParsePosition::ParsePosition ( int32_t newIndex)
inline

Create a new ParsePosition with the given initial index.

Parameters
newIndexthe new text offset.
Stable
ICU 2.0

Definition at line 69 of file parsepos.h.

◆ ParsePosition() [3/3]

icu::ParsePosition::ParsePosition ( const ParsePosition & copy)
inline

Copy constructor.

Parameters
copythe object to be copied from.
Stable
ICU 2.0

Definition at line 80 of file parsepos.h.

◆ ~ParsePosition()

virtual icu::ParsePosition::~ParsePosition ( )
virtual

Destructor.

Stable
ICU 2.0

Member Function Documentation

◆ clone()

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.

Returns
a clone of this object
See also
getDynamicClassID
Stable
ICU 2.8

◆ getDynamicClassID()

virtual UClassID icu::ParsePosition::getDynamicClassID ( ) const
overridevirtual

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable
ICU 2.2

Reimplemented from icu::UObject.

◆ getErrorIndex()

int32_t icu::ParsePosition::getErrorIndex ( ) const
inline

Retrieve the index at which an error occurred, or -1 if the error index has not been set.

Stable
ICU 2.0

Definition at line 223 of file parsepos.h.

◆ getIndex()

int32_t icu::ParsePosition::getIndex ( ) 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.

Returns
the current index.
Stable
ICU 2.0

Definition at line 211 of file parsepos.h.

◆ getStaticClassID()

static UClassID icu::ParsePosition::getStaticClassID ( )
static

ICU "poor man's RTTI", returns a UClassID for this class.

Stable
ICU 2.2

◆ operator!=()

bool icu::ParsePosition::operator!= ( const ParsePosition & that) const
inline

Equality operator.

Returns
true if the two parse positions are not equal, false otherwise.
Stable
ICU 2.0

Definition at line 205 of file parsepos.h.

References icu::operator==().

◆ operator=()

ParsePosition & icu::ParsePosition::operator= ( const ParsePosition & copy)
inline

Assignment operator.

Stable
ICU 2.0

Definition at line 188 of file parsepos.h.

◆ operator==()

bool icu::ParsePosition::operator== ( const ParsePosition & that) const
inline

Equality operator.

Returns
true if the two parse positions are equal, false otherwise.
Stable
ICU 2.0

Definition at line 196 of file parsepos.h.

◆ setErrorIndex()

void icu::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.

Stable
ICU 2.0

Definition at line 229 of file parsepos.h.

◆ setIndex()

void icu::ParsePosition::setIndex ( int32_t index)
inline

Set the current parse position.

Parameters
indexthe new index.
Stable
ICU 2.0

Definition at line 217 of file parsepos.h.


The documentation for this class was generated from the following file: