<!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: Format 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 Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </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 List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>Format Class Reference</h1><!-- doxytag: class="Format" --><!-- doxytag: inherits="UObject" -->Base class for all formats.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="format_8h-source.html">format.h</a>></code>
<p>
<p>Inheritance diagram for Format:
<p><center><img src="classFormat.png" usemap="#Format_map" border="0" alt=""></center>
<map name="Format_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="247,56,402,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="247,0,402,24">
<area href="classDateFormat.html" alt="DateFormat" shape="rect" coords="0,168,155,192">
<area href="classMeasureFormat.html" alt="MeasureFormat" shape="rect" coords="165,168,320,192">
<area href="classMessageFormat.html" alt="MessageFormat" shape="rect" coords="330,168,485,192">
<area href="classNumberFormat.html" alt="NumberFormat" shape="rect" coords="495,168,650,192">
<area href="classSimpleDateFormat.html" alt="SimpleDateFormat" shape="rect" coords="0,224,155,248">
<area href="classChoiceFormat.html" alt="ChoiceFormat" shape="rect" coords="330,224,485,248">
<area href="classDecimalFormat.html" alt="DecimalFormat" shape="rect" coords="495,224,650,248">
<area href="classRuleBasedNumberFormat.html" alt="RuleBasedNumberFormat" shape="rect" coords="660,224,815,248">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#bd278bb761016aeb8899eaa8cf467540">~Format</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#bd278bb761016aeb8899eaa8cf467540"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#2a37b4342eacedb2b57ccb5fd4324cd7">operator==</a> (const <a class="el" href="classFormat.html">Format</a> &other) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the given <a class="el" href="classFormat.html">Format</a> objects are semantically equal. <a href="#2a37b4342eacedb2b57ccb5fd4324cd7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#92ddc03910cc04984d5864d1a79fa0de">operator!=</a> (const <a class="el" href="classFormat.html">Format</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the given <a class="el" href="classFormat.html">Format</a> objects are not semantically equal. <a href="#92ddc03910cc04984d5864d1a79fa0de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classFormat.html">Format</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#d1f7b31ff9f05761608d952765271cb7">clone</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this object polymorphically. <a href="#d1f7b31ff9f05761608d952765271cb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#d514448a233129875ddd3bf61dfb1eb3">format</a> (const <a class="el" href="classFormattable.html">Formattable</a> &obj, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats an object to produce a string. <a href="#d514448a233129875ddd3bf61dfb1eb3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#5c78c5fe38b52b1e17f86a5f3468a2c9">format</a> (const <a class="el" href="classFormattable.html">Formattable</a> &obj, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="classFieldPosition.html">FieldPosition</a> &pos, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classFormat.html">Format</a> an object to produce a string. <a href="#5c78c5fe38b52b1e17f86a5f3468a2c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#8aa4a299eaab7ef9ec001913013a218f">parseObject</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="classFormattable.html">Formattable</a> &result, <a class="el" href="classParsePosition.html">ParsePosition</a> &parse_pos) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a string to produce an object. <a href="#8aa4a299eaab7ef9ec001913013a218f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#605449b5a690b45d1aa0f817b2b2b42f">parseObject</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="classFormattable.html">Formattable</a> &result, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string to produce an object. <a href="#605449b5a690b45d1aa0f817b2b2b42f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#531572deb1a394cd2b5756adb1b17244">getDynamicClassID</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#531572deb1a394cd2b5756adb1b17244"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#1b22861204d9502c24b0af367752c91a">getLocale</a> (<a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the locale for this format object. <a href="#1b22861204d9502c24b0af367752c91a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#7329821bcf189d77f756256dd3cfb4ea">getLocaleID</a> (<a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the locale for this format object. <a href="#7329821bcf189d77f756256dd3cfb4ea"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#e25d9a60f1269bc41c8da86d08472fd7">setLocaleIDs</a> (const char *valid, const char *actual)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#f2fe74c75e29dbb875a865add62ddf67">Format</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for subclass use only. <a href="#f2fe74c75e29dbb875a865add62ddf67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#c6919d8bb203427fd9b14450da7dc812">Format</a> (const <a class="el" href="classFormat.html">Format</a> &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFormat.html">Format</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#1b0152138b4e4aa8cdbbffe1645a7a7b">operator=</a> (const <a class="el" href="classFormat.html">Format</a> &)</td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFormat.html#4251a343c60c0c28fb2426597006ced7">syntaxError</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> pos, <a class="el" href="structUParseError.html">UParseError</a> &parseError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simple function for initializing a <a class="el" href="structUParseError.html">UParseError</a> from a <a class="el" href="classUnicodeString.html">UnicodeString</a>. <a href="#4251a343c60c0c28fb2426597006ced7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for all formats.
<p>
This is an abstract base class which specifies the protocol for classes which convert other objects or values, such as numeric values and dates, and their string representations. In some cases these representations may be localized or contain localized characters or strings. For example, a numeric formatter such as <a class="el" href="classDecimalFormat.html">DecimalFormat</a> may convert a numeric value such as 12345 to the string "$12,345". It may also parse the string back into a numeric value. A date and time formatter like <a class="el" href="classSimpleDateFormat.html">SimpleDateFormat</a> may represent a specific date, encoded numerically, as a string such as "Wednesday, February 26, 1997 AD". <p>
Many of the concrete subclasses of <a class="el" href="classFormat.html">Format</a> employ the notion of a pattern. A pattern is a string representation of the rules which govern the interconversion between values and strings. For example, a <a class="el" href="classDecimalFormat.html">DecimalFormat</a> object may be associated with the pattern "$#,##0.00;($#,##0.00)", which is a common US English format for currency values, yielding strings such as "$1,234.45" for 1234.45, and "($987.65)" for 987.6543. The specific syntax of a pattern is defined by each subclass. <p>
Even though many subclasses use patterns, the notion of a pattern is not inherent to <a class="el" href="classFormat.html">Format</a> classes in general, and is not part of the explicit base class protocol. <p>
Two complex formatting classes bear mentioning. These are <a class="el" href="classMessageFormat.html">MessageFormat</a> and <a class="el" href="classChoiceFormat.html">ChoiceFormat</a>. <a class="el" href="classChoiceFormat.html">ChoiceFormat</a> is a subclass of <a class="el" href="classNumberFormat.html">NumberFormat</a> which allows the user to format different number ranges as strings. For instance, 0 may be represented as "no files", 1 as "one file", and any number greater than 1 as "many files". <a class="el" href="classMessageFormat.html">MessageFormat</a> is a formatter which utilizes other <a class="el" href="classFormat.html">Format</a> objects to format a string containing with multiple values. For instance, A <a class="el" href="classMessageFormat.html">MessageFormat</a> object might produce the string "There are no files on the disk MyDisk on February 27, 1997." given the arguments 0, "MyDisk", and the date value of 2/27/97. See the <a class="el" href="classChoiceFormat.html">ChoiceFormat</a> and <a class="el" href="classMessageFormat.html">MessageFormat</a> headers for further information. <p>
If formatting is unsuccessful, a failing UErrorCode is returned when the <a class="el" href="classFormat.html">Format</a> cannot format the type of object, otherwise if there is something illformed about the the Unicode replacement character 0xFFFD is returned. <p>
If there is no match when parsing, a parse failure UErrorCode is retured for methods which take no <a class="el" href="classParsePosition.html">ParsePosition</a>. For the method that takes a <a class="el" href="classParsePosition.html">ParsePosition</a>, the index parameter is left unchanged. <p>
<em>User subclasses are not supported.</em> While clients may write subclasses, such code will not necessarily work and will not be guaranteed to work stably from release to release.
<p>
<p>
Definition at line <a class="el" href="format_8h-source.html#l00093">93</a> of file <a class="el" href="format_8h-source.html">format.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bd278bb761016aeb8899eaa8cf467540"></a><!-- doxytag: member="Format::~Format" ref="bd278bb761016aeb8899eaa8cf467540" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Format::~Format </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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#_stable002223">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f2fe74c75e29dbb875a865add62ddf67"></a><!-- doxytag: member="Format::Format" ref="f2fe74c75e29dbb875a865add62ddf67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Format::Format </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor for subclass use only.
<p>
Does nothing. <dl compact><dt><b><a class="el" href="stable.html#_stable002234">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c6919d8bb203427fd9b14450da7dc812"></a><!-- doxytag: member="Format::Format" ref="c6919d8bb203427fd9b14450da7dc812" args="(const Format &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Format::Format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable002235">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d1f7b31ff9f05761608d952765271cb7"></a><!-- doxytag: member="Format::clone" ref="d1f7b31ff9f05761608d952765271cb7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormat.html">Format</a>* Format::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clone this object polymorphically.
<p>
The caller is responsible for deleting the result when done. <dl compact><dt><b>Returns:</b></dt><dd>A copy of the object </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002226">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classChoiceFormat.html#046ab23e50adc3bd05f8c46db4a27ce7">ChoiceFormat</a>, <a class="el" href="classDecimalFormat.html#56d5e2228f87071f24595010f1f3cfcb">DecimalFormat</a>, <a class="el" href="classMessageFormat.html#0d153b33157d52982a4f94c2df030c3a">MessageFormat</a>, <a class="el" href="classRuleBasedNumberFormat.html#97b613c9c2bb88b349d0beb58b49e3c2">RuleBasedNumberFormat</a>, and <a class="el" href="classSimpleDateFormat.html#3caf11369521f1b3cc29253e2cc83022">SimpleDateFormat</a>.
</div>
</div><p>
<a class="anchor" name="5c78c5fe38b52b1e17f86a5f3468a2c9"></a><!-- doxytag: member="Format::format" ref="5c78c5fe38b52b1e17f86a5f3468a2c9" args="(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a>& Format::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>appendTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFieldPosition.html">FieldPosition</a> & </td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classFormat.html">Format</a> an object to produce a string.
<p>
This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting of <a class="el" href="classFormattable.html">Formattable</a> objects. If a subclass of <a class="el" href="classFormat.html">Format</a> receives a <a class="el" href="classFormattable.html">Formattable</a> object type it doesn't handle (e.g., if a numeric <a class="el" href="classFormattable.html">Formattable</a> is passed to a <a class="el" href="classDateFormat.html">DateFormat</a> object) then it returns a failing UErrorCode.<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>obj</em> </td><td>The object to format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>On input: an alignment field, if desired. On output: the offsets of the alignment field. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param filled with success/failure status. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002228">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classChoiceFormat.html#ae390f08d4ac74c04197991458e57e53">ChoiceFormat</a>, <a class="el" href="classDateFormat.html#2cdaf9d4cdbd85579342e0a9bb626d9f">DateFormat</a>, <a class="el" href="classDecimalFormat.html#df3a8a7c39db037aeadc73b48c35f319">DecimalFormat</a>, <a class="el" href="classMessageFormat.html#918a068762b541b98d50cd8492f66986">MessageFormat</a>, <a class="el" href="classNumberFormat.html#97db190ac73ca8859fd5ff8936596bae">NumberFormat</a>, <a class="el" href="classRuleBasedNumberFormat.html#60f4f8edd32318c744131efa8171e17c">RuleBasedNumberFormat</a>, and <a class="el" href="classSimpleDateFormat.html#fd077da661fbe18d143d005061d6be75">SimpleDateFormat</a>.
</div>
</div><p>
<a class="anchor" name="d514448a233129875ddd3bf61dfb1eb3"></a><!-- doxytag: member="Format::format" ref="d514448a233129875ddd3bf61dfb1eb3" args="(const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& Format::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>appendTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Formats an object to produce a string.
<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>obj</em> </td><td>The object to format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output parameter filled in with success or failure status. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002227">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented in <a class="el" href="classChoiceFormat.html#fcb32c178c4c9f35e942bc44612cc55a">ChoiceFormat</a>, <a class="el" href="classDateFormat.html#bdc523bac6937ec76f35ca9227608f30">DateFormat</a>, <a class="el" href="classDecimalFormat.html#b854e609ee0d2224bf2f27e0419fd241">DecimalFormat</a>, <a class="el" href="classMessageFormat.html#865b5cfbbdda6fd00ed1595ed7f60058">MessageFormat</a>, <a class="el" href="classNumberFormat.html#189804c12e53aee4626e84ce137f7ee2">NumberFormat</a>, <a class="el" href="classRuleBasedNumberFormat.html#7bb949761e075040eee2cbb1dccbb80f">RuleBasedNumberFormat</a>, and <a class="el" href="classSimpleDateFormat.html#dd1821acbd30136ab8c8b254345df794">SimpleDateFormat</a>.
<p>
Referenced by <a class="el" href="numfmt_8h-source.html#l00850">NumberFormat::format()</a>, <a class="el" href="msgfmt_8h-source.html#l00818">MessageFormat::format()</a>, and <a class="el" href="datefmt_8h-source.html#l00649">DateFormat::format()</a>.
</div>
</div><p>
<a class="anchor" name="531572deb1a394cd2b5756adb1b17244"></a><!-- doxytag: member="Format::getDynamicClassID" ref="531572deb1a394cd2b5756adb1b17244" args="() 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> Format::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a unique class ID POLYMORPHICALLY.
<p>
Pure virtual method. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="classFormat.html#2a37b4342eacedb2b57ccb5fd4324cd7">operator==()</a> and <a class="el" href="classFormat.html#d1f7b31ff9f05761608d952765271cb7">clone()</a> methods call this method. Concrete subclasses of <a class="el" href="classFormat.html">Format</a> must implement <a class="el" href="classFormat.html#531572deb1a394cd2b5756adb1b17244">getDynamicClassID()</a><p>
<dl compact><dt><b>Returns:</b></dt><dd>The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002231">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="classChoiceFormat.html#d11fd1b5136038d69c9aebe10acd8efe">ChoiceFormat</a>, <a class="el" href="classDecimalFormat.html#22a442e65e01ee12a59c0e2b7311c71e">DecimalFormat</a>, <a class="el" href="classMessageFormat.html#e424d2b7d5dd633c1b4cf779a6c5b151">MessageFormat</a>, <a class="el" href="classNumberFormat.html#1325b42e1edb0f41182ce126d11b8d53">NumberFormat</a>, <a class="el" href="classRuleBasedNumberFormat.html#c3b4983c02ee1fb7edaa16a9fdaf5b50">RuleBasedNumberFormat</a>, and <a class="el" href="classSimpleDateFormat.html#206318db6243ec1d3e9d333fa390ea1e">SimpleDateFormat</a>.
</div>
</div><p>
<a class="anchor" name="1b22861204d9502c24b0af367752c91a"></a><!-- doxytag: member="Format::getLocale" ref="1b22861204d9502c24b0af367752c91a" args="(ULocDataLocaleType type, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classLocale.html">Locale</a> Format::getLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the locale for this format object.
<p>
You can choose between valid and actual locale. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of the locale we're looking for (valid or actual) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code for the operation </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the locale </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002232">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7329821bcf189d77f756256dd3cfb4ea"></a><!-- doxytag: member="Format::getLocaleID" ref="7329821bcf189d77f756256dd3cfb4ea" args="(ULocDataLocaleType type, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Format::getLocaleID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the locale for this format object.
<p>
You can choose between valid and actual locale. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of the locale we're looking for (valid or actual) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code for the operation </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the locale </dd></dl>
<dl compact><dt><b><a class="el" href="internal.html#_internal000142">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<a class="anchor" name="92ddc03910cc04984d5864d1a79fa0de"></a><!-- doxytag: member="Format::operator!=" ref="92ddc03910cc04984d5864d1a79fa0de" args="(const Format &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> Format::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if the given <a class="el" href="classFormat.html">Format</a> objects are not semantically equal.
<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>other</em> </td><td>the object to be compared with. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Return true if the given <a class="el" href="classFormat.html">Format</a> objects are not semantically. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002225">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="format_8h-source.html#l00118">118</a> of file <a class="el" href="format_8h-source.html">format.h</a>.
</div>
</div><p>
<a class="anchor" name="1b0152138b4e4aa8cdbbffe1645a7a7b"></a><!-- doxytag: member="Format::operator=" ref="1b0152138b4e4aa8cdbbffe1645a7a7b" args="(const Format &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFormat.html">Format</a>& Format::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable002236">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2a37b4342eacedb2b57ccb5fd4324cd7"></a><!-- doxytag: member="Format::operator==" ref="2a37b4342eacedb2b57ccb5fd4324cd7" args="(const Format &other) 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> Format::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if the given <a class="el" href="classFormat.html">Format</a> objects are semantically equal.
<p>
Objects of different subclasses are considered unequal. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>the object to be compared with. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Return true if the given <a class="el" href="classFormat.html">Format</a> objects are semantically equal. Objects of different subclasses are considered unequal. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002224">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classChoiceFormat.html#8698468f3473b3d5c885dfcf084899c7">ChoiceFormat</a>, <a class="el" href="classDateFormat.html#64cb2a535789dfda890e8f176821c70f">DateFormat</a>, <a class="el" href="classDecimalFormat.html#86550a3cd515013175b450f4237350a3">DecimalFormat</a>, <a class="el" href="classMessageFormat.html#a7c44cac7a7984e85f0bf571b1468e4b">MessageFormat</a>, <a class="el" href="classNumberFormat.html#3d78cbace4d4d6c478763bb75b5f1733">NumberFormat</a>, <a class="el" href="classRuleBasedNumberFormat.html#849e2438f90a8b30698ad469e27c9029">RuleBasedNumberFormat</a>, and <a class="el" href="classSimpleDateFormat.html#95e798259fc97d040d36ff5d2508ccc5">SimpleDateFormat</a>.
</div>
</div><p>
<a class="anchor" name="605449b5a690b45d1aa0f817b2b2b42f"></a><!-- doxytag: member="Format::parseObject" ref="605449b5a690b45d1aa0f817b2b2b42f" args="(const UnicodeString &source, Formattable &result, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Format::parseObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string to produce an object.
<p>
This is a convenience method which calls the pure virtual <a class="el" href="classFormat.html#8aa4a299eaab7ef9ec001913013a218f">parseObject()</a> method, and returns a failure UErrorCode if the <a class="el" href="classParsePosition.html">ParsePosition</a> indicates failure.<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>source</em> </td><td>The string to be parsed into an object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td><a class="el" href="classFormattable.html">Formattable</a> to be set to the parse result. If parse fails, return contents are undefined. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Output param to be filled with success/failure result code. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002230">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8aa4a299eaab7ef9ec001913013a218f"></a><!-- doxytag: member="Format::parseObject" ref="8aa4a299eaab7ef9ec001913013a218f" args="(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Format::parseObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classParsePosition.html">ParsePosition</a> & </td>
<td class="paramname"> <em>parse_pos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse a string to produce an object.
<p>
This is a pure virtual method which subclasses must implement. This method allows polymorphic parsing of strings into <a class="el" href="classFormattable.html">Formattable</a> objects. <p>
Before calling, set parse_pos.index to the offset you want to start parsing at in the source. After calling, parse_pos.index is the end of the text you parsed. If error occurs, index is unchanged. <p>
When parsing, leading whitespace is discarded (with successful parse), while trailing whitespace is left as is. <p>
Example: <p>
Parsing "_12_xy" (where _ represents a space) for a number, with index == 0 will result in the number 12, with parse_pos.index updated to 3 (just before the second space). Parsing a second time will result in a failing UErrorCode since "xy" is not a number, and leave index at 3. <p>
Subclasses will typically supply specific parse methods that return different types of values. Since methods can't overload on return types, these will typically be named "parse", while this polymorphic method will always be called parseObject. Any parse method that does not take a parse_pos should set status to an error value when no text in the required format is at the start position.<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>source</em> </td><td>The string to be parsed into an object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td><a class="el" href="classFormattable.html">Formattable</a> to be set to the parse result. If parse fails, return contents are undefined. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parse_pos</em> </td><td>The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002229">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classDateFormat.html#2d93ac9554a7a44df283e6fbc05e03f6">DateFormat</a>, <a class="el" href="classMessageFormat.html#67b8e6cd82e9c22fb4043d19e00e783e">MessageFormat</a>, and <a class="el" href="classNumberFormat.html#8ee11ff88cace1b0a24161b80fe2bd79">NumberFormat</a>.
</div>
</div><p>
<a class="anchor" name="e25d9a60f1269bc41c8da86d08472fd7"></a><!-- doxytag: member="Format::setLocaleIDs" ref="e25d9a60f1269bc41c8da86d08472fd7" args="(const char *valid, const char *actual)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Format::setLocaleIDs </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>valid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>actual</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable002233">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4251a343c60c0c28fb2426597006ced7"></a><!-- doxytag: member="Format::syntaxError" ref="4251a343c60c0c28fb2426597006ced7" args="(const UnicodeString &pattern, int32_t pos, UParseError &parseError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Format::syntaxError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> & </td>
<td class="paramname"> <em>parseError</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Simple function for initializing a <a class="el" href="structUParseError.html">UParseError</a> from a <a class="el" href="classUnicodeString.html">UnicodeString</a>.
<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>pattern</em> </td><td>The pattern to copy into the parseError </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>The position in pattern where the error occured </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseError</em> </td><td>The <a class="el" href="structUParseError.html">UParseError</a> object to fill in </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002237">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="format_8h-source.html">format.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
<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>
