ParsePosition

class U_I18N_API ParsePosition

ParsePosition is a simple class used by Format and its subclasses to keep track of the current position during parsing

Public Methods
ParsePosition(): Default constructor, the index starts with 0 as default
ParsePosition(UTextOffset newIndex): Create a new ParsePosition with the given initial index
ParsePosition(const ParsePosition& copy): Copy constructor
~ParsePosition(): Destructor
ParsePosition& operator=(const ParsePosition& copy): Assignment operator
bool_t operator==(const ParsePosition& that) const: Equality operator
bool_t operator!=(const ParsePosition& that) const: Equality operator
UTextOffset getIndex(void) const: Retrieve the current parse position
void setIndex(UTextOffset index): Set the current parse position
void setErrorIndex(UTextOffset ei): Set the index at which a parse error occurred
UTextOffset getErrorIndex(void) const: Retrieve the index at which an error occurred, or -1 if the error index has not been set

Documentation

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.

ParsePosition()

Default constructor, the index starts with 0 as default

ParsePosition(UTextOffset newIndex)

Create a new ParsePosition with the given initial index

Parameters:: newIndex - the new text offset.

ParsePosition(const ParsePosition& copy)

Copy constructor

Parameters:: copy - the object to be copied from.

~ParsePosition()

ParsePosition& operator=(const ParsePosition& copy)

Assignment operator

bool_t operator==(const ParsePosition& that) const

Equality operator

Returns:: TRUE if the two parse positions are equal, FALSE otherwise.

bool_t operator!=(const ParsePosition& that) const

Equality operator

Returns:: TRUE if the two parse positions are not equal, FALSE otherwise.

UTextOffset getIndex(void) const

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.

void setIndex(UTextOffset index)

Set the current parse position

Parameters:: index - the new index.

void setErrorIndex(UTextOffset ei)

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.

UTextOffset getErrorIndex(void) const

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

This class has no child classes.

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

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de