ICU 56.1: icu::ParsePosition Class Reference

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- Data Structures
- Data Structure Index
- Class Hierarchy
- Data Fields

Public Member Functions | Static Public Member Functions
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:

## Public Member Functions
| ParsePosition ()
| Default constructor, the index starts with 0 as default. More...
| ParsePosition (int32_t newIndex)
| Create a new ParsePosition with the given initial index. More...
| ParsePosition (const ParsePosition &copy)
| Copy constructor. More...
virtual | ~ParsePosition ()
| Destructor. More...
ParsePosition & | operator= (const ParsePosition &copy)
| Assignment operator. More...
UBool | operator== (const ParsePosition &that) const
| Equality operator. More...
UBool | operator!= (const ParsePosition &that) const
| Equality operator. More...
ParsePosition * | clone () const
| Clone this object. More...
int32_t | getIndex (void) const
| Retrieve the current parse position. More...
void | setIndex (int32_t index)
| Set the current parse position. More...
void | setErrorIndex (int32_t ei)
| Set the index at which a parse error occurred. More...
int32_t | getErrorIndex (void) const
| Retrieve the index at which an error occurred, or -1 if the error index has not been set. More...
virtual UClassID | getDynamicClassID () const
| ICU "poor man's RTTI", returns a UClassID for the actual class. More...
Public Member Functions inherited from icu::UObject
virtual | ~UObject ()
| Destructor. More...

## Static Public Member Functions
static UClassID | getStaticClassID ()
| ICU "poor man's RTTI", returns a UClassID for this class. More...

## 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 47 of file parsepos.h.

## Constructor & Destructor Documentation

icu::ParsePosition::ParsePosition | ( |  | ) |
| inline

Default constructor, the index starts with 0 as default.

Stable:
  ICU 2.0

Definition at line 53 of file parsepos.h.

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

Create a new ParsePosition with the given initial index.

Parameters

  newIndex | the new text offset.

Stable:
  ICU 2.0

Definition at line 64 of file parsepos.h.

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

Copy constructor.

Parameters

  copy | the object to be copied from.

Stable:
  ICU 2.0

Definition at line 75 of file parsepos.h.

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

Destructor.

Stable:
  ICU 2.0

## Member Function Documentation

ParsePosition* icu::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.

Returns
  a clone of this object

See also
  getDynamicClassID

Stable:
  ICU 2.8

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

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

Stable:
  ICU 2.2

Reimplemented from icu::UObject.

int32_t icu::ParsePosition::getErrorIndex | ( | void |  | ) | 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 218 of file parsepos.h.

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

Returns
  the current index.

Stable:
  ICU 2.0

Definition at line 206 of file parsepos.h.

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

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

Stable:
  ICU 2.2

UBool 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 200 of file parsepos.h.

References icu::operator==().

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

Assignment operator.

Stable:
  ICU 2.0

Definition at line 183 of file parsepos.h.

UBool 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 191 of file parsepos.h.

References FALSE, and TRUE.

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 224 of file parsepos.h.

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

Set the current parse position.

Parameters

  index | the new index.

Stable:
  ICU 2.0

Definition at line 212 of file parsepos.h.

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

- parsepos.h