ICU 58.2  58.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
icu::UCharCharacterIterator Class Reference

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

#include <uchriter.h>

Inheritance diagram for icu::UCharCharacterIterator:
icu::CharacterIterator icu::ForwardCharacterIterator icu::UObject icu::UMemory icu::StringCharacterIterator

Public Member Functions

 UCharCharacterIterator (const UChar *textPtr, int32_t length)
 Create an iterator over the UChar array referred to by "textPtr". More...
 
 UCharCharacterIterator (const UChar *textPtr, int32_t length, int32_t position)
 Create an iterator over the UChar array referred to by "textPtr". More...
 
 UCharCharacterIterator (const UChar *textPtr, int32_t length, int32_t textBegin, int32_t textEnd, int32_t position)
 Create an iterator over the UChar array referred to by "textPtr". More...
 
 UCharCharacterIterator (const UCharCharacterIterator &that)
 Copy constructor. More...
 
virtual ~UCharCharacterIterator ()
 Destructor. More...
 
UCharCharacterIteratoroperator= (const UCharCharacterIterator &that)
 Assignment operator. More...
 
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. More...
 
virtual int32_t hashCode (void) const
 Generates a hash code for this iterator. More...
 
virtual CharacterIteratorclone (void) const
 Returns a new UCharCharacterIterator referring to the same character in the same range of the same string as this one. More...
 
virtual UChar first (void)
 Sets the iterator to refer to the first code unit in its iteration range, and returns that code unit. More...
 
virtual UChar firstPostInc (void)
 Sets the iterator to refer to the first code unit in its iteration range, returns that code unit, and moves the position to the second code unit. More...
 
virtual UChar32 first32 (void)
 Sets the iterator to refer to the first code point in its iteration range, and returns that code unit, This can be used to begin an iteration with next32(). More...
 
virtual UChar32 first32PostInc (void)
 Sets the iterator to refer to the first code point in its iteration range, returns that code point, and moves the position to the second code point. More...
 
virtual UChar last (void)
 Sets the iterator to refer to the last code unit in its iteration range, and returns that code unit. More...
 
virtual UChar32 last32 (void)
 Sets the iterator to refer to the last code point in its iteration range, and returns that code unit. More...
 
virtual UChar setIndex (int32_t position)
 Sets the iterator to refer to the "position"-th code unit in the text-storage object the iterator refers to, and returns that code unit. More...
 
virtual UChar32 setIndex32 (int32_t position)
 Sets the iterator to refer to the beginning of the code point that contains the "position"-th code unit in the text-storage object the iterator refers to, and returns that code point. More...
 
virtual UChar current (void) const
 Returns the code unit the iterator currently refers to. More...
 
virtual UChar32 current32 (void) const
 Returns the code point the iterator currently refers to. More...
 
virtual UChar next (void)
 Advances to the next code unit in the iteration range (toward endIndex()), and returns that code unit. More...
 
virtual UChar nextPostInc (void)
 Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()). More...
 
virtual UChar32 next32 (void)
 Advances to the next code point in the iteration range (toward endIndex()), and returns that code point. More...
 
virtual UChar32 next32PostInc (void)
 Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()). More...
 
virtual UBool hasNext ()
 Returns FALSE if there are no more code units or code points at or after the current position in the iteration range. More...
 
virtual UChar previous (void)
 Advances to the previous code unit in the iteration range (toward startIndex()), and returns that code unit. More...
 
virtual UChar32 previous32 (void)
 Advances to the previous code point in the iteration range (toward startIndex()), and returns that code point. More...
 
virtual UBool hasPrevious ()
 Returns FALSE if there are no more code units or code points before the current position in the iteration range. More...
 
virtual int32_t move (int32_t delta, EOrigin origin)
 Moves the current position relative to the start or end of the iteration range, or relative to the current position itself. More...
 
virtual int32_t move32 (int32_t delta, EOrigin origin)
 Moves the current position relative to the start or end of the iteration range, or relative to the current position itself. More...
 
void setText (const UChar *newText, int32_t newTextLength)
 Sets the iterator to iterate over a new range of text. More...
 
virtual void getText (UnicodeString &result)
 Copies the UChar array under iteration into the UnicodeString referred to by "result". More...
 
virtual UClassID getDynamicClassID (void) const
 Return a class ID for this object (not really public) More...
 
- Public Member Functions inherited from icu::CharacterIterator
virtual ~CharacterIterator ()
 Destructor. More...
 
int32_t setToStart ()
 Sets the iterator to refer to the first code unit or code point in its iteration range. More...
 
int32_t setToEnd ()
 Sets the iterator to the end of its iteration range, just behind the last code unit or code point. More...
 
int32_t startIndex (void) const
 Returns the numeric index in the underlying text-storage object of the character returned by first(). More...
 
int32_t endIndex (void) const
 Returns the numeric index in the underlying text-storage object of the position immediately BEYOND the character returned by last(). More...
 
int32_t getIndex (void) const
 Returns the numeric index in the underlying text-storage object of the character the iterator currently refers to (i.e., the character returned by current()). More...
 
int32_t getLength () const
 Returns the length of the entire text in the underlying text-storage object. More...
 
- Public Member Functions inherited from icu::ForwardCharacterIterator
virtual ~ForwardCharacterIterator ()
 Destructor. More...
 
UBool operator!= (const ForwardCharacterIterator &that) const
 Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

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

Protected Member Functions

 UCharCharacterIterator ()
 Protected constructor. More...
 
- Protected Member Functions inherited from icu::CharacterIterator
 CharacterIterator ()
 Empty constructor. More...
 
 CharacterIterator (int32_t length)
 Constructor, just setting the length field in this base class. More...
 
 CharacterIterator (int32_t length, int32_t position)
 Constructor, just setting the length and position fields in this base class. More...
 
 CharacterIterator (int32_t length, int32_t textBegin, int32_t textEnd, int32_t position)
 Constructor, just setting the length, start, end, and position fields in this base class. More...
 
 CharacterIterator (const CharacterIterator &that)
 Copy constructor. More...
 
CharacterIteratoroperator= (const CharacterIterator &that)
 Assignment operator. More...
 
- Protected Member Functions inherited from icu::ForwardCharacterIterator
 ForwardCharacterIterator ()
 Default constructor to be overridden in the implementing class. More...
 
 ForwardCharacterIterator (const ForwardCharacterIterator &other)
 Copy constructor to be overridden in the implementing class. More...
 
ForwardCharacterIteratoroperator= (const ForwardCharacterIterator &)
 Assignment operator to be overridden in the implementing class. More...
 

Protected Attributes

const UChartext
 Protected member text. More...
 
- Protected Attributes inherited from icu::CharacterIterator
int32_t textLength
 Base class text length field. More...
 
int32_t pos
 Base class field for the current position. More...
 
int32_t begin
 Base class field for the start of the iteration range. More...
 
int32_t end
 Base class field for the end of the iteration range. More...
 

Additional Inherited Members

- Public Types inherited from icu::CharacterIterator
enum  EOrigin { kStart, kCurrent, kEnd }
 Origin enumeration for the move() and move32() functions. More...
 
- Public Types inherited from icu::ForwardCharacterIterator
enum  { DONE = 0xffff }
 Value returned by most of ForwardCharacterIterator's functions when the iterator has reached the limits of its iteration. More...
 

Detailed Description

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

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

See also
CharacterIterator
ForwardCharacterIterator
Stable:
ICU 2.0

Definition at line 35 of file uchriter.h.

Constructor & Destructor Documentation

icu::UCharCharacterIterator::UCharCharacterIterator ( const UChar textPtr,
int32_t  length 
)

Create an iterator over the UChar array referred to by "textPtr".

The iteration range is 0 to length-1. text is only aliased, not adopted (the destructor will not delete it).

Parameters
textPtrThe UChar array to be iterated over
lengthThe length of the UChar array
Stable:
ICU 2.0
icu::UCharCharacterIterator::UCharCharacterIterator ( const UChar textPtr,
int32_t  length,
int32_t  position 
)

Create an iterator over the UChar array referred to by "textPtr".

The iteration range is 0 to length-1. text is only aliased, not adopted (the destructor will not delete it). The starting position is specified by "position". If "position" is outside the valid iteration range, the behavior of this object is undefined.

Parameters
textPtrThe UChar array to be iteratd over
lengthThe length of the UChar array
positionThe starting position of the iteration
Stable:
ICU 2.0
icu::UCharCharacterIterator::UCharCharacterIterator ( const UChar textPtr,
int32_t  length,
int32_t  textBegin,
int32_t  textEnd,
int32_t  position 
)

Create an iterator over the UChar array referred to by "textPtr".

The iteration range is 0 to end-1. text is only aliased, not adopted (the destructor will not delete it). The starting position is specified by "position". If begin and end do not form a valid iteration range or "position" is outside the valid iteration range, the behavior of this object is undefined.

Parameters
textPtrThe UChar array to be iterated over
lengthThe length of the UChar array
textBeginThe begin position of the iteration range
textEndThe end position of the iteration range
positionThe starting position of the iteration
Stable:
ICU 2.0
icu::UCharCharacterIterator::UCharCharacterIterator ( const UCharCharacterIterator 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.

Parameters
thatThe UCharCharacterIterator to be copied
Stable:
ICU 2.0
virtual icu::UCharCharacterIterator::~UCharCharacterIterator ( )
virtual

Destructor.

Stable:
ICU 2.0
icu::UCharCharacterIterator::UCharCharacterIterator ( )
protected

Protected constructor.

Stable:
ICU 2.0

Member Function Documentation

virtual CharacterIterator* icu::UCharCharacterIterator::clone ( void  ) const
virtual

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

The caller must delete the new iterator.

Returns
the CharacterIterator newly created
Stable:
ICU 2.0

Implements icu::CharacterIterator.

Reimplemented in icu::StringCharacterIterator.

virtual UChar icu::UCharCharacterIterator::current ( void  ) const
virtual

Returns the code unit the iterator currently refers to.

Returns
the code unit the iterator currently refers to.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::current32 ( void  ) const
virtual

Returns the code point the iterator currently refers to.

Returns
the code point the iterator currently refers to.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar icu::UCharCharacterIterator::first ( void  )
virtual

Sets the iterator to refer to the first code unit in its iteration range, and returns that code unit.

This can be used to begin an iteration with next().

Returns
the first code unit in its iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::first32 ( void  )
virtual

Sets the iterator to refer to the first code point in its iteration range, and returns that code unit, This can be used to begin an iteration with next32().

Note that an iteration with next32PostInc(), beginning with, e.g., setToStart() or firstPostInc(), is more efficient.

Returns
the first code point in its iteration range
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::first32PostInc ( void  )
virtual

Sets the iterator to refer to the first code point in its iteration range, returns that code point, and moves the position to the second code point.

This is an alternative to setToStart() for forward iteration with next32PostInc().

Returns
the first code point in its iteration range.
Stable:
ICU 2.0

Reimplemented from icu::CharacterIterator.

virtual UChar icu::UCharCharacterIterator::firstPostInc ( void  )
virtual

Sets the iterator to refer to the first code unit in its iteration range, returns that code unit, and moves the position to the second code unit.

This is an alternative to setToStart() for forward iteration with nextPostInc().

Returns
the first code unit in its iteration range
Stable:
ICU 2.0

Reimplemented from icu::CharacterIterator.

virtual UClassID icu::UCharCharacterIterator::getDynamicClassID ( void  ) const
virtual

Return a class ID for this object (not really public)

Returns
a class ID for this object.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

Reimplemented in icu::StringCharacterIterator.

static UClassID icu::UCharCharacterIterator::getStaticClassID ( void  )
static

Return a class ID for this class (not really public)

Returns
a class ID for this class
Stable:
ICU 2.0
virtual void icu::UCharCharacterIterator::getText ( UnicodeString result)
virtual

Copies the UChar array 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
resultReceives a copy of the text under iteration.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

Reimplemented in icu::StringCharacterIterator.

virtual int32_t icu::UCharCharacterIterator::hashCode ( void  ) const
virtual

Generates a hash code for this iterator.

Returns
the hash code.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

virtual UBool icu::UCharCharacterIterator::hasNext ( )
virtual

Returns FALSE if there are no more code units or code points at or after the current position in the iteration range.

This is used with nextPostInc() or next32PostInc() in forward iteration.

Returns
FALSE if there are no more code units or code points at or after the current position in the iteration range.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

virtual UBool icu::UCharCharacterIterator::hasPrevious ( )
virtual

Returns FALSE if there are no more code units or code points before the current position in the iteration range.

This is used with previous() or previous32() in backward iteration.

Returns
FALSE if there are no more code units or code points before the current position in the iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar icu::UCharCharacterIterator::last ( void  )
virtual

Sets the iterator to refer to the last code unit in its iteration range, and returns that code unit.

This can be used to begin an iteration with previous().

Returns
the last code unit in its iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::last32 ( void  )
virtual

Sets the iterator to refer to the last code point in its iteration range, and returns that code unit.

This can be used to begin an iteration with previous32().

Returns
the last code point in its iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual int32_t icu::UCharCharacterIterator::move ( int32_t  delta,
EOrigin  origin 
)
virtual

Moves the current position relative to the start or end of the iteration range, or relative to the current position itself.

The movement is expressed in numbers of code units forward or backward by specifying a positive or negative delta.

Parameters
deltathe position relative to origin. A positive delta means forward; a negative delta means backward.
originOrigin enumeration {kStart, kCurrent, kEnd}
Returns
the new position
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual int32_t icu::UCharCharacterIterator::move32 ( int32_t  delta,
EOrigin  origin 
)
virtual

Moves the current position relative to the start or end of the iteration range, or relative to the current position itself.

The movement is expressed in numbers of code points forward or backward by specifying a positive or negative delta.

Parameters
deltathe position relative to origin. A positive delta means forward; a negative delta means backward.
originOrigin enumeration {kStart, kCurrent, kEnd}
Returns
the new position
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar icu::UCharCharacterIterator::next ( void  )
virtual

Advances to the next code unit in the iteration range (toward endIndex()), and returns that code unit.

If there are no more code units to return, returns DONE.

Returns
the next code unit in the iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::next32 ( void  )
virtual

Advances to the next code point in the iteration range (toward endIndex()), and returns that code point.

If there are no more code points to return, returns DONE. Note that iteration with "pre-increment" semantics is less efficient than iteration with "post-increment" semantics that is provided by next32PostInc().

Returns
the next code point in the iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::next32PostInc ( void  )
virtual

Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()).

If there are no more code points to return, returns DONE.

Returns
the current point.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

virtual UChar icu::UCharCharacterIterator::nextPostInc ( void  )
virtual

Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()).

If there are no more code units to return, returns DONE.

Returns
the current code unit.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

UCharCharacterIterator& icu::UCharCharacterIterator::operator= ( const UCharCharacterIterator that)

Assignment operator.

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

Parameters
thatThe object to be copied
Returns
the newly created object
Stable:
ICU 2.0
virtual UBool icu::UCharCharacterIterator::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.

Parameters
thatThe ForwardCharacterIterator used to be compared for equality
Returns
true if the iterators iterate over the same range of the same string and are pointing at the same character.
Stable:
ICU 2.0

Implements icu::ForwardCharacterIterator.

Reimplemented in icu::StringCharacterIterator.

virtual UChar icu::UCharCharacterIterator::previous ( void  )
virtual

Advances to the previous code unit in the iteration range (toward startIndex()), and returns that code unit.

If there are no more code units to return, returns DONE.

Returns
the previous code unit in the iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::previous32 ( void  )
virtual

Advances to the previous code point in the iteration range (toward startIndex()), and returns that code point.

If there are no more code points to return, returns DONE.

Returns
the previous code point in the iteration range.
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar icu::UCharCharacterIterator::setIndex ( int32_t  position)
virtual

Sets the iterator to refer to the "position"-th code unit in the text-storage object the iterator refers to, and returns that code unit.

Parameters
positionthe position within the text-storage object
Returns
the code unit
Stable:
ICU 2.0

Implements icu::CharacterIterator.

virtual UChar32 icu::UCharCharacterIterator::setIndex32 ( int32_t  position)
virtual

Sets the iterator to refer to the beginning of the code point that contains the "position"-th code unit in the text-storage object the iterator refers to, and returns that code point.

The current position is adjusted to the beginning of the code point (its first code unit).

Parameters
positionthe position within the text-storage object
Returns
the code unit
Stable:
ICU 2.0

Implements icu::CharacterIterator.

void icu::UCharCharacterIterator::setText ( const UChar newText,
int32_t  newTextLength 
)

Sets the iterator to iterate over a new range of text.

Stable:
ICU 2.0

Field Documentation

const UChar* icu::UCharCharacterIterator::text
protected

Protected member text.

Stable:
ICU 2.0

Definition at line 378 of file uchriter.h.


The documentation for this class was generated from the following file: