<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>ICU 49.1.1: BytesTrie::Iterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 49.1.1
 <span id="projectnumber">49.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classBytesTrie.html">BytesTrie</a></li><li class="navelem"><a class="el" href="classBytesTrie_1_1Iterator.html">Iterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">BytesTrie::Iterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classBytesTrie_1_1Iterator.html" title="Iterator for all of the (byte sequence, value) pairs in a BytesTrie.">Iterator</a> for all of the (byte sequence, value) pairs in a <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>.
<a href="classBytesTrie_1_1Iterator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="bytestrie_8h_source.html">bytestrie.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for BytesTrie::Iterator:</div>
<div class="dyncontent">
<div class="center">
<img src="classBytesTrie_1_1Iterator.png" usemap="#BytesTrie::Iterator_map" alt=""/>
<map id="BytesTrie::Iterator_map" name="BytesTrie::Iterator_map">
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,111,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7d82a0e59ec7bc14f82185a2e9e95df0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a7d82a0e59ec7bc14f82185a2e9e95df0">Iterator</a> (const void *trieBytes, int32_t maxStringLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a7d82a0e59ec7bc14f82185a2e9e95df0"><td class="mdescLeft"> </td><td class="mdescRight">Iterates from the root of a byte-serialized <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>. <a href="#a7d82a0e59ec7bc14f82185a2e9e95df0">More...</a><br/></td></tr>
<tr class="separator:a7d82a0e59ec7bc14f82185a2e9e95df0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a294e5c15e44a508fe20c2c4281e8fe94"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a294e5c15e44a508fe20c2c4281e8fe94">Iterator</a> (const <a class="el" href="classBytesTrie.html">BytesTrie</a> &trie, int32_t maxStringLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a294e5c15e44a508fe20c2c4281e8fe94"><td class="mdescLeft"> </td><td class="mdescRight">Iterates from the current state of the specified <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>. <a href="#a294e5c15e44a508fe20c2c4281e8fe94">More...</a><br/></td></tr>
<tr class="separator:a294e5c15e44a508fe20c2c4281e8fe94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa40e057a5089e80b130ebc0345d5fb08"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#aa40e057a5089e80b130ebc0345d5fb08">~Iterator</a> ()</td></tr>
<tr class="memdesc:aa40e057a5089e80b130ebc0345d5fb08"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa40e057a5089e80b130ebc0345d5fb08">More...</a><br/></td></tr>
<tr class="separator:aa40e057a5089e80b130ebc0345d5fb08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a650b3a021e32c0504db13a598d988006"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBytesTrie_1_1Iterator.html">Iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a650b3a021e32c0504db13a598d988006">reset</a> ()</td></tr>
<tr class="memdesc:a650b3a021e32c0504db13a598d988006"><td class="mdescLeft"> </td><td class="mdescRight">Resets this iterator to its initial state. <a href="#a650b3a021e32c0504db13a598d988006">More...</a><br/></td></tr>
<tr class="separator:a650b3a021e32c0504db13a598d988006"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6aa7d10342377ed3a62e3cc1ba17c6a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a6aa7d10342377ed3a62e3cc1ba17c6a4">hasNext</a> () const </td></tr>
<tr class="separator:a6aa7d10342377ed3a62e3cc1ba17c6a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a884233b34ad474ad69b78a72ed9203f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a884233b34ad474ad69b78a72ed9203f0">next</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a884233b34ad474ad69b78a72ed9203f0"><td class="mdescLeft"> </td><td class="mdescRight">Finds the next (byte sequence, value) pair if there is one. <a href="#a884233b34ad474ad69b78a72ed9203f0">More...</a><br/></td></tr>
<tr class="separator:a884233b34ad474ad69b78a72ed9203f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24e4776e8691e864529cfaa4bb62faa2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringPiece.html">StringPiece</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#a24e4776e8691e864529cfaa4bb62faa2">getString</a> () const </td></tr>
<tr class="separator:a24e4776e8691e864529cfaa4bb62faa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad04949c38712acbdbe0bac3f3a7abca6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classBytesTrie_1_1Iterator.html#ad04949c38712acbdbe0bac3f3a7abca6">getValue</a> () const </td></tr>
<tr class="separator:ad04949c38712acbdbe0bac3f3a7abca6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classBytesTrie_1_1Iterator.html" title="Iterator for all of the (byte sequence, value) pairs in a BytesTrie.">Iterator</a> for all of the (byte sequence, value) pairs in a <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000089">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="bytestrie_8h_source.html#l00242">242</a> of file <a class="el" href="bytestrie_8h_source.html">bytestrie.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7d82a0e59ec7bc14f82185a2e9e95df0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BytesTrie::Iterator::Iterator </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>trieBytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>maxStringLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates from the root of a byte-serialized <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trieBytes</td><td>The trie bytes. </td></tr>
<tr><td class="paramname">maxStringLength</td><td>If 0, the iterator returns full strings/byte sequences. Otherwise, the iterator returns strings with this maximum length. </td></tr>
<tr><td class="paramname">errorCode</td><td>Standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000091">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a294e5c15e44a508fe20c2c4281e8fe94"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BytesTrie::Iterator::Iterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBytesTrie.html">BytesTrie</a> & </td>
<td class="paramname"><em>trie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>maxStringLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates from the current state of the specified <a class="el" href="classBytesTrie.html" title="Light-weight, non-const reader class for a BytesTrie.">BytesTrie</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>The trie whose state will be copied for iteration. </td></tr>
<tr><td class="paramname">maxStringLength</td><td>If 0, the iterator returns full strings/byte sequences. Otherwise, the iterator returns strings with this maximum length. </td></tr>
<tr><td class="paramname">errorCode</td><td>Standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000092">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="aa40e057a5089e80b130ebc0345d5fb08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BytesTrie::Iterator::~Iterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000093">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a24e4776e8691e864529cfaa4bb62faa2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringPiece.html">StringPiece</a>& BytesTrie::Iterator::getString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The NUL-terminated byte sequence for the last successful <a class="el" href="classBytesTrie_1_1Iterator.html#a884233b34ad474ad69b78a72ed9203f0" title="Finds the next (byte sequence, value) pair if there is one.">next()</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000097">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="bytestrie_8h_source.html#l00309">309</a> of file <a class="el" href="bytestrie_8h_source.html">bytestrie.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad04949c38712acbdbe0bac3f3a7abca6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t BytesTrie::Iterator::getValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The value for the last successful <a class="el" href="classBytesTrie_1_1Iterator.html#a884233b34ad474ad69b78a72ed9203f0" title="Finds the next (byte sequence, value) pair if there is one.">next()</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000098">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="bytestrie_8h_source.html#l00314">314</a> of file <a class="el" href="bytestrie_8h_source.html">bytestrie.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6aa7d10342377ed3a62e3cc1ba17c6a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> BytesTrie::Iterator::hasNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>TRUE if there are more elements. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000095">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a884233b34ad474ad69b78a72ed9203f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> BytesTrie::Iterator::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the next (byte sequence, value) pair if there is one. </p>
<p>If the byte sequence is truncated to the maximum length and does not have a real value, then the value is set to -1. In this case, this "not a real value" is indistinguishable from a real value of -1. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">errorCode</td><td>Standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success?">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if there is another element. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000096">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a650b3a021e32c0504db13a598d988006"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBytesTrie_1_1Iterator.html">Iterator</a>& BytesTrie::Iterator::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets this iterator to its initial state. </p>
<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000094">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bytestrie_8h_source.html">bytestrie.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
