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

StringCharacterIterator Class Reference

A concrete subclass of CharacterIterator that iterates over the characters (code units or code points) in a UnicodeString. More...

#include <schriter.h>

Inheritance diagram for StringCharacterIterator:

UCharCharacterIterator CharacterIterator ForwardCharacterIterator

Public Member Functions

 StringCharacterIterator (const UnicodeString &textStr)
 Create an iterator over the UnicodeString referred to by "textStr".

 StringCharacterIterator (const UnicodeString &textStr, int32_t textPos)
 Create an iterator over the UnicodeString referred to by "textStr".

 StringCharacterIterator (const UnicodeString &textStr, int32_t textBegin, int32_t textEnd, int32_t textPos)
 Create an iterator over the UnicodeString referred to by "textStr".

 StringCharacterIterator (const StringCharacterIterator &that)
 Copy constructor.

virtual ~StringCharacterIterator ()
 Destructor.

StringCharacterIteratoroperator= (const StringCharacterIterator &that)
 Assignment operator.

virtual UBool operator== (const ForwardCharacterIterator &that) const
 Returns true if the iterators iterate over the same range of the same string and are pointing at the same character.

virtual CharacterIteratorclone (void) const
 Returns a new StringCharacterIterator referring to the same character in the same range of the same string as this one.

void setText (const UnicodeString &newText)
 Sets the iterator to iterate over the provided string.

virtual void getText (UnicodeString &result)
 Copies the UnicodeString under iteration into the UnicodeString referred to by "result".

virtual UClassID getDynamicClassID (void) const
 Return a class ID for this object (not really public) .


Static Public Member Functions

UClassID getStaticClassID (void)
 Return a class ID for this class (not really public) .


Protected Member Functions

void setText (const UChar *newText, int32_t newTextLength)
 Sets the iterator to iterate over a new range of text .


Protected Attributes

UnicodeString text

Detailed Description

A concrete subclass of CharacterIterator that iterates over the characters (code units or code points) in a UnicodeString.

It's possible not only to create an iterator that iterates over an entire UnicodeString, but also to create one that iterates over only a subrange of a UnicodeString (iterators over different subranges of the same UnicodeString don't compare equal).

See also:
CharacterIterator

ForwardCharacterIterator


Constructor & Destructor Documentation

StringCharacterIterator::StringCharacterIterator const UnicodeString textStr  ) 
 

Create an iterator over the UnicodeString referred to by "textStr".

The UnicodeString object is copied. The iteration range is the whole string, and the starting position is 0.

StringCharacterIterator::StringCharacterIterator const UnicodeString textStr,
int32_t  textPos
 

Create an iterator over the UnicodeString referred to by "textStr".

The iteration range is the whole string, and the starting position is specified by "textPos". If "textPos" is outside the valid iteration range, the behavior of this object is undefined.

StringCharacterIterator::StringCharacterIterator const UnicodeString textStr,
int32_t  textBegin,
int32_t  textEnd,
int32_t  textPos
 

Create an iterator over the UnicodeString referred to by "textStr".

The UnicodeString object is copied. The iteration range begins with the code unit specified by "textBegin" and ends with the code unit BEFORE the code unit specfied by "textEnd". The starting position is specified by "textPos". If "textBegin" and "textEnd" don't form a valid range on "text" (i.e., textBegin >= textEnd or either is negative or greater than text.size()), or "textPos" is outside the range defined by "textBegin" and "textEnd", the behavior of this iterator is undefined.

StringCharacterIterator::StringCharacterIterator const StringCharacterIterator that  ) 
 

Copy constructor.

The new iterator iterates over the same range of the same string as "that", and its initial position is the same as "that"'s current position. The UnicodeString object in "that" is copied.

virtual StringCharacterIterator::~StringCharacterIterator  )  [virtual]
 

Destructor.


Member Function Documentation

virtual CharacterIterator* StringCharacterIterator::clone void   )  const [virtual]
 

Returns a new StringCharacterIterator referring to the same character in the same range of the same string as this one.

The caller must delete the new iterator.

Reimplemented from UCharCharacterIterator.

virtual void StringCharacterIterator::getText UnicodeString result  )  [virtual]
 

Copies the UnicodeString under iteration into the UnicodeString referred to by "result".

Even if this iterator iterates across only a part of this string, the whole string is copied.

Parameters:
result Receives a copy of the text under iteration.

Reimplemented from UCharCharacterIterator.

StringCharacterIterator& StringCharacterIterator::operator= const StringCharacterIterator that  ) 
 

Assignment operator.

*this is altered to iterate over the same range of the same string as "that", and refers to the same character within that string as "that" does.

virtual UBool StringCharacterIterator::operator== const ForwardCharacterIterator that  )  const [virtual]
 

Returns true if the iterators iterate over the same range of the same string and are pointing at the same character.

Reimplemented from UCharCharacterIterator.

void StringCharacterIterator::setText const UnicodeString newText  ) 
 

Sets the iterator to iterate over the provided string.


The documentation for this class was generated from the following file:
Generated on Fri Aug 13 09:53:52 2004 for ICU 2.1 by doxygen 1.3.7