Main Page | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

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 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.
 ~ParsePosition ()
 Destructor .
ParsePositionoperator= (const ParsePosition &copy)
 Assignment operator .
UBool operator== (const ParsePosition &that) const
 Equality operator.
UBool operator!= (const ParsePosition &that) const
 Equality operator.
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.


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.

ParsePosition::ParsePosition int32_t  newIndex  )  [inline]
 

Create a new ParsePosition with the given initial index.

Parameters:
newIndex the new text offset.

ParsePosition::ParsePosition const ParsePosition copy  )  [inline]
 

Copy constructor.

Parameters:
copy the object to be copied from.


Member Function Documentation

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.

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.

Returns:
the current index.

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

Equality operator.

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

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

Equality operator.

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

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.

void ParsePosition::setIndex int32_t  index  )  [inline]
 

Set the current parse position.

Parameters:
index the new index.


The documentation for this class was generated from the following file:
Generated on Sun May 22 23:05:51 2005 for ICU 2.1 by  doxygen 1.4.2