Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

UnicodeSetIterator Class Reference

UnicodeSetIterator iterates over the contents of a UnicodeSet. More...

#include <usetiter.h>

Inheritance diagram for UnicodeSetIterator::

UObject List of all members.

Public Methods

 UnicodeSetIterator (const UnicodeSet &set)
 Create an iterator over the given set. More...

 UnicodeSetIterator ()
 Create an iterator over nothing. More...

virtual ~UnicodeSetIterator ()
 Destructor. More...

UBool isString () const
 Returns true if the current element is a string. More...

UChar32 getCodepoint () const
 Returns the current code point, if isString() returned false. More...

UChar32 getCodepointEnd () const
 Returns the end of the current code point range, if isString() returned false and nextRange() was called. More...

const UnicodeStringgetString () const
 Returns the current string, if isString() returned true. More...

UBool next ()
 Returns the next element in the set, either a single code point or a string. More...

UBool nextRange ()
 Returns the next element in the set, either a code point range or a string. More...

void reset (const UnicodeSet &set)
 Sets this iterator to visit the elements of the given set and resets it to the start of that set. More...

void reset ()
 Resets this iterator to the start of the set. More...

virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...


Static Public Methods

UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...


Protected Types

enum  { IS_STRING = -1 }
 Value of codepoint if the iterator points to a string. More...


Protected Methods

 UnicodeSetIterator (const UnicodeSetIterator &)
UnicodeSetIterator & operator= (const UnicodeSetIterator &)
virtual void loadRange (int32_t range)

Protected Attributes

UChar32 codepoint
 Current code point, or the special value IS_STRING, if the iterator points to a string. More...

UChar32 codepointEnd
 When iterating over ranges using nextRange(), codepointEnd contains the inclusive end of the iteration range, if codepoint != IS_STRING. More...

const UnicodeStringstring
 If codepoint == IS_STRING, then string points to the current string. More...

const UnicodeSetset
int32_t endRange
int32_t range
int32_t endElement
int32_t nextElement
int32_t nextString
int32_t stringCount

Static Private Attributes

const char fgClassID
 The address of this static class variable serves as this class's ID for ICU "poor man's RTTI". More...


Detailed Description

UnicodeSetIterator iterates over the contents of a UnicodeSet.

It iterates over either code points or code point ranges. After all code points or ranges have been returned, it returns the multicharacter strings of the UnicodSet, if any.

To iterate over code points, use a loop like this:

 UnicodeSetIterator it(set);
 while (set.next()) {
   if (set.isString()) {
     processString(set.getString());
   } else {
     processCodepoint(set.getCodepoint());
   }
 }
 

To iterate over code point ranges, use a loop like this:

 UnicodeSetIterator it(set);
 while (set.nextRange()) {
   if (set.isString()) {
     processString(set.getString());
   } else {
     processCodepointRange(set.getCodepoint(), set.getCodepointEnd());
   }
 }
 
Author:
M. Davis
Draft:
This API has been introduced in ICU 2.2. It is still in draft state and may be modified in a future release.

Definition at line 54 of file usetiter.h.


Member Enumeration Documentation

anonymous enum [protected]
 

Value of codepoint if the iterator points to a string.

If codepoint == IS_STRING, then examine string for the current iteration result.

Enumeration values:
IS_STRING 

Definition at line 63 of file usetiter.h.


Constructor & Destructor Documentation

UnicodeSetIterator::UnicodeSetIterator const UnicodeSet   set
 

Create an iterator over the given set.

The iterator is valid only so long as set is valid.

Parameters:
set  set to iterate over

UnicodeSetIterator::UnicodeSetIterator  
 

Create an iterator over nothing.

next() and nextRange() return false. This is a convenience constructor allowing the target to be set later.

virtual UnicodeSetIterator::~UnicodeSetIterator   [virtual]
 

Destructor.

UnicodeSetIterator::UnicodeSetIterator const UnicodeSetIterator &    [protected]
 


Member Function Documentation

UChar32 UnicodeSetIterator::getCodepoint   const [inline]
 

Returns the current code point, if isString() returned false.

Otherwise returns an undefined result.

Definition at line 242 of file usetiter.h.

UChar32 UnicodeSetIterator::getCodepointEnd   const [inline]
 

Returns the end of the current code point range, if isString() returned false and nextRange() was called.

Otherwise returns an undefined result.

Definition at line 246 of file usetiter.h.

virtual UClassID UnicodeSetIterator::getDynamicClassID void    const [inline, virtual]
 

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

Draft:
This API has been introduced in ICU 2.2. It is still in draft state and may be modified in a future release.

Reimplemented from UObject.

Definition at line 198 of file usetiter.h.

UClassID UnicodeSetIterator::getStaticClassID void    [inline, static]
 

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

Draft:
This API has been introduced in ICU 2.2. It is still in draft state and may be modified in a future release.

Definition at line 205 of file usetiter.h.

const UnicodeString & UnicodeSetIterator::getString void    const [inline]
 

Returns the current string, if isString() returned true.

Otherwise returns an undefined result.

Definition at line 250 of file usetiter.h.

UBool UnicodeSetIterator::isString   const [inline]
 

Returns true if the current element is a string.

If so, the caller can retrieve it with getString(). If this method returns false, the current element is a code point or code point range, depending on whether next() or nextRange() was called, and the caller can retrieve it with getCodepoint() and, for a range, getCodepointEnd().

Definition at line 238 of file usetiter.h.

virtual void UnicodeSetIterator::loadRange int32_t    range [protected, virtual]
 

UBool UnicodeSetIterator::next void   
 

Returns the next element in the set, either a single code point or a string.

If there are no more elements in the set, return false. If codepoint == IS_STRING, the value is a string in the string field. Otherwise the value is a single code point in the codepoint field.

The order of iteration is all code points in sorted order, followed by all strings sorted order. codepointEnd is undefined after calling this method. string is undefined unless codepoint == IS_STRING. Do not mix calls to next() and nextRange() without calling reset() between them. The results of doing so are undefined.

Returns:
true if there was another element in the set and this object contains the element.

UBool UnicodeSetIterator::nextRange  
 

Returns the next element in the set, either a code point range or a string.

If there are no more elements in the set, return false. If codepoint == IS_STRING, the value is a string in the string field. Otherwise the value is a range of one or more code points from codepoint to codepointeEnd inclusive.

The order of iteration is all code points ranges in sorted order, followed by all strings sorted order. Ranges are disjoint and non-contiguous. string is undefined unless codepoint == IS_STRING. Do not mix calls to next() and nextRange() without calling reset() between them. The results of doing so are undefined.

Returns:
true if there was another element in the set and this object contains the element.

UnicodeSetIterator& UnicodeSetIterator::operator= const UnicodeSetIterator &    [protected]
 

void UnicodeSetIterator::reset void   
 

Resets this iterator to the start of the set.

void UnicodeSetIterator::reset const UnicodeSet   set
 

Sets this iterator to visit the elements of the given set and resets it to the start of that set.

The iterator is valid only so long as set is valid.

Parameters:
set  the set to iterate over.


Member Data Documentation

UChar32 UnicodeSetIterator::codepoint [protected]
 

Current code point, or the special value IS_STRING, if the iterator points to a string.

Definition at line 69 of file usetiter.h.

UChar32 UnicodeSetIterator::codepointEnd [protected]
 

When iterating over ranges using nextRange(), codepointEnd contains the inclusive end of the iteration range, if codepoint != IS_STRING.

If iterating over code points using next(), or if codepoint == IS_STRING, then the value of codepointEnd is undefined.

Definition at line 79 of file usetiter.h.

int32_t UnicodeSetIterator::endElement [protected]
 

Definition at line 217 of file usetiter.h.

int32_t UnicodeSetIterator::endRange [protected]
 

Definition at line 215 of file usetiter.h.

const char UnicodeSetIterator::fgClassID [static, private]
 

The address of this static class variable serves as this class's ID for ICU "poor man's RTTI".

Definition at line 235 of file usetiter.h.

int32_t UnicodeSetIterator::nextElement [protected]
 

Definition at line 218 of file usetiter.h.

int32_t UnicodeSetIterator::nextString [protected]
 

Definition at line 220 of file usetiter.h.

int32_t UnicodeSetIterator::range [protected]
 

Definition at line 216 of file usetiter.h.

const UnicodeSet* UnicodeSetIterator::set [protected]
 

Definition at line 214 of file usetiter.h.

const UnicodeString* UnicodeSetIterator::string [protected]
 

If codepoint == IS_STRING, then string points to the current string.

If codepoint != IS_STRING, the value of string is undefined.

Definition at line 86 of file usetiter.h.

int32_t UnicodeSetIterator::stringCount [protected]
 

Definition at line 221 of file usetiter.h.


The documentation for this class was generated from the following file:
Generated on Thu Aug 15 14:14:16 2002 for ICU 2.2 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001