Sophie

Sophie

distrib > CentOS > 5 > x86_64 > by-pkgid > 34ae14235711d1471f043ac894a061f9 > files > 69

libicu-doc-3.6-5.16.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.6: ForwardCharacterIterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li id="current"><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    <li>
      <form action="search.php" method="get">
        <table cellspacing="0" cellpadding="0" border="0">
          <tr>
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
          </tr>
        </table>
      </form>
    </li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  </ul></div>
<h1>ForwardCharacterIterator Class Reference</h1><!-- doxytag: class="ForwardCharacterIterator" --><!-- doxytag: inherits="UObject" -->Abstract class that defines an API for forward-only iteration on text objects.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="chariter_8h-source.html">chariter.h</a>&gt;</code>
<p>
<p>Inheritance diagram for ForwardCharacterIterator:
<p><center><img src="classForwardCharacterIterator.png" usemap="#ForwardCharacterIterator_map" border="0" alt=""></center>
<map name="ForwardCharacterIterator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,157,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,157,24">
<area href="classCharacterIterator.html" alt="CharacterIterator" shape="rect" coords="0,168,157,192">
<area href="classUCharCharacterIterator.html" alt="UCharCharacterIterator" shape="rect" coords="0,224,157,248">
<area href="classStringCharacterIterator.html" alt="StringCharacterIterator" shape="rect" coords="0,280,157,304">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d03d526b67ec012a368053daf14929a553d2e450bf7f774df8ee92daa539575"></a><!-- doxytag: member="ForwardCharacterIterator::DONE" ref="3d03d526b67ec012a368053daf14929a553d2e450bf7f774df8ee92daa539575" args="" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>DONE</b> = 0xffff</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <b>DONE</b> =  0xffff
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Value returned by most of ForwardCharacterIterator's functions when the iterator has reached the limits of its iteration.  <a href="classForwardCharacterIterator.html#3d03d526b67ec012a368053daf14929a">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#4d68318c716e161c0e991f13423002b5">~ForwardCharacterIterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#4d68318c716e161c0e991f13423002b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#992b78b4c510a4a30250da79b0529c14">operator==</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;that) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true when both iterators refer to the same character in the same character-storage object.  <a href="#992b78b4c510a4a30250da79b0529c14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#dd26b900d312164242f33d0ae87b4313">operator!=</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;that) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object.  <a href="#dd26b900d312164242f33d0ae87b4313"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#4832027db9a9273373cf7aac2c103cc7">hashCode</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generates a hash code for this iterator.  <a href="#4832027db9a9273373cf7aac2c103cc7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#2982ab7d0e1818c68d61384c1db017d9">getDynamicClassID</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a UClassID for this <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> ("poor man's RTTI").  <a href="#2982ab7d0e1818c68d61384c1db017d9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual UChar&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#ce81226f0d573d091e3959964863e9f6">nextPostInc</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()).  <a href="#ce81226f0d573d091e3959964863e9f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a5c18ea10e60c576fe5ec420a7ef7b28">UChar32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()).  <a href="#91bb4f88f0fb1adeb74ab544cea92719"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#3fd1bd82308c4d862ff67e7523eb133e">hasNext</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns FALSE if there are no more code units or code points at or after the current position in the iteration range.  <a href="#3fd1bd82308c4d862ff67e7523eb133e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#77256ac18bc7af207ba1a6d17d0bd74a">ForwardCharacterIterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor to be overridden in the implementing class.  <a href="#77256ac18bc7af207ba1a6d17d0bd74a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#dc6bd43c0facd84b748f203839514131">ForwardCharacterIterator</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor to be overridden in the implementing class.  <a href="#dc6bd43c0facd84b748f203839514131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#4daa45157ec8c423f58f4309b143f01d">operator=</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator to be overridden in the implementing class.  <a href="#4daa45157ec8c423f58f4309b143f01d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class that defines an API for forward-only iteration on text objects. 
<p>
This is a minimal interface for iteration without random access or backwards iteration. It is especially useful for wrapping streams with converters into an object for collation or normalization.<p>
Characters can be accessed in two ways: as code units or as code points. Unicode code points are 21-bit integers and are the scalar values of Unicode characters. ICU uses the type UChar32 for them. Unicode code units are the storage units of a given Unicode/UCS Transformation <a class="el" href="classFormat.html">Format</a> (a character encoding scheme). With UTF-16, all code points can be represented with either one or two code units ("surrogates"). String storage is typically based on code units, while properties of characters are typically determined using code point values. Some processes may be designed to work with sequences of code units, or it may be known that all characters that are important to an algorithm can be represented with single code units. Other processes will need to use the code point access functions.<p>
<a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> provides <a class="el" href="classForwardCharacterIterator.html#ce81226f0d573d091e3959964863e9f6">nextPostInc()</a> to access a code unit and advance an internal position into the text object, similar to a <code>return text[position++]</code>.<br>
 It provides <a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a> to access a code point and advance an internal position.<p>
<a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a> assumes that the current position is that of the beginning of a code point, i.e., of its first code unit. After <a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a>, this will be true again. In general, access to code units and code points in the same iteration loop should not be mixed. In UTF-16, if the current position is on a second code unit (Low Surrogate), then only that code unit is returned even by <a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a>.<p>
For iteration with either function, there are two ways to check for the end of the iteration. When there are no more characters in the text object: <ul>
<li>
The <a class="el" href="classForwardCharacterIterator.html#3fd1bd82308c4d862ff67e7523eb133e">hasNext()</a> function returns FALSE. </li>
<li>
<a class="el" href="classForwardCharacterIterator.html#ce81226f0d573d091e3959964863e9f6">nextPostInc()</a> and <a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a> return DONE when one attempts to read beyond the end of the text object. </li>
</ul>
<p>
Example: <div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> function1(<a class="code" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;it) {
     <a class="code" href="umachine_8h.html#a5c18ea10e60c576fe5ec420a7ef7b28">UChar32</a> c;
     <span class="keywordflow">while</span>(it.<a class="code" href="classForwardCharacterIterator.html#3fd1bd82308c4d862ff67e7523eb133e">hasNext</a>()) {
         c=it.<a class="code" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc</a>();
         <span class="comment">// use c</span>
     }
 }

 <span class="keywordtype">void</span> function1(<a class="code" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;it) {
     <a class="code" href="umachine_8h.html#a7213b402d772584553f6e614109e6e4">UChar</a> c;
     <span class="keywordflow">while</span>((c=it.<a class="code" href="classForwardCharacterIterator.html#ce81226f0d573d091e3959964863e9f6">nextPostInc</a>())!=ForwardCharacterIterator::DONE) {
         <span class="comment">// use c</span>
      }
  }
</pre></div> <p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000043">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>

<p>
Definition at line <a class="el" href="chariter_8h-source.html#l00089">89</a> of file <a class="el" href="chariter_8h-source.html">chariter.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="3d03d526b67ec012a368053daf14929a"></a><!-- doxytag: member="ForwardCharacterIterator::@1" ref="3d03d526b67ec012a368053daf14929a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Value returned by most of ForwardCharacterIterator's functions when the iterator has reached the limits of its iteration. 
<p>
<dl compact><dt><b>Stable:</b></dt><dd>ICU 2.0 </dd></dl>

<p>
Definition at line <a class="el" href="chariter_8h-source.html#l00096">96</a> of file <a class="el" href="chariter_8h-source.html">chariter.h</a>.
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4d68318c716e161c0e991f13423002b5"></a><!-- doxytag: member="ForwardCharacterIterator::~ForwardCharacterIterator" ref="4d68318c716e161c0e991f13423002b5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ForwardCharacterIterator::~ForwardCharacterIterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000046">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

</div>
</div><p>
<a class="anchor" name="77256ac18bc7af207ba1a6d17d0bd74a"></a><!-- doxytag: member="ForwardCharacterIterator::ForwardCharacterIterator" ref="77256ac18bc7af207ba1a6d17d0bd74a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ForwardCharacterIterator::ForwardCharacterIterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default constructor to be overridden in the implementing class. 
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000054">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

</div>
</div><p>
<a class="anchor" name="dc6bd43c0facd84b748f203839514131"></a><!-- doxytag: member="ForwardCharacterIterator::ForwardCharacterIterator" ref="dc6bd43c0facd84b748f203839514131" args="(const ForwardCharacterIterator &amp;other)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ForwardCharacterIterator::ForwardCharacterIterator           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy constructor to be overridden in the implementing class. 
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000055">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2982ab7d0e1818c68d61384c1db017d9"></a><!-- doxytag: member="ForwardCharacterIterator::getDynamicClassID" ref="2982ab7d0e1818c68d61384c1db017d9" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> ForwardCharacterIterator::getDynamicClassID           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a UClassID for this <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> ("poor man's RTTI"). 
<p>
Despite the fact that this function is public, DO NOT CONSIDER IT PART OF CHARACTERITERATOR'S API! <dl compact><dt><b>Returns:</b></dt><dd>a UClassID for this <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000050">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implements <a class="el" href="classUObject.html#60f3fba82b9d7edfe3d3f9d423ab826d">UObject</a>.
<p>
Implemented in <a class="el" href="classStringCharacterIterator.html#61b47f4168310d2e9b8a5894d9124899">StringCharacterIterator</a>, and <a class="el" href="classUCharCharacterIterator.html#f3f3d1d6af04bd8ce70ace494bc69af1">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="4832027db9a9273373cf7aac2c103cc7"></a><!-- doxytag: member="ForwardCharacterIterator::hashCode" ref="4832027db9a9273373cf7aac2c103cc7" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> ForwardCharacterIterator::hashCode           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Generates a hash code for this iterator. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the hash code. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000049">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implemented in <a class="el" href="classUCharCharacterIterator.html#4a300f7f4e327b58fcdc01bb2edc2f94">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="3fd1bd82308c4d862ff67e7523eb133e"></a><!-- doxytag: member="ForwardCharacterIterator::hasNext" ref="3fd1bd82308c4d862ff67e7523eb133e" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> ForwardCharacterIterator::hasNext           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns FALSE if there are no more code units or code points at or after the current position in the iteration range. 
<p>
This is used with <a class="el" href="classForwardCharacterIterator.html#ce81226f0d573d091e3959964863e9f6">nextPostInc()</a> or <a class="el" href="classForwardCharacterIterator.html#91bb4f88f0fb1adeb74ab544cea92719">next32PostInc()</a> in forward iteration. <dl compact><dt><b>Returns:</b></dt><dd>FALSE if there are no more code units or code points at or after the current position in the iteration range. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000053">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implemented in <a class="el" href="classUCharCharacterIterator.html#65dd5c7a164e999e05ffa5531b97890d">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="91bb4f88f0fb1adeb74ab544cea92719"></a><!-- doxytag: member="ForwardCharacterIterator::next32PostInc" ref="91bb4f88f0fb1adeb74ab544cea92719" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="umachine_8h.html#a5c18ea10e60c576fe5ec420a7ef7b28">UChar32</a> ForwardCharacterIterator::next32PostInc           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()). 
<p>
If there are no more code points to return, returns DONE. <dl compact><dt><b>Returns:</b></dt><dd>the current code point. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000052">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implemented in <a class="el" href="classUCharCharacterIterator.html#2cb722672d21ca8f98816ba387fbb2ca">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="ce81226f0d573d091e3959964863e9f6"></a><!-- doxytag: member="ForwardCharacterIterator::nextPostInc" ref="ce81226f0d573d091e3959964863e9f6" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual UChar ForwardCharacterIterator::nextPostInc           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()). 
<p>
If there are no more code units to return, returns DONE. <dl compact><dt><b>Returns:</b></dt><dd>the current code unit. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000051">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implemented in <a class="el" href="classUCharCharacterIterator.html#f56713ffc30485ab2fd2c0e80054c84a">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="dd26b900d312164242f33d0ae87b4313"></a><!-- doxytag: member="ForwardCharacterIterator::operator!=" ref="dd26b900d312164242f33d0ae87b4313" args="(const ForwardCharacterIterator &amp;that) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> ForwardCharacterIterator::operator!=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>that</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>that</em>&nbsp;</td><td>The <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> to be compared for inequality </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000048">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Definition at line <a class="el" href="chariter_8h-source.html#l00681">681</a> of file <a class="el" href="chariter_8h-source.html">chariter.h</a>.
<p>
References <a class="el" href="classForwardCharacterIterator.html#992b78b4c510a4a30250da79b0529c14">operator==()</a>.
</div>
</div><p>
<a class="anchor" name="4daa45157ec8c423f58f4309b143f01d"></a><!-- doxytag: member="ForwardCharacterIterator::operator=" ref="4daa45157ec8c423f58f4309b143f01d" args="(const ForwardCharacterIterator &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a>&amp; ForwardCharacterIterator::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assignment operator to be overridden in the implementing class. 
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000056">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Definition at line <a class="el" href="chariter_8h-source.html#l00184">184</a> of file <a class="el" href="chariter_8h-source.html">chariter.h</a>.
</div>
</div><p>
<a class="anchor" name="992b78b4c510a4a30250da79b0529c14"></a><!-- doxytag: member="ForwardCharacterIterator::operator==" ref="992b78b4c510a4a30250da79b0529c14" args="(const ForwardCharacterIterator &amp;that) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> ForwardCharacterIterator::operator==           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>that</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns true when both iterators refer to the same character in the same character-storage object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>that</em>&nbsp;</td><td>The <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> to be compared for equality </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true when both iterators refer to the same character in the same character-storage object </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000047">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>
Implemented in <a class="el" href="classStringCharacterIterator.html#173bebb9ba6e9d23e1b4e4d529e38eda">StringCharacterIterator</a>, and <a class="el" href="classUCharCharacterIterator.html#46e8eb0cbb0ac9c091fa91f086388f18">UCharCharacterIterator</a>.
<p>
Referenced by <a class="el" href="chariter_8h-source.html#l00681">operator!=()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="chariter_8h-source.html">chariter.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:54 2011 for ICU 3.6 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>