Main Page   Class Hierarchy   Alphabetical List   Data Structures   File List   Data Fields   Globals  

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>


Public Methods

 ParsePosition ()
 Default constructor, the index starts with 0 as default. More...

 ParsePosition (UTextOffset newIndex)
 Create a new ParsePosition with the given initial index. More...

 ParsePosition (const ParsePosition &copy)
 Copy constructor. More...

 ~ParsePosition ()
 Destructor @stable.

ParsePosition & operator= (const ParsePosition &copy)
 Assignment operator @stable.

UBool operator== (const ParsePosition &that) const
 Equality operator. More...

UBool operator!= (const ParsePosition &that) const
 Equality operator. More...

UTextOffset getIndex (void) const
 Retrieve the current parse position. More...

void setIndex (UTextOffset index)
 Set the current parse position. More...

void setErrorIndex (UTextOffset ei)
 Set the index at which a parse error occurred. More...

UTextOffset getErrorIndex (void) const
 Retrieve the index at which an error occurred, or -1 if the error index has not been set. 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.

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


Constructor & Destructor Documentation

ParsePosition::ParsePosition   [inline]
 

Default constructor, the index starts with 0 as default.

@stable

ParsePosition::ParsePosition UTextOffset    newIndex [inline]
 

Create a new ParsePosition with the given initial index.

Parameters:
newIndex  the new text offset. @stable

ParsePosition::ParsePosition const ParsePosition &    copy [inline]
 

Copy constructor.

Parameters:
copy  the object to be copied from. @stable


Member Function Documentation

UTextOffset ParsePosition::getErrorIndex void    const [inline]
 

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

@stable

UTextOffset 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

UBool ParsePosition::operator!= const ParsePosition &    that const [inline]
 

Equality operator.

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

UBool ParsePosition::operator== const ParsePosition &    that const [inline]
 

Equality operator.

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

void ParsePosition::setErrorIndex UTextOffset    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

void ParsePosition::setIndex UTextOffset    index [inline]
 

Set the current parse position.

Parameters:
index  the new index. @stable


The documentation for this class was generated from the following file:
Generated on Sun Mar 10 02:54:33 2002 for ICU 2.0 by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002