<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: DateIntervalFormat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>DateIntervalFormat Class Reference</h1><!-- doxytag: class="DateIntervalFormat" --><!-- doxytag: inherits="Format" -->
<p><a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> is a class for formatting and parsing date intervals in a language-independent manner.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="dtitvfmt_8h_source.html">dtitvfmt.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for DateIntervalFormat:</div>
<div class="dynsection">
<div class="center">
<img src="classDateIntervalFormat.gif" usemap="#DateIntervalFormat_map" alt=""/>
<map id="DateIntervalFormat_map" name="DateIntervalFormat_map">
<area href="classFormat.html" alt="Format" shape="rect" coords="0,112,119,136"/>
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,119,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,119,24"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>PatternInfo</b></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#aaaed5ba68951e3f5ae353a229f154bee">~DateIntervalFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aaaed5ba68951e3f5ae353a229f154bee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFormat.html">Format</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#af9a584ad22ff3673323b26923f8c39b4">clone</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object polymorphically. <a href="#af9a584ad22ff3673323b26923f8c39b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#adb057520899e7e878c54152f990c6b28">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" title="Base class for all formats.">Format</a> objects are semantically equal. <a href="#adb057520899e7e878c54152f990c6b28"></a><br/></td></tr>
<tr><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="classDateIntervalFormat.html#ae1cd1ea9874e3da1d8e7c417850360ad">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" title="Base class for all formats.">Format</a> objects are not semantically equal. <a href="#ae1cd1ea9874e3da1d8e7c417850360ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#ad5163151a343dac64ad66c5680332ea3">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> &fieldPosition, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> an object to produce a string. <a href="#ad5163151a343dac64ad66c5680332ea3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a53179e87d3552d5f9f7802896a437947">format</a> (const <a class="el" href="classDateInterval.html">DateInterval</a> *dtInterval, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="classFieldPosition.html">FieldPosition</a> &fieldPosition, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> to produce a string. <a href="#a53179e87d3552d5f9f7802896a437947"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#aaa08ad2bb46063a00f5b41500617a40d">format</a> (<a class="el" href="classCalendar.html">Calendar</a> &fromCalendar, <a class="el" href="classCalendar.html">Calendar</a> &toCalendar, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="classFieldPosition.html">FieldPosition</a> &fieldPosition, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> 2 Calendars to produce a string. <a href="#aaa08ad2bb46063a00f5b41500617a40d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a30cd01f77584059579d72912df3e2bea">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 </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Date interval parsing is not supported. <a href="#a30cd01f77584059579d72912df3e2bea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a7508e46babb623d1383c8f85f09f1bb0">getDateIntervalInfo</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the date time interval patterns. <a href="#a7508e46babb623d1383c8f85f09f1bb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#af90019c51abd9d92960dbe90043697b2">setDateIntervalInfo</a> (const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> &newIntervalPatterns, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the date time interval patterns. <a href="#af90019c51abd9d92960dbe90043697b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classDateFormat.html">DateFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#acd674a6d5214ef0e7507637b5f8f9c89">getDateFormat</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the date formatter. <a href="#acd674a6d5214ef0e7507637b5f8f9c89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a476faa13a44ff11411beaeb69158dd68">getDynamicClassID</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#a476faa13a44ff11411beaeb69158dd68"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#adc7c2da7b2f5e29fb6b4e9caf8f33318">createInstance</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton and the default locale. <a href="#adc7c2da7b2f5e29fb6b4e9caf8f33318"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#aeef98399b07aaceacd7fd58ee33171c5">createInstance</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton and a given locale. <a href="#aeef98399b07aaceacd7fd58ee33171c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a135df7221deb0e857f1c6d3b66ce7ef5">createInstance</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> &dtitvinf, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>, and default locale. <a href="#a135df7221deb0e857f1c6d3b66ce7ef5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#aa30507d97f93eb89008c5c907f6ccf27">createInstance</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &skeleton, const <a class="el" href="classLocale.html">Locale</a> &locale, const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> &dtitvinf, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton a <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>, and the given locale. <a href="#aa30507d97f93eb89008c5c907f6ccf27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#ad2e287b02ed2899a3dd28d6d1414a352">getStaticClassID</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the class ID for this class. <a href="#ad2e287b02ed2899a3dd28d6d1414a352"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#afed49bfd80382ac4269241c89aa522d8">DateIntervalFormat</a> (const <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#afed49bfd80382ac4269241c89aa522d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classDateIntervalFormat.html#a65a1f1d51dd4d5ac269050b220033ea5">operator=</a> (const <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a65a1f1d51dd4d5ac269050b220033ea5"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> is a class for formatting and parsing date intervals in a language-independent manner. </p>
<p>Date interval formatting is supported in Gregorian calendar only. And only formatting is supported. Parsing is not supported.</p>
<p>Date interval means from one date to another date, for example, from "Jan 11, 2008" to "Jan 18, 2008". We introduced class <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> to represent it. <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> is a pair of UDate, which is the standard milliseconds since 24:00 GMT, Jan 1, 1970.</p>
<p><a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> formats a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> into text as compactly as possible. For example, the date interval format from "Jan 11, 2008" to "Jan 18,. 2008" is "Jan 11-18, 2008" for English. And it parses text into <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a>, although initially, parsing is not supported.</p>
<p>There is no structural information in date time patterns. For any punctuations and string literals inside a date time pattern, we do not know whether it is just a separator, or a prefix, or a suffix. Without such information, so, it is difficult to generate a sub-pattern (or super-pattern) by algorithm. So, formatting a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> is pattern-driven. It is very similar to formatting in <a class="el" href="classSimpleDateFormat.html" title="SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent...">SimpleDateFormat</a>. We introduce class <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> to save date interval patterns, similar to date time pattern in <a class="el" href="classSimpleDateFormat.html" title="SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent...">SimpleDateFormat</a>.</p>
<p>Logically, the interval patterns are mappings from (skeleton, the_largest_different_calendar_field) to (date_interval_pattern).</p>
<p>A skeleton </p>
<ol>
<li>
only keeps the field pattern letter and ignores all other parts in a pattern, such as space, punctuations, and string literals. </li>
<li>
hides the order of fields. </li>
<li>
might hide a field's pattern letter length. </li>
</ol>
<p>For those non-digit calendar fields, the pattern letter length is important, such as MMM, MMMM, and MMMMM; EEE and EEEE, and the field's pattern letter length is honored.</p>
<p>For the digit calendar fields, such as M or MM, d or dd, yy or yyyy, the field pattern length is ignored and the best match, which is defined in date time patterns, will be returned without honor the field pattern letter length in skeleton.</p>
<p>The calendar fields we support for interval formatting are: year, month, date, day-of-week, am-pm, hour, hour-of-day, and minute. Those calendar fields can be defined in the following order: year > month > date > hour (in day) > minute</p>
<p>The largest different calendar fields between 2 calendars is the first different calendar field in above order.</p>
<p>For example: the largest different calendar fields between "Jan 10, 2007" and "Feb 20, 2008" is year.</p>
<p>For other calendar fields, the compact interval formatting is not supported. And the interval format will be fall back to fall-back patterns, which is mostly "{date0} - {date1}".</p>
<p>There is a set of pre-defined static skeleton strings. There are pre-defined interval patterns for those pre-defined skeletons in locales' resource files. For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is "yMMMd", in en_US, if the largest different calendar field between date1 and date2 is "year", the date interval pattern is "MMM d, yyyy - MMM d, yyyy", such as "Jan 10, 2007 - Jan 10, 2008". If the largest different calendar field between date1 and date2 is "month", the date interval pattern is "MMM d - MMM d, yyyy", such as "Jan 10 - Feb 10, 2007". If the largest different calendar field between date1 and date2 is "day", the date interval pattern is "MMM d-d, yyyy", such as "Jan 10-20, 2007".</p>
<p>For date skeleton, the interval patterns when year, or month, or date is different are defined in resource files. For time skeleton, the interval patterns when am/pm, or hour, or minute is different are defined in resource files.</p>
<p>If a skeleton is not found in a locale's <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>, which means the interval patterns for the skeleton is not defined in resource file, the interval pattern will falls back to the interval "fallback" pattern defined in resource file. If the interval "fallback" pattern is not defined, the default fall-back is "{date0} - {data1}".</p>
<p>For the combination of date and time, The rule to generate interval patterns are: </p>
<ol>
<li>
when the year, month, or day differs, falls back to fall-back interval pattern, which mostly is the concatenate the two original expressions with a separator between, For example, interval pattern from "Jan 10, 2007 10:10 am" to "Jan 11, 2007 10:10am" is "Jan 10, 2007 10:10 am - Jan 11, 2007 10:10am" </li>
<li>
otherwise, present the date followed by the range expression for the time. For example, interval pattern from "Jan 10, 2007 10:10 am" to "Jan 10, 2007 11:10am" is "Jan 10, 2007 10:10 am - 11:10am" </li>
</ol>
<p>If two dates are the same, the interval pattern is the single date pattern. For example, interval pattern from "Jan 10, 2007" to "Jan 10, 2007" is "Jan 10, 2007".</p>
<p>Or if the presenting fields between 2 dates have the exact same values, the interval pattern is the single date pattern. For example, if user only requests year and month, the interval pattern from "Jan 10, 2007" to "Jan 20, 2007" is "Jan 2007".</p>
<p><a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> needs the following information for correct formatting: time zone, calendar type, pattern, date format symbols, and date interval patterns. It can be instantiated in 2 ways: </p>
<ol>
<li>
create an instance using default or given locale plus given skeleton. Users are encouraged to created date interval formatter this way and to use the pre-defined skeleton macros, such as UDAT_YEAR_NUM_MONTH, which consists the calendar fields and the format style. </li>
<li>
create an instance using default or given locale plus given skeleton plus a given <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>. This factory method is for powerful users who want to provide their own interval patterns. <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> provides the timezone, calendar, and format symbols information. Local plus skeleton provides full pattern information. <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> provides the date interval patterns. </li>
</ol>
<p>For the calendar field pattern letter, such as G, y, M, d, a, h, H, m, s etc. <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> uses the same syntax as that of DateTime format.</p>
<p>Code Sample: general usage </p>
<pre>
<div class="fragment"><pre class="fragment"> <span class="comment">// the date interval object which the DateIntervalFormat formats on</span>
<span class="comment">// and parses into</span>
<a class="code" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a>* dtInterval = <span class="keyword">new</span> <a class="code" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a>(1000*3600*24, 1000*3600*24*2);
<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> status = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9" title="No error, no warning.">U_ZERO_ERROR</a>;
<a class="code" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a>* dtIntervalFmt = <a class="code" href="classDateIntervalFormat.html#adc7c2da7b2f5e29fb6b4e9caf8f33318" title="Construct a DateIntervalFormat from skeleton and the default locale.">DateIntervalFormat::createInstance</a>(
<a class="code" href="udat_8h.html#a8ed9ca005c11076b7bba60d01c22d80c" title="Below are a set of pre-defined skeletons.">UDAT_YEAR_MONTH_DAY</a>,
<a class="code" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a>(<span class="stringliteral">"en"</span>, <span class="stringliteral">"GB"</span>, <span class="stringliteral">""</span>), status);
UnicodeUnicodeString dateIntervalString;
<a class="code" href="classFieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields...">FieldPosition</a> pos = 0;
<span class="comment">// formatting</span>
dtIntervalFmt-><a class="code" href="classDateIntervalFormat.html#ad5163151a343dac64ad66c5680332ea3" title="Format an object to produce a string.">format</a>(dtInterval, dateIntervalUnicodeString, pos, status);
<span class="keyword">delete</span> dtIntervalFmt;
</pre></div>
</pre>
<p>Definition at line <a class="el" href="dtitvfmt_8h_source.html#l00219">219</a> of file <a class="el" href="dtitvfmt_8h_source.html">dtitvfmt.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aaaed5ba68951e3f5ae353a229f154bee"></a><!-- doxytag: member="DateIntervalFormat::~DateIntervalFormat" ref="aaaed5ba68951e3f5ae353a229f154bee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DateIntervalFormat::~DateIntervalFormat </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002548">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="afed49bfd80382ac4269241c89aa522d8"></a><!-- doxytag: member="DateIntervalFormat::DateIntervalFormat" ref="afed49bfd80382ac4269241c89aa522d8" args="(const DateIntervalFormat &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DateIntervalFormat::DateIntervalFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002560">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af9a584ad22ff3673323b26923f8c39b4"></a><!-- doxytag: member="DateIntervalFormat::clone" ref="af9a584ad22ff3673323b26923f8c39b4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormat.html">Format</a>* DateIntervalFormat::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clone this <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object polymorphically. </p>
<p>The caller owns the result and should delete it when done. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A copy of the object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002549">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#a4e7ebd5cfd390c35e2bda88257f8b51a">Format</a>.</p>
</div>
</div>
<a class="anchor" id="aa30507d97f93eb89008c5c907f6ccf27"></a><!-- doxytag: member="DateIntervalFormat::createInstance" ref="aa30507d97f93eb89008c5c907f6ccf27" args="(const UnicodeString &skeleton, const Locale &locale, const DateIntervalInfo &dtitvinf, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a>* DateIntervalFormat::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> & </td>
<td class="paramname"> <em>dtitvinf</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton a <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>, and the given locale. </p>
<p>In this factory method, user provides its own date interval pattern information, instead of using those pre-defined data in resource file. This factory method is for powerful users who want to provide their own interval patterns. </p>
<p>There are pre-defined skeletons (defined in udate.h) having predefined interval patterns in resource files. Users are encouraged to use those macros. For example: DateIntervalFormat::createInstance(UDAT_MONTH_DAY, status)</p>
<p>The <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> provides the interval patterns. and the <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> ownership remains to the caller.</p>
<p>User are encouraged to set default interval pattern in <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> as well, if they want to set other interval patterns ( instead of reading the interval patterns from resource files). When the corresponding interval pattern for a largest calendar different field is not found ( if user not set it ), interval format fallback to the default interval pattern. If user does not provide default interval pattern, it fallback to "{date0} - {date1}"</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>the skeleton on which interval format based. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>the given locale </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dtitvinf</em> </td><td>the <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code on exit </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a date time interval formatter which the caller owns. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002547">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a135df7221deb0e857f1c6d3b66ce7ef5"></a><!-- doxytag: member="DateIntervalFormat::createInstance" ref="a135df7221deb0e857f1c6d3b66ce7ef5" args="(const UnicodeString &skeleton, const DateIntervalInfo &dtitvinf, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a>* DateIntervalFormat::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> & </td>
<td class="paramname"> <em>dtitvinf</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>, and default locale. </p>
<p>This is a convenient override of createInstance(const <a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& skeleton, const <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a>& locale, const <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a>& dtitvinf, UErrorCode&) with the locale value as default locale.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>the skeleton on which interval format based. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dtitvinf</em> </td><td>the <a class="el" href="classDateIntervalInfo.html" title="DateIntervalInfo is a public class for encapsulating localizable date time interval...">DateIntervalInfo</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code on exit </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a date time interval formatter which the caller owns. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002546">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aeef98399b07aaceacd7fd58ee33171c5"></a><!-- doxytag: member="DateIntervalFormat::createInstance" ref="aeef98399b07aaceacd7fd58ee33171c5" args="(const UnicodeString &skeleton, const Locale &locale, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a>* DateIntervalFormat::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>locale</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton and a given locale. </p>
<p>In this factory method, the date interval pattern information is load from resource files. Users are encouraged to created date interval formatter this way and to use the pre-defined skeleton macros.</p>
<p>There are pre-defined skeletons (defined in udate.h) having predefined interval patterns in resource files. Users are encouraged to use those macros. For example: DateIntervalFormat::createInstance(UDAT_MONTH_DAY, status)</p>
<p>The given <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a> provides the interval patterns. For example, for en_GB, if skeleton is UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY, which is "yMMMEEEd", the interval patterns defined in resource file to above skeleton are: "EEE, d MMM, yyyy - EEE, d MMM, yyyy" for year differs, "EEE, d MMM - EEE, d MMM, yyyy" for month differs, "EEE, d - EEE, d MMM, yyyy" for day differs, </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>the skeleton on which interval format based. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>the given locale </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code on exit </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a date time interval formatter which the caller owns. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002545">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="adc7c2da7b2f5e29fb6b4e9caf8f33318"></a><!-- doxytag: member="DateIntervalFormat::createInstance" ref="adc7c2da7b2f5e29fb6b4e9caf8f33318" args="(const UnicodeString &skeleton, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a>* DateIntervalFormat::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>skeleton</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classDateIntervalFormat.html" title="DateIntervalFormat is a class for formatting and parsing date intervals in a language-independent...">DateIntervalFormat</a> from skeleton and the default locale. </p>
<p>This is a convenient override of createInstance(const <a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& skeleton, const <a class="el" href="classLocale.html" title="A Locale object represents a specific geographical, political, or cultural region...">Locale</a>& locale, UErrorCode&) with the value of locale as default locale.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>skeleton</em> </td><td>the skeleton on which interval format based. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code on exit </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a date time interval formatter which the caller owns. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002544">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aaa08ad2bb46063a00f5b41500617a40d"></a><!-- doxytag: member="DateIntervalFormat::format" ref="aaa08ad2bb46063a00f5b41500617a40d" args="(Calendar &fromCalendar, Calendar &toCalendar, UnicodeString &appendTo, FieldPosition &fieldPosition, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& DateIntervalFormat::format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalendar.html">Calendar</a> & </td>
<td class="paramname"> <em>fromCalendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCalendar.html">Calendar</a> & </td>
<td class="paramname"> <em>toCalendar</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>fieldPosition</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> 2 Calendars to produce a string. </p>
<p>Note: "fromCalendar" and "toCalendar" are not const, since calendar is not const in SimpleDateFormat::format(Calendar&),</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fromCalendar</em> </td><td>calendar set to the from date in date interval to be formatted into date interval string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>toCalendar</em> </td><td>calendar set to the to date in date interval to be formatted into date interval string </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>fieldPosition</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. Caller needs to make sure it is SUCCESS at the function entrance </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002554">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a53179e87d3552d5f9f7802896a437947"></a><!-- doxytag: member="DateIntervalFormat::format" ref="a53179e87d3552d5f9f7802896a437947" args="(const DateInterval *dtInterval, UnicodeString &appendTo, FieldPosition &fieldPosition, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& DateIntervalFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateInterval.html">DateInterval</a> * </td>
<td class="paramname"> <em>dtInterval</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>fieldPosition</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> to produce a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dtInterval</em> </td><td><a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> to be formatted. </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>fieldPosition</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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002553">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad5163151a343dac64ad66c5680332ea3"></a><!-- doxytag: member="DateIntervalFormat::format" ref="ad5163151a343dac64ad66c5680332ea3" args="(const Formattable &obj, UnicodeString &appendTo, FieldPosition &fieldPosition, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a>& DateIntervalFormat::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>fieldPosition</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> an object to produce a string. </p>
<p>This method handles <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> objects with a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> type. If a the <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object type is not a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a>, then it returns a failing UErrorCode.</p>
<dl><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. Must be a <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a>. </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>fieldPosition</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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002552">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#a12ffb857c5c9a553270dfe9a71fbd8e9">Format</a>.</p>
</div>
</div>
<a class="anchor" id="acd674a6d5214ef0e7507637b5f8f9c89"></a><!-- doxytag: member="DateIntervalFormat::getDateFormat" ref="acd674a6d5214ef0e7507637b5f8f9c89" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classDateFormat.html">DateFormat</a>* DateIntervalFormat::getDateFormat </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the date formatter. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the date formatter associated with this date interval formatter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002557">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7508e46babb623d1383c8f85f09f1bb0"></a><!-- doxytag: member="DateIntervalFormat::getDateIntervalInfo" ref="a7508e46babb623d1383c8f85f09f1bb0" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a>* DateIntervalFormat::getDateIntervalInfo </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the date time interval patterns. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the date time interval patterns associated with this date interval formatter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002555">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a476faa13a44ff11411beaeb69158dd68"></a><!-- doxytag: member="DateIntervalFormat::getDynamicClassID" ref="a476faa13a44ff11411beaeb69158dd68" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> DateIntervalFormat::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a unique class ID POLYMORPHICALLY. </p>
<p>Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="classDateIntervalFormat.html#adb057520899e7e878c54152f990c6b28" title="Return true if the given Format objects are semantically equal.">operator==()</a> and <a class="el" href="classDateIntervalFormat.html#af9a584ad22ff3673323b26923f8c39b4" title="Clone this Format object polymorphically.">clone()</a> methods call this method.</p>
<dl class="return"><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 class="stable"><dt><b><a class="el" href="stable.html#_stable002559">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#ac961d410d174518e5a3ebb8bbef45cd7">Format</a>.</p>
</div>
</div>
<a class="anchor" id="ad2e287b02ed2899a3dd28d6d1414a352"></a><!-- doxytag: member="DateIntervalFormat::getStaticClassID" ref="ad2e287b02ed2899a3dd28d6d1414a352" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> DateIntervalFormat::getStaticClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the class ID for this class. </p>
<p>This is useful only for comparing to a return value from <a class="el" href="classDateIntervalFormat.html#a476faa13a44ff11411beaeb69158dd68" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a>. For example: </p>
<pre>
. Base* polymorphic_pointer = createPolymorphicObject();
. if (polymorphic_pointer-><a class="el" href="classDateIntervalFormat.html#a476faa13a44ff11411beaeb69158dd68" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a> ==
. erived::getStaticClassID()) ...
</pre> <dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for all objects of this class. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002558">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae1cd1ea9874e3da1d8e7c417850360ad"></a><!-- doxytag: member="DateIntervalFormat::operator!=" ref="ae1cd1ea9874e3da1d8e7c417850360ad" 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#a349ef00011f20ccd1d3b424445681aa5">UBool</a> DateIntervalFormat::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> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are not semantically equal. </p>
<p>Objects of different subclasses are considered unequal. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are not semantically equal. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002551">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Definition at line <a class="el" href="dtitvfmt_8h_source.html#l00962">962</a> of file <a class="el" href="dtitvfmt_8h_source.html">dtitvfmt.h</a>.</p>
<p>References <a class="el" href="classDateIntervalFormat.html#adb057520899e7e878c54152f990c6b28">operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="a65a1f1d51dd4d5ac269050b220033ea5"></a><!-- doxytag: member="DateIntervalFormat::operator=" ref="a65a1f1d51dd4d5ac269050b220033ea5" args="(const DateIntervalFormat &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a>& DateIntervalFormat::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateIntervalFormat.html">DateIntervalFormat</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002561">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classFormat.html#a7a5276a88c488462eea3a508b71f4d9c">Format</a>.</p>
</div>
</div>
<a class="anchor" id="adb057520899e7e878c54152f990c6b28"></a><!-- doxytag: member="DateIntervalFormat::operator==" ref="adb057520899e7e878c54152f990c6b28" args="(const Format &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> DateIntervalFormat::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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are semantically equal. </p>
<p>Objects of different subclasses are considered unequal. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are semantically equal. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002550">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
<p>Referenced by <a class="el" href="dtitvfmt_8h_source.html#l00962">operator!=()</a>.</p>
</div>
</div>
<a class="anchor" id="a30cd01f77584059579d72912df3e2bea"></a><!-- doxytag: member="DateIntervalFormat::parseObject" ref="a30cd01f77584059579d72912df3e2bea" args="(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void DateIntervalFormat::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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Date interval parsing is not supported. </p>
<p>Please do not use. </p>
<p>This method should handle parsing of date time interval strings into <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> objects with <a class="el" href="classDateInterval.html" title="This class represents a date interval.">DateInterval</a> type, which is a pair of UDate. </p>
<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>
<p>When parsing, leading whitespace is discarded (with a successful parse), while trailing whitespace is left as is. </p>
<p>See <a class="el" href="classFormat.html#aa53bea97b986c2f21e5638aa30aa08b7" title="Parse a string to produce an object.">Format::parseObject()</a> for more.</p>
<dl><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" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">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. Since no parsing is supported, upon return this param is unchanged. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly created Formattable* object, or NULL on failure. The caller owns this and should delete it when done. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000267">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#aa53bea97b986c2f21e5638aa30aa08b7">Format</a>.</p>
</div>
</div>
<a class="anchor" id="af90019c51abd9d92960dbe90043697b2"></a><!-- doxytag: member="DateIntervalFormat::setDateIntervalInfo" ref="af90019c51abd9d92960dbe90043697b2" args="(const DateIntervalInfo &newIntervalPatterns, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DateIntervalFormat::setDateIntervalInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classDateIntervalInfo.html">DateIntervalInfo</a> & </td>
<td class="paramname"> <em>newIntervalPatterns</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the date time interval patterns. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newIntervalPatterns</em> </td><td>the given interval patterns to copy. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code on exit </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002556">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dtitvfmt_8h_source.html">dtitvfmt.h</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
84
