<!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.11"/>
<title>ICU 58.2: icu::AlphabeticIndex::ImmutableIndex 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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><a href="namespaces.html"><span>Namespaces</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="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1AlphabeticIndex.html">AlphabeticIndex</a></li><li class="navelem"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html">ImmutableIndex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">icu::AlphabeticIndex::ImmutableIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Immutable, thread-safe version of <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language. ">AlphabeticIndex</a>.
<a href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::AlphabeticIndex::ImmutableIndex:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.png" usemap="#icu::AlphabeticIndex::ImmutableIndex_map" alt=""/>
<map id="icu::AlphabeticIndex::ImmutableIndex_map" name="icu::AlphabeticIndex::ImmutableIndex_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,216,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,216,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:ad3fd7f262b2736b210a256d3aeb4a366"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#ad3fd7f262b2736b210a256d3aeb4a366">~ImmutableIndex</a> ()</td></tr>
<tr class="memdesc:ad3fd7f262b2736b210a256d3aeb4a366"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad3fd7f262b2736b210a256d3aeb4a366">More...</a><br /></td></tr>
<tr class="separator:ad3fd7f262b2736b210a256d3aeb4a366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4a5ad3e347822f794c9b68489760f68"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#ae4a5ad3e347822f794c9b68489760f68">getBucketCount</a> () const </td></tr>
<tr class="memdesc:ae4a5ad3e347822f794c9b68489760f68"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of index buckets and labels, including underflow/inflow/overflow. <a href="#ae4a5ad3e347822f794c9b68489760f68">More...</a><br /></td></tr>
<tr class="separator:ae4a5ad3e347822f794c9b68489760f68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a883404c0b735733188fb80179829f053"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#a883404c0b735733188fb80179829f053">getBucketIndex</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr>
<tr class="memdesc:a883404c0b735733188fb80179829f053"><td class="mdescLeft"> </td><td class="mdescRight">Finds the index bucket for the given name and returns the number of that bucket. <a href="#a883404c0b735733188fb80179829f053">More...</a><br /></td></tr>
<tr class="separator:a883404c0b735733188fb80179829f053"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1b8cdc78ce5bcef27ef03d8b64a86cf"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html">Bucket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#aa1b8cdc78ce5bcef27ef03d8b64a86cf">getBucket</a> (int32_t index) const </td></tr>
<tr class="memdesc:aa1b8cdc78ce5bcef27ef03d8b64a86cf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index-th bucket. <a href="#aa1b8cdc78ce5bcef27ef03d8b64a86cf">More...</a><br /></td></tr>
<tr class="separator:aa1b8cdc78ce5bcef27ef03d8b64a86cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. <a href="#a1aa93096e880907080b503ff1fb0f8bc">More...</a><br /></td></tr>
<tr class="separator:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ad489d5aaa97ddbea1f8e51a956eafb19"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad489d5aaa97ddbea1f8e51a956eafb19"></a>
class </td><td class="memItemRight" valign="bottom"><b>AlphabeticIndex</b></td></tr>
<tr class="separator:ad489d5aaa97ddbea1f8e51a956eafb19"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Immutable, thread-safe version of <a class="el" href="classicu_1_1AlphabeticIndex.html" title="AlphabeticIndex supports the creation of a UI index appropriate for a given language. ">AlphabeticIndex</a>. </p>
<p>This class provides thread-safe methods for bucketing, and random access to buckets and their properties, but does not offer adding records to the index.</p>
<p>The <a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html" title="Immutable, thread-safe version of AlphabeticIndex. ">ImmutableIndex</a> class is not intended for public subclassing.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003025">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
<p>Definition at line <a class="el" href="alphaindex_8h_source.html#l00247">247</a> of file <a class="el" href="alphaindex_8h_source.html">alphaindex.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad3fd7f262b2736b210a256d3aeb4a366"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::AlphabeticIndex::ImmutableIndex::~ImmutableIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003059">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa1b8cdc78ce5bcef27ef03d8b64a86cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1AlphabeticIndex_1_1Bucket.html">Bucket</a>* icu::AlphabeticIndex::ImmutableIndex::getBucket </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the index-th bucket. </p>
<p>Returns NULL if the index is out of range.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>bucket number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the index-th bucket </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003062">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="ae4a5ad3e347822f794c9b68489760f68"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t icu::AlphabeticIndex::ImmutableIndex::getBucketCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of index buckets and labels, including underflow/inflow/overflow. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of index buckets </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003060">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a883404c0b735733188fb80179829f053"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t icu::AlphabeticIndex::ImmutableIndex::getBucketIndex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</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> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the index bucket for the given name and returns the number of that bucket. </p>
<p>Use <a class="el" href="classicu_1_1AlphabeticIndex_1_1ImmutableIndex.html#aa1b8cdc78ce5bcef27ef03d8b64a86cf" title="Returns the index-th bucket. ">getBucket()</a> to get the bucket's properties.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the string to be sorted into an index bucket </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the bucket number for the name </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003061">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="alphaindex_8h_source.html">alphaindex.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.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
345
