<!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: CEList 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEList Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This object holds a list of CEs generated from a particular <code><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a></code>
<a href="classCEList.html#details">More...</a></p>
<p><code>#include <<a class="el" href="colldata_8h_source.html">colldata.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CEList:</div>
<div class="dyncontent">
<div class="center">
<img src="classCEList.png" usemap="#CEList_map" alt=""/>
<map id="CEList_map" name="CEList_map">
<area href="classUObject.html" title="UObject is the common ICU "boilerplate" class." alt="UObject" shape="rect" coords="0,56,66,80"/>
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,66,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:abf99e598a1d6426ec5338a4f8193ee2e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#abf99e598a1d6426ec5338a4f8193ee2e">CEList</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &string, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:abf99e598a1d6426ec5338a4f8193ee2e"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> object. <a href="#abf99e598a1d6426ec5338a4f8193ee2e">More...</a><br/></td></tr>
<tr class="separator:abf99e598a1d6426ec5338a4f8193ee2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82625296ba6bab84db6083ec0eadeb8a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a82625296ba6bab84db6083ec0eadeb8a">~CEList</a> ()</td></tr>
<tr class="memdesc:a82625296ba6bab84db6083ec0eadeb8a"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#a82625296ba6bab84db6083ec0eadeb8a">More...</a><br/></td></tr>
<tr class="separator:a82625296ba6bab84db6083ec0eadeb8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a022681cd11cf7f561c081f8e352dee"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a9a022681cd11cf7f561c081f8e352dee">size</a> () const </td></tr>
<tr class="memdesc:a9a022681cd11cf7f561c081f8e352dee"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of CEs in the list. <a href="#a9a022681cd11cf7f561c081f8e352dee">More...</a><br/></td></tr>
<tr class="separator:a9a022681cd11cf7f561c081f8e352dee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5798cbcdeabb3a34d6a0776ef714b7a0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a5798cbcdeabb3a34d6a0776ef714b7a0">get</a> (int32_t index) const </td></tr>
<tr class="memdesc:a5798cbcdeabb3a34d6a0776ef714b7a0"><td class="mdescLeft"> </td><td class="mdescRight">Get a particular CE from the list. <a href="#a5798cbcdeabb3a34d6a0776ef714b7a0">More...</a><br/></td></tr>
<tr class="separator:a5798cbcdeabb3a34d6a0776ef714b7a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59d5abd34f52a3382488f1b35214b229"><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="classCEList.html#a59d5abd34f52a3382488f1b35214b229">matchesAt</a> (int32_t offset, const <a class="el" href="classCEList.html">CEList</a> *other) const </td></tr>
<tr class="memdesc:a59d5abd34f52a3382488f1b35214b229"><td class="mdescLeft"> </td><td class="mdescRight">Check if the CEs in another <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> match the suffix of this list starting at a give offset. <a href="#a59d5abd34f52a3382488f1b35214b229">More...</a><br/></td></tr>
<tr class="separator:a59d5abd34f52a3382488f1b35214b229"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a551179fab3d6ebae3caf7dc4852d8b90"><td class="memItemLeft" align="right" valign="top">uint32_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a551179fab3d6ebae3caf7dc4852d8b90">operator[]</a> (int32_t index) const </td></tr>
<tr class="memdesc:a551179fab3d6ebae3caf7dc4852d8b90"><td class="mdescLeft"> </td><td class="mdescRight">The index operator. <a href="#a551179fab3d6ebae3caf7dc4852d8b90">More...</a><br/></td></tr>
<tr class="separator:a551179fab3d6ebae3caf7dc4852d8b90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0eb5c99e6ad284bf637524fabe669cc"><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="classCEList.html#aa0eb5c99e6ad284bf637524fabe669cc">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:aa0eb5c99e6ad284bf637524fabe669cc"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... <a href="#aa0eb5c99e6ad284bf637524fabe669cc">More...</a><br/></td></tr>
<tr class="separator:aa0eb5c99e6ad284bf637524fabe669cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classUObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classUObject.html">UObject</a></td></tr>
<tr class="memitem:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUObject.html#ace22cf29a90641ef43350deae5bedb85">~UObject</a> ()</td></tr>
<tr class="memdesc:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace22cf29a90641ef43350deae5bedb85">More...</a><br/></td></tr>
<tr class="separator:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a09ce636621d595b224df6f5e9adce98f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a09ce636621d595b224df6f5e9adce98f">getStaticClassID</a> ()</td></tr>
<tr class="memdesc:a09ce636621d595b224df6f5e9adce98f"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... <a href="#a09ce636621d595b224df6f5e9adce98f">More...</a><br/></td></tr>
<tr class="separator:a09ce636621d595b224df6f5e9adce98f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This object holds a list of CEs generated from a particular <code><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a></code> </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000297">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
<p>Definition at line <a class="el" href="colldata_8h_source.html#l00067">67</a> of file <a class="el" href="colldata_8h_source.html">colldata.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abf99e598a1d6426ec5338a4f8193ee2e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEList::CEList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>coll</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>string</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>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>- the <a class="el" href="classCollator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> used to collect the CEs. </td></tr>
<tr><td class="paramname">string</td><td>- the string for which to collect the CEs. </td></tr>
<tr><td class="paramname">status</td><td>- will be set if any errors occur.</td></tr>
</table>
</dd>
</dl>
<p>Note: if on return, status is set to an error code, the only safe thing to do with this object is to call the destructor.</p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000300">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a82625296ba6bab84db6083ec0eadeb8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEList::~CEList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000301">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5798cbcdeabb3a34d6a0776ef714b7a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t CEList::get </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>Get a particular CE from the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>- the index of the CE to return</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the CE, or <code>0</code> if <code>index</code> is out of range</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000303">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="aa0eb5c99e6ad284bf637524fabe669cc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CEList::getDynamicClassID </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000306">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
<p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p>
</div>
</div>
<a class="anchor" id="a09ce636621d595b224df6f5e9adce98f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CEList::getStaticClassID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue... </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000307">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a59d5abd34f52a3382488f1b35214b229"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> CEList::matchesAt </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEList.html">CEList</a> * </td>
<td class="paramname"><em>other</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the CEs in another <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code> match the suffix of this list starting at a give offset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>- the offset of the suffix </td></tr>
<tr><td class="paramname">other</td><td>- the other <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString">CEList</a></code></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the CEs match, <code>FALSE</code> otherwise.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000304">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a551179fab3d6ebae3caf7dc4852d8b90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t& CEList::operator[] </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>The index operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>- the index</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the given CE in the list</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000305">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<a class="anchor" id="a9a022681cd11cf7f561c081f8e352dee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t CEList::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of CEs in the list. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of CEs in the list.</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000302">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="colldata_8h_source.html">colldata.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>
