1*0e209d39SAndroid Build Coastguard Worker // © 2016 and later: Unicode, Inc. and others.
2*0e209d39SAndroid Build Coastguard Worker // License & terms of use: http://www.unicode.org/copyright.html
3*0e209d39SAndroid Build Coastguard Worker /*
4*0e209d39SAndroid Build Coastguard Worker * Copyright (C) 1997-2016, International Business Machines Corporation and
5*0e209d39SAndroid Build Coastguard Worker * others. All Rights Reserved.
6*0e209d39SAndroid Build Coastguard Worker *******************************************************************************
7*0e209d39SAndroid Build Coastguard Worker *
8*0e209d39SAndroid Build Coastguard Worker * File SMPDTFMT.H
9*0e209d39SAndroid Build Coastguard Worker *
10*0e209d39SAndroid Build Coastguard Worker * Modification History:
11*0e209d39SAndroid Build Coastguard Worker *
12*0e209d39SAndroid Build Coastguard Worker * Date Name Description
13*0e209d39SAndroid Build Coastguard Worker * 02/19/97 aliu Converted from java.
14*0e209d39SAndroid Build Coastguard Worker * 07/09/97 helena Make ParsePosition into a class.
15*0e209d39SAndroid Build Coastguard Worker * 07/21/98 stephen Added GMT_PLUS, GMT_MINUS
16*0e209d39SAndroid Build Coastguard Worker * Changed setTwoDigitStartDate to set2DigitYearStart
17*0e209d39SAndroid Build Coastguard Worker * Changed getTwoDigitStartDate to get2DigitYearStart
18*0e209d39SAndroid Build Coastguard Worker * Removed subParseLong
19*0e209d39SAndroid Build Coastguard Worker * Removed getZoneIndex (added in DateFormatSymbols)
20*0e209d39SAndroid Build Coastguard Worker * 06/14/99 stephen Removed fgTimeZoneDataSuffix
21*0e209d39SAndroid Build Coastguard Worker * 10/14/99 aliu Updated class doc to describe 2-digit year parsing
22*0e209d39SAndroid Build Coastguard Worker * {j28 4182066}.
23*0e209d39SAndroid Build Coastguard Worker *******************************************************************************
24*0e209d39SAndroid Build Coastguard Worker */
25*0e209d39SAndroid Build Coastguard Worker
26*0e209d39SAndroid Build Coastguard Worker #ifndef SMPDTFMT_H
27*0e209d39SAndroid Build Coastguard Worker #define SMPDTFMT_H
28*0e209d39SAndroid Build Coastguard Worker
29*0e209d39SAndroid Build Coastguard Worker #include "unicode/utypes.h"
30*0e209d39SAndroid Build Coastguard Worker
31*0e209d39SAndroid Build Coastguard Worker #if U_SHOW_CPLUSPLUS_API
32*0e209d39SAndroid Build Coastguard Worker
33*0e209d39SAndroid Build Coastguard Worker /**
34*0e209d39SAndroid Build Coastguard Worker * \file
35*0e209d39SAndroid Build Coastguard Worker * \brief C++ API: Format and parse dates in a language-independent manner.
36*0e209d39SAndroid Build Coastguard Worker */
37*0e209d39SAndroid Build Coastguard Worker
38*0e209d39SAndroid Build Coastguard Worker #if !UCONFIG_NO_FORMATTING
39*0e209d39SAndroid Build Coastguard Worker
40*0e209d39SAndroid Build Coastguard Worker #include "unicode/datefmt.h"
41*0e209d39SAndroid Build Coastguard Worker #include "unicode/udisplaycontext.h"
42*0e209d39SAndroid Build Coastguard Worker #include "unicode/tzfmt.h" /* for UTimeZoneFormatTimeType */
43*0e209d39SAndroid Build Coastguard Worker #include "unicode/brkiter.h"
44*0e209d39SAndroid Build Coastguard Worker
45*0e209d39SAndroid Build Coastguard Worker U_NAMESPACE_BEGIN
46*0e209d39SAndroid Build Coastguard Worker
47*0e209d39SAndroid Build Coastguard Worker class DateFormatSymbols;
48*0e209d39SAndroid Build Coastguard Worker class DateFormat;
49*0e209d39SAndroid Build Coastguard Worker class MessageFormat;
50*0e209d39SAndroid Build Coastguard Worker class FieldPositionHandler;
51*0e209d39SAndroid Build Coastguard Worker class TimeZoneFormat;
52*0e209d39SAndroid Build Coastguard Worker class SharedNumberFormat;
53*0e209d39SAndroid Build Coastguard Worker class SimpleDateFormatMutableNFs;
54*0e209d39SAndroid Build Coastguard Worker class DateIntervalFormat;
55*0e209d39SAndroid Build Coastguard Worker
56*0e209d39SAndroid Build Coastguard Worker namespace number {
57*0e209d39SAndroid Build Coastguard Worker class LocalizedNumberFormatter;
58*0e209d39SAndroid Build Coastguard Worker class SimpleNumberFormatter;
59*0e209d39SAndroid Build Coastguard Worker }
60*0e209d39SAndroid Build Coastguard Worker
61*0e209d39SAndroid Build Coastguard Worker /**
62*0e209d39SAndroid Build Coastguard Worker *
63*0e209d39SAndroid Build Coastguard Worker * SimpleDateFormat is a concrete class for formatting and parsing dates in a
64*0e209d39SAndroid Build Coastguard Worker * language-independent manner. It allows for formatting (millis -> text),
65*0e209d39SAndroid Build Coastguard Worker * parsing (text -> millis), and normalization. Formats/Parses a date or time,
66*0e209d39SAndroid Build Coastguard Worker * which is the standard milliseconds since 24:00 GMT, Jan 1, 1970.
67*0e209d39SAndroid Build Coastguard Worker * <P>
68*0e209d39SAndroid Build Coastguard Worker * Clients are encouraged to create a date-time formatter using DateFormat::getInstance(),
69*0e209d39SAndroid Build Coastguard Worker * getDateInstance(), getDateInstance(), or getDateTimeInstance() rather than
70*0e209d39SAndroid Build Coastguard Worker * explicitly constructing an instance of SimpleDateFormat. This way, the client
71*0e209d39SAndroid Build Coastguard Worker * is guaranteed to get an appropriate formatting pattern for whatever locale the
72*0e209d39SAndroid Build Coastguard Worker * program is running in. If the client needs more control, they should consider using
73*0e209d39SAndroid Build Coastguard Worker * DateFormat::createInstanceForSkeleton(). However, if the client needs something more unusual than
74*0e209d39SAndroid Build Coastguard Worker * the default patterns in the locales, he can construct a SimpleDateFormat directly
75*0e209d39SAndroid Build Coastguard Worker * and give it an appropriate pattern (or use one of the factory methods on DateFormat
76*0e209d39SAndroid Build Coastguard Worker * and modify the pattern after the fact with toPattern() and applyPattern().
77*0e209d39SAndroid Build Coastguard Worker *
78*0e209d39SAndroid Build Coastguard Worker * <p><strong>Date and Time Patterns:</strong></p>
79*0e209d39SAndroid Build Coastguard Worker *
80*0e209d39SAndroid Build Coastguard Worker * <p>Date and time formats are specified by <em>date and time pattern</em> strings.
81*0e209d39SAndroid Build Coastguard Worker * The full syntax for date and time patterns can be found at
82*0e209d39SAndroid Build Coastguard Worker * <a href="https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns">https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns</a>.
83*0e209d39SAndroid Build Coastguard Worker *
84*0e209d39SAndroid Build Coastguard Worker * Within date and time pattern strings, all unquoted ASCII letters [A-Za-z] are reserved
85*0e209d39SAndroid Build Coastguard Worker * as pattern letters representing calendar fields. Some of the most commonly used pattern letters are:</p>
86*0e209d39SAndroid Build Coastguard Worker *
87*0e209d39SAndroid Build Coastguard Worker * <table border="1">
88*0e209d39SAndroid Build Coastguard Worker * <tr>
89*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: center">Sym.</th>
90*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: center">No.</th>
91*0e209d39SAndroid Build Coastguard Worker * <th>Example</th>
92*0e209d39SAndroid Build Coastguard Worker * <th>Description</th>
93*0e209d39SAndroid Build Coastguard Worker * </tr>
94*0e209d39SAndroid Build Coastguard Worker * <tr>
95*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">G</td>
96*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..3</td>
97*0e209d39SAndroid Build Coastguard Worker * <td>AD</td>
98*0e209d39SAndroid Build Coastguard Worker * <td>Era - Replaced with the Era string for the current date. One to three letters for the
99*0e209d39SAndroid Build Coastguard Worker * abbreviated form, four letters for the long (wide) form, five for the narrow form.</td>
100*0e209d39SAndroid Build Coastguard Worker * </tr>
101*0e209d39SAndroid Build Coastguard Worker * <tr>
102*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">y</td>
103*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..n</td>
104*0e209d39SAndroid Build Coastguard Worker * <td>1996</td>
105*0e209d39SAndroid Build Coastguard Worker * <td>Year. Normally the length specifies the padding, but for two letters it also specifies the maximum
106*0e209d39SAndroid Build Coastguard Worker * length. Example:<div style="text-align: center">
107*0e209d39SAndroid Build Coastguard Worker * <center>
108*0e209d39SAndroid Build Coastguard Worker * <table border="1" cellpadding="2" cellspacing="0">
109*0e209d39SAndroid Build Coastguard Worker * <tr>
110*0e209d39SAndroid Build Coastguard Worker * <th>Year</th>
111*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: right">y</th>
112*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: right">yy</th>
113*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: right">yyy</th>
114*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: right">yyyy</th>
115*0e209d39SAndroid Build Coastguard Worker * <th style="text-align: right">yyyyy</th>
116*0e209d39SAndroid Build Coastguard Worker * </tr>
117*0e209d39SAndroid Build Coastguard Worker * <tr>
118*0e209d39SAndroid Build Coastguard Worker * <td>AD 1</td>
119*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">1</td>
120*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">01</td>
121*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">001</td>
122*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">0001</td>
123*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">00001</td>
124*0e209d39SAndroid Build Coastguard Worker * </tr>
125*0e209d39SAndroid Build Coastguard Worker * <tr>
126*0e209d39SAndroid Build Coastguard Worker * <td>AD 12</td>
127*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12</td>
128*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12</td>
129*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">012</td>
130*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">0012</td>
131*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">00012</td>
132*0e209d39SAndroid Build Coastguard Worker * </tr>
133*0e209d39SAndroid Build Coastguard Worker * <tr>
134*0e209d39SAndroid Build Coastguard Worker * <td>AD 123</td>
135*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">123</td>
136*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">23</td>
137*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">123</td>
138*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">0123</td>
139*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">00123</td>
140*0e209d39SAndroid Build Coastguard Worker * </tr>
141*0e209d39SAndroid Build Coastguard Worker * <tr>
142*0e209d39SAndroid Build Coastguard Worker * <td>AD 1234</td>
143*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">1234</td>
144*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">34</td>
145*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">1234</td>
146*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">1234</td>
147*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">01234</td>
148*0e209d39SAndroid Build Coastguard Worker * </tr>
149*0e209d39SAndroid Build Coastguard Worker * <tr>
150*0e209d39SAndroid Build Coastguard Worker * <td>AD 12345</td>
151*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12345</td>
152*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">45</td>
153*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12345</td>
154*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12345</td>
155*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: right">12345</td>
156*0e209d39SAndroid Build Coastguard Worker * </tr>
157*0e209d39SAndroid Build Coastguard Worker * </table>
158*0e209d39SAndroid Build Coastguard Worker * </center></div>
159*0e209d39SAndroid Build Coastguard Worker * </td>
160*0e209d39SAndroid Build Coastguard Worker * </tr>
161*0e209d39SAndroid Build Coastguard Worker * <tr>
162*0e209d39SAndroid Build Coastguard Worker * <td rowspan="3" style="text-align: center">Q</td>
163*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
164*0e209d39SAndroid Build Coastguard Worker * <td>02</td>
165*0e209d39SAndroid Build Coastguard Worker * <td rowspan="3">Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four
166*0e209d39SAndroid Build Coastguard Worker * for the full (wide) name (five for the narrow name is not yet supported).</td>
167*0e209d39SAndroid Build Coastguard Worker * </tr>
168*0e209d39SAndroid Build Coastguard Worker * <tr>
169*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">3</td>
170*0e209d39SAndroid Build Coastguard Worker * <td>Q2</td>
171*0e209d39SAndroid Build Coastguard Worker * </tr>
172*0e209d39SAndroid Build Coastguard Worker * <tr>
173*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">4</td>
174*0e209d39SAndroid Build Coastguard Worker * <td>2nd quarter</td>
175*0e209d39SAndroid Build Coastguard Worker * </tr>
176*0e209d39SAndroid Build Coastguard Worker * <tr>
177*0e209d39SAndroid Build Coastguard Worker * <td rowspan="4" style="text-align: center">M</td>
178*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
179*0e209d39SAndroid Build Coastguard Worker * <td>09</td>
180*0e209d39SAndroid Build Coastguard Worker * <td rowspan="4">Month - Use one or two for the numerical month, three for the abbreviation, four for
181*0e209d39SAndroid Build Coastguard Worker * the full (wide) name, or five for the narrow name. With two ("MM"), the month number is zero-padded
182*0e209d39SAndroid Build Coastguard Worker * if necessary (e.g. "08").</td>
183*0e209d39SAndroid Build Coastguard Worker * </tr>
184*0e209d39SAndroid Build Coastguard Worker * <tr>
185*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">3</td>
186*0e209d39SAndroid Build Coastguard Worker * <td>Sep</td>
187*0e209d39SAndroid Build Coastguard Worker * </tr>
188*0e209d39SAndroid Build Coastguard Worker * <tr>
189*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">4</td>
190*0e209d39SAndroid Build Coastguard Worker * <td>September</td>
191*0e209d39SAndroid Build Coastguard Worker * </tr>
192*0e209d39SAndroid Build Coastguard Worker * <tr>
193*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">5</td>
194*0e209d39SAndroid Build Coastguard Worker * <td>S</td>
195*0e209d39SAndroid Build Coastguard Worker * </tr>
196*0e209d39SAndroid Build Coastguard Worker * <tr>
197*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">d</td>
198*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
199*0e209d39SAndroid Build Coastguard Worker * <td>1</td>
200*0e209d39SAndroid Build Coastguard Worker * <td>Date - Day of the month. Use "d" to show the minimum number of digits, or "dd" to always show
201*0e209d39SAndroid Build Coastguard Worker * two digits (zero-padding if necessary, e.g. "08").</td>
202*0e209d39SAndroid Build Coastguard Worker * </tr>
203*0e209d39SAndroid Build Coastguard Worker * <tr>
204*0e209d39SAndroid Build Coastguard Worker * <td rowspan="4" style="text-align: center">E</td>
205*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..3</td>
206*0e209d39SAndroid Build Coastguard Worker * <td>Tue</td>
207*0e209d39SAndroid Build Coastguard Worker * <td rowspan="4">Day of week - Use one through three letters for the short day, four for the full (wide) name,
208*0e209d39SAndroid Build Coastguard Worker * five for the narrow name, or six for the short name.</td>
209*0e209d39SAndroid Build Coastguard Worker * </tr>
210*0e209d39SAndroid Build Coastguard Worker * <tr>
211*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">4</td>
212*0e209d39SAndroid Build Coastguard Worker * <td>Tuesday</td>
213*0e209d39SAndroid Build Coastguard Worker * </tr>
214*0e209d39SAndroid Build Coastguard Worker * <tr>
215*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">5</td>
216*0e209d39SAndroid Build Coastguard Worker * <td>T</td>
217*0e209d39SAndroid Build Coastguard Worker * </tr>
218*0e209d39SAndroid Build Coastguard Worker * <tr>
219*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">6</td>
220*0e209d39SAndroid Build Coastguard Worker * <td>Tu</td>
221*0e209d39SAndroid Build Coastguard Worker * </tr>
222*0e209d39SAndroid Build Coastguard Worker * <tr>
223*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">a</td>
224*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1</td>
225*0e209d39SAndroid Build Coastguard Worker * <td>AM</td>
226*0e209d39SAndroid Build Coastguard Worker * <td>AM or PM</td>
227*0e209d39SAndroid Build Coastguard Worker * </tr>
228*0e209d39SAndroid Build Coastguard Worker * <tr>
229*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">h</td>
230*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
231*0e209d39SAndroid Build Coastguard Worker * <td>11</td>
232*0e209d39SAndroid Build Coastguard Worker * <td>Hour [1-12]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern
233*0e209d39SAndroid Build Coastguard Worker * generation, it should match the 12-hour-cycle format preferred by the locale (h or K); it should not match
234*0e209d39SAndroid Build Coastguard Worker * a 24-hour-cycle format (H or k). Use hh for zero padding.</td>
235*0e209d39SAndroid Build Coastguard Worker * </tr>
236*0e209d39SAndroid Build Coastguard Worker * <tr>
237*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">H</td>
238*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
239*0e209d39SAndroid Build Coastguard Worker * <td>13</td>
240*0e209d39SAndroid Build Coastguard Worker * <td>Hour [0-23]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern
241*0e209d39SAndroid Build Coastguard Worker * generation, it should match the 24-hour-cycle format preferred by the locale (H or k); it should not match a
242*0e209d39SAndroid Build Coastguard Worker * 12-hour-cycle format (h or K). Use HH for zero padding.</td>
243*0e209d39SAndroid Build Coastguard Worker * </tr>
244*0e209d39SAndroid Build Coastguard Worker * <tr>
245*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">m</td>
246*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
247*0e209d39SAndroid Build Coastguard Worker * <td>59</td>
248*0e209d39SAndroid Build Coastguard Worker * <td>Minute. Use "m" to show the minimum number of digits, or "mm" to always show two digits
249*0e209d39SAndroid Build Coastguard Worker * (zero-padding if necessary, e.g. "08")..</td>
250*0e209d39SAndroid Build Coastguard Worker * </tr>
251*0e209d39SAndroid Build Coastguard Worker * <tr>
252*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">s</td>
253*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..2</td>
254*0e209d39SAndroid Build Coastguard Worker * <td>12</td>
255*0e209d39SAndroid Build Coastguard Worker * <td>Second. Use "s" to show the minimum number of digits, or "ss" to always show two digits
256*0e209d39SAndroid Build Coastguard Worker * (zero-padding if necessary, e.g. "08").</td>
257*0e209d39SAndroid Build Coastguard Worker * </tr>
258*0e209d39SAndroid Build Coastguard Worker * <tr>
259*0e209d39SAndroid Build Coastguard Worker * <td rowspan="2" style="text-align: center">z</td>
260*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1..3</td>
261*0e209d39SAndroid Build Coastguard Worker * <td>PDT</td>
262*0e209d39SAndroid Build Coastguard Worker * <td>Time zone. The <i>short specific non-location format</i>.
263*0e209d39SAndroid Build Coastguard Worker * Where that is unavailable, falls back to the <i>short localized GMT format</i> ("O").</td>
264*0e209d39SAndroid Build Coastguard Worker * </tr>
265*0e209d39SAndroid Build Coastguard Worker * <tr>
266*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">4</td>
267*0e209d39SAndroid Build Coastguard Worker * <td>Pacific Daylight Time</td>
268*0e209d39SAndroid Build Coastguard Worker * <td>The <i>long specific non-location format</i>.
269*0e209d39SAndroid Build Coastguard Worker * Where that is unavailable, falls back to the <i>long localized GMT format</i> ("OOOO").</td>
270*0e209d39SAndroid Build Coastguard Worker * </tr>
271*0e209d39SAndroid Build Coastguard Worker * <tr>
272*0e209d39SAndroid Build Coastguard Worker * <td rowspan="2" style="text-align: center">v</td>
273*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">1</td>
274*0e209d39SAndroid Build Coastguard Worker * <td>PT</td>
275*0e209d39SAndroid Build Coastguard Worker * <td>Time zone. The <i>short generic non-location format</i>.
276*0e209d39SAndroid Build Coastguard Worker * Where that is unavailable, falls back to the <i>generic location format</i> ("VVVV"),
277*0e209d39SAndroid Build Coastguard Worker * then the <i>short localized GMT format</i> as the final fallback.</td>
278*0e209d39SAndroid Build Coastguard Worker * </tr>
279*0e209d39SAndroid Build Coastguard Worker * <tr>
280*0e209d39SAndroid Build Coastguard Worker * <td style="text-align: center">4</td>
281*0e209d39SAndroid Build Coastguard Worker * <td>Pacific Time</td>
282*0e209d39SAndroid Build Coastguard Worker * <td>The <i>long generic non-location format</i>.
283*0e209d39SAndroid Build Coastguard Worker * Where that is unavailable, falls back to <i>generic location format</i> ("VVVV").
284*0e209d39SAndroid Build Coastguard Worker * </tr>
285*0e209d39SAndroid Build Coastguard Worker * </table>
286*0e209d39SAndroid Build Coastguard Worker *
287*0e209d39SAndroid Build Coastguard Worker * <P>
288*0e209d39SAndroid Build Coastguard Worker * Any characters in the pattern that are not in the ranges of ['a'..'z'] and
289*0e209d39SAndroid Build Coastguard Worker * ['A'..'Z'] will be treated as quoted text. For instance, characters
290*0e209d39SAndroid Build Coastguard Worker * like ':', '.', ' ', '#' and '@' will appear in the resulting time text
291*0e209d39SAndroid Build Coastguard Worker * even they are not embraced within single quotes.
292*0e209d39SAndroid Build Coastguard Worker * <P>
293*0e209d39SAndroid Build Coastguard Worker * A pattern containing any invalid pattern letter will result in a failing
294*0e209d39SAndroid Build Coastguard Worker * UErrorCode result during formatting or parsing.
295*0e209d39SAndroid Build Coastguard Worker * <P>
296*0e209d39SAndroid Build Coastguard Worker * Examples using the US locale:
297*0e209d39SAndroid Build Coastguard Worker * <pre>
298*0e209d39SAndroid Build Coastguard Worker * \code
299*0e209d39SAndroid Build Coastguard Worker * Format Pattern Result
300*0e209d39SAndroid Build Coastguard Worker * -------------- -------
301*0e209d39SAndroid Build Coastguard Worker * "yyyy.MM.dd G 'at' HH:mm:ss vvvv" ->> 1996.07.10 AD at 15:08:56 Pacific Time
302*0e209d39SAndroid Build Coastguard Worker * "EEE, MMM d, ''yy" ->> Wed, July 10, '96
303*0e209d39SAndroid Build Coastguard Worker * "h:mm a" ->> 12:08 PM
304*0e209d39SAndroid Build Coastguard Worker * "hh 'o''clock' a, zzzz" ->> 12 o'clock PM, Pacific Daylight Time
305*0e209d39SAndroid Build Coastguard Worker * "K:mm a, vvv" ->> 0:00 PM, PT
306*0e209d39SAndroid Build Coastguard Worker * "yyyyy.MMMMM.dd GGG hh:mm aaa" ->> 1996.July.10 AD 12:08 PM
307*0e209d39SAndroid Build Coastguard Worker * \endcode
308*0e209d39SAndroid Build Coastguard Worker * </pre>
309*0e209d39SAndroid Build Coastguard Worker * Code Sample:
310*0e209d39SAndroid Build Coastguard Worker * <pre>
311*0e209d39SAndroid Build Coastguard Worker * \code
312*0e209d39SAndroid Build Coastguard Worker * UErrorCode success = U_ZERO_ERROR;
313*0e209d39SAndroid Build Coastguard Worker * SimpleTimeZone* pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, "PST");
314*0e209d39SAndroid Build Coastguard Worker * pdt->setStartRule( Calendar::APRIL, 1, Calendar::SUNDAY, 2*60*60*1000);
315*0e209d39SAndroid Build Coastguard Worker * pdt->setEndRule( Calendar::OCTOBER, -1, Calendar::SUNDAY, 2*60*60*1000);
316*0e209d39SAndroid Build Coastguard Worker *
317*0e209d39SAndroid Build Coastguard Worker * // Format the current time.
318*0e209d39SAndroid Build Coastguard Worker * SimpleDateFormat* formatter
319*0e209d39SAndroid Build Coastguard Worker * = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz", success );
320*0e209d39SAndroid Build Coastguard Worker * GregorianCalendar cal(success);
321*0e209d39SAndroid Build Coastguard Worker * UDate currentTime_1 = cal.getTime(success);
322*0e209d39SAndroid Build Coastguard Worker * FieldPosition fp(FieldPosition::DONT_CARE);
323*0e209d39SAndroid Build Coastguard Worker * UnicodeString dateString;
324*0e209d39SAndroid Build Coastguard Worker * formatter->format( currentTime_1, dateString, fp );
325*0e209d39SAndroid Build Coastguard Worker * cout << "result: " << dateString << endl;
326*0e209d39SAndroid Build Coastguard Worker *
327*0e209d39SAndroid Build Coastguard Worker * // Parse the previous string back into a Date.
328*0e209d39SAndroid Build Coastguard Worker * ParsePosition pp(0);
329*0e209d39SAndroid Build Coastguard Worker * UDate currentTime_2 = formatter->parse(dateString, pp );
330*0e209d39SAndroid Build Coastguard Worker * \endcode
331*0e209d39SAndroid Build Coastguard Worker * </pre>
332*0e209d39SAndroid Build Coastguard Worker * In the above example, the time value "currentTime_2" obtained from parsing
333*0e209d39SAndroid Build Coastguard Worker * will be equal to currentTime_1. However, they may not be equal if the am/pm
334*0e209d39SAndroid Build Coastguard Worker * marker 'a' is left out from the format pattern while the "hour in am/pm"
335*0e209d39SAndroid Build Coastguard Worker * pattern symbol is used. This information loss can happen when formatting the
336*0e209d39SAndroid Build Coastguard Worker * time in PM.
337*0e209d39SAndroid Build Coastguard Worker *
338*0e209d39SAndroid Build Coastguard Worker * <p>
339*0e209d39SAndroid Build Coastguard Worker * When parsing a date string using the abbreviated year pattern ("y" or "yy"),
340*0e209d39SAndroid Build Coastguard Worker * SimpleDateFormat must interpret the abbreviated year
341*0e209d39SAndroid Build Coastguard Worker * relative to some century. It does this by adjusting dates to be
342*0e209d39SAndroid Build Coastguard Worker * within 80 years before and 20 years after the time the SimpleDateFormat
343*0e209d39SAndroid Build Coastguard Worker * instance is created. For example, using a pattern of "MM/dd/yy" and a
344*0e209d39SAndroid Build Coastguard Worker * SimpleDateFormat instance created on Jan 1, 1997, the string
345*0e209d39SAndroid Build Coastguard Worker * "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64"
346*0e209d39SAndroid Build Coastguard Worker * would be interpreted as May 4, 1964.
347*0e209d39SAndroid Build Coastguard Worker * During parsing, only strings consisting of exactly two digits, as defined by
348*0e209d39SAndroid Build Coastguard Worker * <code>Unicode::isDigit()</code>, will be parsed into the default century.
349*0e209d39SAndroid Build Coastguard Worker * Any other numeric string, such as a one digit string, a three or more digit
350*0e209d39SAndroid Build Coastguard Worker * string, or a two digit string that isn't all digits (for example, "-1"), is
351*0e209d39SAndroid Build Coastguard Worker * interpreted literally. So "01/02/3" or "01/02/003" are parsed (for the
352*0e209d39SAndroid Build Coastguard Worker * Gregorian calendar), using the same pattern, as Jan 2, 3 AD. Likewise (but
353*0e209d39SAndroid Build Coastguard Worker * only in lenient parse mode, the default) "01/02/-3" is parsed as Jan 2, 4 BC.
354*0e209d39SAndroid Build Coastguard Worker *
355*0e209d39SAndroid Build Coastguard Worker * <p>
356*0e209d39SAndroid Build Coastguard Worker * If the year pattern has more than two 'y' characters, the year is
357*0e209d39SAndroid Build Coastguard Worker * interpreted literally, regardless of the number of digits. So using the
358*0e209d39SAndroid Build Coastguard Worker * pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.
359*0e209d39SAndroid Build Coastguard Worker *
360*0e209d39SAndroid Build Coastguard Worker * <p>
361*0e209d39SAndroid Build Coastguard Worker * When numeric fields abut one another directly, with no intervening delimiter
362*0e209d39SAndroid Build Coastguard Worker * characters, they constitute a run of abutting numeric fields. Such runs are
363*0e209d39SAndroid Build Coastguard Worker * parsed specially. For example, the format "HHmmss" parses the input text
364*0e209d39SAndroid Build Coastguard Worker * "123456" to 12:34:56, parses the input text "12345" to 1:23:45, and fails to
365*0e209d39SAndroid Build Coastguard Worker * parse "1234". In other words, the leftmost field of the run is flexible,
366*0e209d39SAndroid Build Coastguard Worker * while the others keep a fixed width. If the parse fails anywhere in the run,
367*0e209d39SAndroid Build Coastguard Worker * then the leftmost field is shortened by one character, and the entire run is
368*0e209d39SAndroid Build Coastguard Worker * parsed again. This is repeated until either the parse succeeds or the
369*0e209d39SAndroid Build Coastguard Worker * leftmost field is one character in length. If the parse still fails at that
370*0e209d39SAndroid Build Coastguard Worker * point, the parse of the run fails.
371*0e209d39SAndroid Build Coastguard Worker *
372*0e209d39SAndroid Build Coastguard Worker * <P>
373*0e209d39SAndroid Build Coastguard Worker * For time zones that have no names, SimpleDateFormat uses strings GMT+hours:minutes or
374*0e209d39SAndroid Build Coastguard Worker * GMT-hours:minutes.
375*0e209d39SAndroid Build Coastguard Worker * <P>
376*0e209d39SAndroid Build Coastguard Worker * The calendar defines what is the first day of the week, the first week of the
377*0e209d39SAndroid Build Coastguard Worker * year, whether hours are zero based or not (0 vs 12 or 24), and the timezone.
378*0e209d39SAndroid Build Coastguard Worker * There is one common number format to handle all the numbers; the digit count
379*0e209d39SAndroid Build Coastguard Worker * is handled programmatically according to the pattern.
380*0e209d39SAndroid Build Coastguard Worker *
381*0e209d39SAndroid Build Coastguard Worker * <p><em>User subclasses are not supported.</em> While clients may write
382*0e209d39SAndroid Build Coastguard Worker * subclasses, such code will not necessarily work and will not be
383*0e209d39SAndroid Build Coastguard Worker * guaranteed to work stably from release to release.
384*0e209d39SAndroid Build Coastguard Worker */
385*0e209d39SAndroid Build Coastguard Worker class U_I18N_API SimpleDateFormat: public DateFormat {
386*0e209d39SAndroid Build Coastguard Worker public:
387*0e209d39SAndroid Build Coastguard Worker /**
388*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the default pattern for the default
389*0e209d39SAndroid Build Coastguard Worker * locale.
390*0e209d39SAndroid Build Coastguard Worker * <P>
391*0e209d39SAndroid Build Coastguard Worker * [Note:] Not all locales support SimpleDateFormat; for full generality,
392*0e209d39SAndroid Build Coastguard Worker * use the factory methods in the DateFormat class.
393*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code.
394*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
395*0e209d39SAndroid Build Coastguard Worker */
396*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(UErrorCode& status);
397*0e209d39SAndroid Build Coastguard Worker
398*0e209d39SAndroid Build Coastguard Worker /**
399*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern and the default locale.
400*0e209d39SAndroid Build Coastguard Worker * The locale is used to obtain the symbols used in formatting (e.g., the
401*0e209d39SAndroid Build Coastguard Worker * names of the months), but not to provide the pattern.
402*0e209d39SAndroid Build Coastguard Worker * <P>
403*0e209d39SAndroid Build Coastguard Worker * [Note:] Not all locales support SimpleDateFormat; for full generality,
404*0e209d39SAndroid Build Coastguard Worker * use the factory methods in the DateFormat class.
405*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern for the format.
406*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code.
407*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
408*0e209d39SAndroid Build Coastguard Worker */
409*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
410*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
411*0e209d39SAndroid Build Coastguard Worker
412*0e209d39SAndroid Build Coastguard Worker /**
413*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern, numbering system override, and the default locale.
414*0e209d39SAndroid Build Coastguard Worker * The locale is used to obtain the symbols used in formatting (e.g., the
415*0e209d39SAndroid Build Coastguard Worker * names of the months), but not to provide the pattern.
416*0e209d39SAndroid Build Coastguard Worker * <P>
417*0e209d39SAndroid Build Coastguard Worker * A numbering system override is a string containing either the name of a known numbering system,
418*0e209d39SAndroid Build Coastguard Worker * or a set of field and numbering system pairs that specify which fields are to be formatted with
419*0e209d39SAndroid Build Coastguard Worker * the alternate numbering system. For example, to specify that all numeric fields in the specified
420*0e209d39SAndroid Build Coastguard Worker * date or time pattern are to be rendered using Thai digits, simply specify the numbering system override
421*0e209d39SAndroid Build Coastguard Worker * as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering,
422*0e209d39SAndroid Build Coastguard Worker * use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon
423*0e209d39SAndroid Build Coastguard Worker * character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.
424*0e209d39SAndroid Build Coastguard Worker *
425*0e209d39SAndroid Build Coastguard Worker * <P>
426*0e209d39SAndroid Build Coastguard Worker * [Note:] Not all locales support SimpleDateFormat; for full generality,
427*0e209d39SAndroid Build Coastguard Worker * use the factory methods in the DateFormat class.
428*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern for the format.
429*0e209d39SAndroid Build Coastguard Worker * @param override the override string.
430*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code.
431*0e209d39SAndroid Build Coastguard Worker * @stable ICU 4.2
432*0e209d39SAndroid Build Coastguard Worker */
433*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
434*0e209d39SAndroid Build Coastguard Worker const UnicodeString& override,
435*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
436*0e209d39SAndroid Build Coastguard Worker
437*0e209d39SAndroid Build Coastguard Worker /**
438*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern and locale.
439*0e209d39SAndroid Build Coastguard Worker * The locale is used to obtain the symbols used in formatting (e.g., the
440*0e209d39SAndroid Build Coastguard Worker * names of the months), but not to provide the pattern.
441*0e209d39SAndroid Build Coastguard Worker * <P>
442*0e209d39SAndroid Build Coastguard Worker * [Note:] Not all locales support SimpleDateFormat; for full generality,
443*0e209d39SAndroid Build Coastguard Worker * use the factory methods in the DateFormat class.
444*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern for the format.
445*0e209d39SAndroid Build Coastguard Worker * @param locale the given locale.
446*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code.
447*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
448*0e209d39SAndroid Build Coastguard Worker */
449*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
450*0e209d39SAndroid Build Coastguard Worker const Locale& locale,
451*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
452*0e209d39SAndroid Build Coastguard Worker
453*0e209d39SAndroid Build Coastguard Worker /**
454*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern, numbering system override, and locale.
455*0e209d39SAndroid Build Coastguard Worker * The locale is used to obtain the symbols used in formatting (e.g., the
456*0e209d39SAndroid Build Coastguard Worker * names of the months), but not to provide the pattern.
457*0e209d39SAndroid Build Coastguard Worker * <P>
458*0e209d39SAndroid Build Coastguard Worker * A numbering system override is a string containing either the name of a known numbering system,
459*0e209d39SAndroid Build Coastguard Worker * or a set of field and numbering system pairs that specify which fields are to be formatted with
460*0e209d39SAndroid Build Coastguard Worker * the alternate numbering system. For example, to specify that all numeric fields in the specified
461*0e209d39SAndroid Build Coastguard Worker * date or time pattern are to be rendered using Thai digits, simply specify the numbering system override
462*0e209d39SAndroid Build Coastguard Worker * as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering,
463*0e209d39SAndroid Build Coastguard Worker * use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon
464*0e209d39SAndroid Build Coastguard Worker * character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.
465*0e209d39SAndroid Build Coastguard Worker * <P>
466*0e209d39SAndroid Build Coastguard Worker * [Note:] Not all locales support SimpleDateFormat; for full generality,
467*0e209d39SAndroid Build Coastguard Worker * use the factory methods in the DateFormat class.
468*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern for the format.
469*0e209d39SAndroid Build Coastguard Worker * @param override the numbering system override.
470*0e209d39SAndroid Build Coastguard Worker * @param locale the given locale.
471*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code.
472*0e209d39SAndroid Build Coastguard Worker * @stable ICU 4.2
473*0e209d39SAndroid Build Coastguard Worker */
474*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
475*0e209d39SAndroid Build Coastguard Worker const UnicodeString& override,
476*0e209d39SAndroid Build Coastguard Worker const Locale& locale,
477*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
478*0e209d39SAndroid Build Coastguard Worker
479*0e209d39SAndroid Build Coastguard Worker /**
480*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern and locale-specific
481*0e209d39SAndroid Build Coastguard Worker * symbol data. The formatter takes ownership of the DateFormatSymbols object;
482*0e209d39SAndroid Build Coastguard Worker * the caller is no longer responsible for deleting it.
483*0e209d39SAndroid Build Coastguard Worker * @param pattern the given pattern for the format.
484*0e209d39SAndroid Build Coastguard Worker * @param formatDataToAdopt the symbols to be adopted.
485*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/faulure code.
486*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
487*0e209d39SAndroid Build Coastguard Worker */
488*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
489*0e209d39SAndroid Build Coastguard Worker DateFormatSymbols* formatDataToAdopt,
490*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
491*0e209d39SAndroid Build Coastguard Worker
492*0e209d39SAndroid Build Coastguard Worker /**
493*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat using the given pattern and locale-specific
494*0e209d39SAndroid Build Coastguard Worker * symbol data. The DateFormatSymbols object is NOT adopted; the caller
495*0e209d39SAndroid Build Coastguard Worker * remains responsible for deleting it.
496*0e209d39SAndroid Build Coastguard Worker * @param pattern the given pattern for the format.
497*0e209d39SAndroid Build Coastguard Worker * @param formatData the formatting symbols to be use.
498*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/faulure code.
499*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
500*0e209d39SAndroid Build Coastguard Worker */
501*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const UnicodeString& pattern,
502*0e209d39SAndroid Build Coastguard Worker const DateFormatSymbols& formatData,
503*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
504*0e209d39SAndroid Build Coastguard Worker
505*0e209d39SAndroid Build Coastguard Worker /**
506*0e209d39SAndroid Build Coastguard Worker * Copy constructor.
507*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
508*0e209d39SAndroid Build Coastguard Worker */
509*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const SimpleDateFormat&);
510*0e209d39SAndroid Build Coastguard Worker
511*0e209d39SAndroid Build Coastguard Worker /**
512*0e209d39SAndroid Build Coastguard Worker * Assignment operator.
513*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
514*0e209d39SAndroid Build Coastguard Worker */
515*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat& operator=(const SimpleDateFormat&);
516*0e209d39SAndroid Build Coastguard Worker
517*0e209d39SAndroid Build Coastguard Worker /**
518*0e209d39SAndroid Build Coastguard Worker * Destructor.
519*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
520*0e209d39SAndroid Build Coastguard Worker */
521*0e209d39SAndroid Build Coastguard Worker virtual ~SimpleDateFormat();
522*0e209d39SAndroid Build Coastguard Worker
523*0e209d39SAndroid Build Coastguard Worker /**
524*0e209d39SAndroid Build Coastguard Worker * Clone this Format object polymorphically. The caller owns the result and
525*0e209d39SAndroid Build Coastguard Worker * should delete it when done.
526*0e209d39SAndroid Build Coastguard Worker * @return A copy of the object.
527*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
528*0e209d39SAndroid Build Coastguard Worker */
529*0e209d39SAndroid Build Coastguard Worker virtual SimpleDateFormat* clone() const override;
530*0e209d39SAndroid Build Coastguard Worker
531*0e209d39SAndroid Build Coastguard Worker /**
532*0e209d39SAndroid Build Coastguard Worker * Return true if the given Format objects are semantically equal. Objects
533*0e209d39SAndroid Build Coastguard Worker * of different subclasses are considered unequal.
534*0e209d39SAndroid Build Coastguard Worker * @param other the object to be compared with.
535*0e209d39SAndroid Build Coastguard Worker * @return true if the given Format objects are semantically equal.
536*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
537*0e209d39SAndroid Build Coastguard Worker */
538*0e209d39SAndroid Build Coastguard Worker virtual bool operator==(const Format& other) const override;
539*0e209d39SAndroid Build Coastguard Worker
540*0e209d39SAndroid Build Coastguard Worker
541*0e209d39SAndroid Build Coastguard Worker using DateFormat::format;
542*0e209d39SAndroid Build Coastguard Worker
543*0e209d39SAndroid Build Coastguard Worker /**
544*0e209d39SAndroid Build Coastguard Worker * Format a date or time, which is the standard millis since 24:00 GMT, Jan
545*0e209d39SAndroid Build Coastguard Worker * 1, 1970. Overrides DateFormat pure virtual method.
546*0e209d39SAndroid Build Coastguard Worker * <P>
547*0e209d39SAndroid Build Coastguard Worker * Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->>
548*0e209d39SAndroid Build Coastguard Worker * 1996.07.10 AD at 15:08:56 PDT
549*0e209d39SAndroid Build Coastguard Worker *
550*0e209d39SAndroid Build Coastguard Worker * @param cal Calendar set to the date and time to be formatted
551*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
552*0e209d39SAndroid Build Coastguard Worker * @param appendTo Output parameter to receive result.
553*0e209d39SAndroid Build Coastguard Worker * Result is appended to existing contents.
554*0e209d39SAndroid Build Coastguard Worker * @param pos The formatting position. On input: an alignment field,
555*0e209d39SAndroid Build Coastguard Worker * if desired. On output: the offsets of the alignment field.
556*0e209d39SAndroid Build Coastguard Worker * @return Reference to 'appendTo' parameter.
557*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.1
558*0e209d39SAndroid Build Coastguard Worker */
559*0e209d39SAndroid Build Coastguard Worker virtual UnicodeString& format( Calendar& cal,
560*0e209d39SAndroid Build Coastguard Worker UnicodeString& appendTo,
561*0e209d39SAndroid Build Coastguard Worker FieldPosition& pos) const override;
562*0e209d39SAndroid Build Coastguard Worker
563*0e209d39SAndroid Build Coastguard Worker /**
564*0e209d39SAndroid Build Coastguard Worker * Format a date or time, which is the standard millis since 24:00 GMT, Jan
565*0e209d39SAndroid Build Coastguard Worker * 1, 1970. Overrides DateFormat pure virtual method.
566*0e209d39SAndroid Build Coastguard Worker * <P>
567*0e209d39SAndroid Build Coastguard Worker * Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->>
568*0e209d39SAndroid Build Coastguard Worker * 1996.07.10 AD at 15:08:56 PDT
569*0e209d39SAndroid Build Coastguard Worker *
570*0e209d39SAndroid Build Coastguard Worker * @param cal Calendar set to the date and time to be formatted
571*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
572*0e209d39SAndroid Build Coastguard Worker * @param appendTo Output parameter to receive result.
573*0e209d39SAndroid Build Coastguard Worker * Result is appended to existing contents.
574*0e209d39SAndroid Build Coastguard Worker * @param posIter On return, can be used to iterate over positions
575*0e209d39SAndroid Build Coastguard Worker * of fields generated by this format call. Field values
576*0e209d39SAndroid Build Coastguard Worker * are defined in UDateFormatField.
577*0e209d39SAndroid Build Coastguard Worker * @param status Input/output param set to success/failure code.
578*0e209d39SAndroid Build Coastguard Worker * @return Reference to 'appendTo' parameter.
579*0e209d39SAndroid Build Coastguard Worker * @stable ICU 4.4
580*0e209d39SAndroid Build Coastguard Worker */
581*0e209d39SAndroid Build Coastguard Worker virtual UnicodeString& format( Calendar& cal,
582*0e209d39SAndroid Build Coastguard Worker UnicodeString& appendTo,
583*0e209d39SAndroid Build Coastguard Worker FieldPositionIterator* posIter,
584*0e209d39SAndroid Build Coastguard Worker UErrorCode& status) const override;
585*0e209d39SAndroid Build Coastguard Worker
586*0e209d39SAndroid Build Coastguard Worker using DateFormat::parse;
587*0e209d39SAndroid Build Coastguard Worker
588*0e209d39SAndroid Build Coastguard Worker /**
589*0e209d39SAndroid Build Coastguard Worker * Parse a date/time string beginning at the given parse position. For
590*0e209d39SAndroid Build Coastguard Worker * example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date
591*0e209d39SAndroid Build Coastguard Worker * that is equivalent to Date(837039928046).
592*0e209d39SAndroid Build Coastguard Worker * <P>
593*0e209d39SAndroid Build Coastguard Worker * By default, parsing is lenient: If the input is not in the form used by
594*0e209d39SAndroid Build Coastguard Worker * this object's format method but can still be parsed as a date, then the
595*0e209d39SAndroid Build Coastguard Worker * parse succeeds. Clients may insist on strict adherence to the format by
596*0e209d39SAndroid Build Coastguard Worker * calling setLenient(false).
597*0e209d39SAndroid Build Coastguard Worker * @see DateFormat::setLenient(boolean)
598*0e209d39SAndroid Build Coastguard Worker *
599*0e209d39SAndroid Build Coastguard Worker * @param text The date/time string to be parsed
600*0e209d39SAndroid Build Coastguard Worker * @param cal A Calendar set on input to the date and time to be used for
601*0e209d39SAndroid Build Coastguard Worker * missing values in the date/time string being parsed, and set
602*0e209d39SAndroid Build Coastguard Worker * on output to the parsed date/time. When the calendar type is
603*0e209d39SAndroid Build Coastguard Worker * different from the internal calendar held by this SimpleDateFormat
604*0e209d39SAndroid Build Coastguard Worker * instance, the internal calendar will be cloned to a work
605*0e209d39SAndroid Build Coastguard Worker * calendar set to the same milliseconds and time zone as the
606*0e209d39SAndroid Build Coastguard Worker * cal parameter, field values will be parsed based on the work
607*0e209d39SAndroid Build Coastguard Worker * calendar, then the result (milliseconds and time zone) will
608*0e209d39SAndroid Build Coastguard Worker * be set in this calendar.
609*0e209d39SAndroid Build Coastguard Worker * @param pos On input, the position at which to start parsing; on
610*0e209d39SAndroid Build Coastguard Worker * output, the position at which parsing terminated, or the
611*0e209d39SAndroid Build Coastguard Worker * start position if the parse failed.
612*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.1
613*0e209d39SAndroid Build Coastguard Worker */
614*0e209d39SAndroid Build Coastguard Worker virtual void parse( const UnicodeString& text,
615*0e209d39SAndroid Build Coastguard Worker Calendar& cal,
616*0e209d39SAndroid Build Coastguard Worker ParsePosition& pos) const override;
617*0e209d39SAndroid Build Coastguard Worker
618*0e209d39SAndroid Build Coastguard Worker
619*0e209d39SAndroid Build Coastguard Worker /**
620*0e209d39SAndroid Build Coastguard Worker * Set the start UDate used to interpret two-digit year strings.
621*0e209d39SAndroid Build Coastguard Worker * When dates are parsed having 2-digit year strings, they are placed within
622*0e209d39SAndroid Build Coastguard Worker * a assumed range of 100 years starting on the two digit start date. For
623*0e209d39SAndroid Build Coastguard Worker * example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or
624*0e209d39SAndroid Build Coastguard Worker * some other year. SimpleDateFormat chooses a year so that the resultant
625*0e209d39SAndroid Build Coastguard Worker * date is on or after the two digit start date and within 100 years of the
626*0e209d39SAndroid Build Coastguard Worker * two digit start date.
627*0e209d39SAndroid Build Coastguard Worker * <P>
628*0e209d39SAndroid Build Coastguard Worker * By default, the two digit start date is set to 80 years before the current
629*0e209d39SAndroid Build Coastguard Worker * time at which a SimpleDateFormat object is created.
630*0e209d39SAndroid Build Coastguard Worker * @param d start UDate used to interpret two-digit year strings.
631*0e209d39SAndroid Build Coastguard Worker * @param status Filled in with U_ZERO_ERROR if the parse was successful, and with
632*0e209d39SAndroid Build Coastguard Worker * an error value if there was a parse error.
633*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
634*0e209d39SAndroid Build Coastguard Worker */
635*0e209d39SAndroid Build Coastguard Worker virtual void set2DigitYearStart(UDate d, UErrorCode& status);
636*0e209d39SAndroid Build Coastguard Worker
637*0e209d39SAndroid Build Coastguard Worker /**
638*0e209d39SAndroid Build Coastguard Worker * Get the start UDate used to interpret two-digit year strings.
639*0e209d39SAndroid Build Coastguard Worker * When dates are parsed having 2-digit year strings, they are placed within
640*0e209d39SAndroid Build Coastguard Worker * a assumed range of 100 years starting on the two digit start date. For
641*0e209d39SAndroid Build Coastguard Worker * example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or
642*0e209d39SAndroid Build Coastguard Worker * some other year. SimpleDateFormat chooses a year so that the resultant
643*0e209d39SAndroid Build Coastguard Worker * date is on or after the two digit start date and within 100 years of the
644*0e209d39SAndroid Build Coastguard Worker * two digit start date.
645*0e209d39SAndroid Build Coastguard Worker * <P>
646*0e209d39SAndroid Build Coastguard Worker * By default, the two digit start date is set to 80 years before the current
647*0e209d39SAndroid Build Coastguard Worker * time at which a SimpleDateFormat object is created.
648*0e209d39SAndroid Build Coastguard Worker * @param status Filled in with U_ZERO_ERROR if the parse was successful, and with
649*0e209d39SAndroid Build Coastguard Worker * an error value if there was a parse error.
650*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
651*0e209d39SAndroid Build Coastguard Worker */
652*0e209d39SAndroid Build Coastguard Worker UDate get2DigitYearStart(UErrorCode& status) const;
653*0e209d39SAndroid Build Coastguard Worker
654*0e209d39SAndroid Build Coastguard Worker /**
655*0e209d39SAndroid Build Coastguard Worker * Return a pattern string describing this date format.
656*0e209d39SAndroid Build Coastguard Worker * @param result Output param to receive the pattern.
657*0e209d39SAndroid Build Coastguard Worker * @return A reference to 'result'.
658*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
659*0e209d39SAndroid Build Coastguard Worker */
660*0e209d39SAndroid Build Coastguard Worker virtual UnicodeString& toPattern(UnicodeString& result) const;
661*0e209d39SAndroid Build Coastguard Worker
662*0e209d39SAndroid Build Coastguard Worker /**
663*0e209d39SAndroid Build Coastguard Worker * Return a localized pattern string describing this date format.
664*0e209d39SAndroid Build Coastguard Worker * In most cases, this will return the same thing as toPattern(),
665*0e209d39SAndroid Build Coastguard Worker * but a locale can specify characters to use in pattern descriptions
666*0e209d39SAndroid Build Coastguard Worker * in place of the ones described in this class's class documentation.
667*0e209d39SAndroid Build Coastguard Worker * (Presumably, letters that would be more mnemonic in that locale's
668*0e209d39SAndroid Build Coastguard Worker * language.) This function would produce a pattern using those
669*0e209d39SAndroid Build Coastguard Worker * letters.
670*0e209d39SAndroid Build Coastguard Worker * <p>
671*0e209d39SAndroid Build Coastguard Worker * <b>Note:</b> This implementation depends on DateFormatSymbols::getLocalPatternChars()
672*0e209d39SAndroid Build Coastguard Worker * to get localized format pattern characters. ICU does not include
673*0e209d39SAndroid Build Coastguard Worker * localized pattern character data, therefore, unless user sets localized
674*0e209d39SAndroid Build Coastguard Worker * pattern characters manually, this method returns the same result as
675*0e209d39SAndroid Build Coastguard Worker * toPattern().
676*0e209d39SAndroid Build Coastguard Worker *
677*0e209d39SAndroid Build Coastguard Worker * @param result Receives the localized pattern.
678*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code on
679*0e209d39SAndroid Build Coastguard Worker * exit. If the pattern is invalid, this will be
680*0e209d39SAndroid Build Coastguard Worker * set to a failure result.
681*0e209d39SAndroid Build Coastguard Worker * @return A reference to 'result'.
682*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
683*0e209d39SAndroid Build Coastguard Worker */
684*0e209d39SAndroid Build Coastguard Worker virtual UnicodeString& toLocalizedPattern(UnicodeString& result,
685*0e209d39SAndroid Build Coastguard Worker UErrorCode& status) const;
686*0e209d39SAndroid Build Coastguard Worker
687*0e209d39SAndroid Build Coastguard Worker /**
688*0e209d39SAndroid Build Coastguard Worker * Apply the given unlocalized pattern string to this date format.
689*0e209d39SAndroid Build Coastguard Worker * (i.e., after this call, this formatter will format dates according to
690*0e209d39SAndroid Build Coastguard Worker * the new pattern)
691*0e209d39SAndroid Build Coastguard Worker *
692*0e209d39SAndroid Build Coastguard Worker * @param pattern The pattern to be applied.
693*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
694*0e209d39SAndroid Build Coastguard Worker */
695*0e209d39SAndroid Build Coastguard Worker virtual void applyPattern(const UnicodeString& pattern);
696*0e209d39SAndroid Build Coastguard Worker
697*0e209d39SAndroid Build Coastguard Worker /**
698*0e209d39SAndroid Build Coastguard Worker * Apply the given localized pattern string to this date format.
699*0e209d39SAndroid Build Coastguard Worker * (see toLocalizedPattern() for more information on localized patterns.)
700*0e209d39SAndroid Build Coastguard Worker *
701*0e209d39SAndroid Build Coastguard Worker * @param pattern The localized pattern to be applied.
702*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code on
703*0e209d39SAndroid Build Coastguard Worker * exit. If the pattern is invalid, this will be
704*0e209d39SAndroid Build Coastguard Worker * set to a failure result.
705*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
706*0e209d39SAndroid Build Coastguard Worker */
707*0e209d39SAndroid Build Coastguard Worker virtual void applyLocalizedPattern(const UnicodeString& pattern,
708*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
709*0e209d39SAndroid Build Coastguard Worker
710*0e209d39SAndroid Build Coastguard Worker /**
711*0e209d39SAndroid Build Coastguard Worker * Gets the date/time formatting symbols (this is an object carrying
712*0e209d39SAndroid Build Coastguard Worker * the various strings and other symbols used in formatting: e.g., month
713*0e209d39SAndroid Build Coastguard Worker * names and abbreviations, time zone names, AM/PM strings, etc.)
714*0e209d39SAndroid Build Coastguard Worker * @return a copy of the date-time formatting data associated
715*0e209d39SAndroid Build Coastguard Worker * with this date-time formatter.
716*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
717*0e209d39SAndroid Build Coastguard Worker */
718*0e209d39SAndroid Build Coastguard Worker virtual const DateFormatSymbols* getDateFormatSymbols() const;
719*0e209d39SAndroid Build Coastguard Worker
720*0e209d39SAndroid Build Coastguard Worker /**
721*0e209d39SAndroid Build Coastguard Worker * Set the date/time formatting symbols. The caller no longer owns the
722*0e209d39SAndroid Build Coastguard Worker * DateFormatSymbols object and should not delete it after making this call.
723*0e209d39SAndroid Build Coastguard Worker * @param newFormatSymbols the given date-time formatting symbols to copy.
724*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
725*0e209d39SAndroid Build Coastguard Worker */
726*0e209d39SAndroid Build Coastguard Worker virtual void adoptDateFormatSymbols(DateFormatSymbols* newFormatSymbols);
727*0e209d39SAndroid Build Coastguard Worker
728*0e209d39SAndroid Build Coastguard Worker /**
729*0e209d39SAndroid Build Coastguard Worker * Set the date/time formatting data.
730*0e209d39SAndroid Build Coastguard Worker * @param newFormatSymbols the given date-time formatting symbols to copy.
731*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
732*0e209d39SAndroid Build Coastguard Worker */
733*0e209d39SAndroid Build Coastguard Worker virtual void setDateFormatSymbols(const DateFormatSymbols& newFormatSymbols);
734*0e209d39SAndroid Build Coastguard Worker
735*0e209d39SAndroid Build Coastguard Worker /**
736*0e209d39SAndroid Build Coastguard Worker * Return the class ID for this class. This is useful only for comparing to
737*0e209d39SAndroid Build Coastguard Worker * a return value from getDynamicClassID(). For example:
738*0e209d39SAndroid Build Coastguard Worker * <pre>
739*0e209d39SAndroid Build Coastguard Worker * . Base* polymorphic_pointer = createPolymorphicObject();
740*0e209d39SAndroid Build Coastguard Worker * . if (polymorphic_pointer->getDynamicClassID() ==
741*0e209d39SAndroid Build Coastguard Worker * . erived::getStaticClassID()) ...
742*0e209d39SAndroid Build Coastguard Worker * </pre>
743*0e209d39SAndroid Build Coastguard Worker * @return The class ID for all objects of this class.
744*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
745*0e209d39SAndroid Build Coastguard Worker */
746*0e209d39SAndroid Build Coastguard Worker static UClassID U_EXPORT2 getStaticClassID();
747*0e209d39SAndroid Build Coastguard Worker
748*0e209d39SAndroid Build Coastguard Worker /**
749*0e209d39SAndroid Build Coastguard Worker * Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This
750*0e209d39SAndroid Build Coastguard Worker * method is to implement a simple version of RTTI, since not all C++
751*0e209d39SAndroid Build Coastguard Worker * compilers support genuine RTTI. Polymorphic operator==() and clone()
752*0e209d39SAndroid Build Coastguard Worker * methods call this method.
753*0e209d39SAndroid Build Coastguard Worker *
754*0e209d39SAndroid Build Coastguard Worker * @return The class ID for this object. All objects of a
755*0e209d39SAndroid Build Coastguard Worker * given class have the same class ID. Objects of
756*0e209d39SAndroid Build Coastguard Worker * other classes have different class IDs.
757*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
758*0e209d39SAndroid Build Coastguard Worker */
759*0e209d39SAndroid Build Coastguard Worker virtual UClassID getDynamicClassID() const override;
760*0e209d39SAndroid Build Coastguard Worker
761*0e209d39SAndroid Build Coastguard Worker /**
762*0e209d39SAndroid Build Coastguard Worker * Set the calendar to be used by this date format. Initially, the default
763*0e209d39SAndroid Build Coastguard Worker * calendar for the specified or default locale is used. The caller should
764*0e209d39SAndroid Build Coastguard Worker * not delete the Calendar object after it is adopted by this call.
765*0e209d39SAndroid Build Coastguard Worker * Adopting a new calendar will change to the default symbols.
766*0e209d39SAndroid Build Coastguard Worker *
767*0e209d39SAndroid Build Coastguard Worker * @param calendarToAdopt Calendar object to be adopted.
768*0e209d39SAndroid Build Coastguard Worker * @stable ICU 2.0
769*0e209d39SAndroid Build Coastguard Worker */
770*0e209d39SAndroid Build Coastguard Worker virtual void adoptCalendar(Calendar* calendarToAdopt) override;
771*0e209d39SAndroid Build Coastguard Worker
772*0e209d39SAndroid Build Coastguard Worker /* Cannot use #ifndef U_HIDE_INTERNAL_API for the following methods since they are virtual */
773*0e209d39SAndroid Build Coastguard Worker /**
774*0e209d39SAndroid Build Coastguard Worker * Sets the TimeZoneFormat to be used by this date/time formatter.
775*0e209d39SAndroid Build Coastguard Worker * The caller should not delete the TimeZoneFormat object after
776*0e209d39SAndroid Build Coastguard Worker * it is adopted by this call.
777*0e209d39SAndroid Build Coastguard Worker * @param timeZoneFormatToAdopt The TimeZoneFormat object to be adopted.
778*0e209d39SAndroid Build Coastguard Worker * @internal ICU 49 technology preview
779*0e209d39SAndroid Build Coastguard Worker */
780*0e209d39SAndroid Build Coastguard Worker virtual void adoptTimeZoneFormat(TimeZoneFormat* timeZoneFormatToAdopt);
781*0e209d39SAndroid Build Coastguard Worker
782*0e209d39SAndroid Build Coastguard Worker /**
783*0e209d39SAndroid Build Coastguard Worker * Sets the TimeZoneFormat to be used by this date/time formatter.
784*0e209d39SAndroid Build Coastguard Worker * @param newTimeZoneFormat The TimeZoneFormat object to copy.
785*0e209d39SAndroid Build Coastguard Worker * @internal ICU 49 technology preview
786*0e209d39SAndroid Build Coastguard Worker */
787*0e209d39SAndroid Build Coastguard Worker virtual void setTimeZoneFormat(const TimeZoneFormat& newTimeZoneFormat);
788*0e209d39SAndroid Build Coastguard Worker
789*0e209d39SAndroid Build Coastguard Worker /**
790*0e209d39SAndroid Build Coastguard Worker * Gets the time zone format object associated with this date/time formatter.
791*0e209d39SAndroid Build Coastguard Worker * @return the time zone format associated with this date/time formatter.
792*0e209d39SAndroid Build Coastguard Worker * @internal ICU 49 technology preview
793*0e209d39SAndroid Build Coastguard Worker */
794*0e209d39SAndroid Build Coastguard Worker virtual const TimeZoneFormat* getTimeZoneFormat() const;
795*0e209d39SAndroid Build Coastguard Worker
796*0e209d39SAndroid Build Coastguard Worker /**
797*0e209d39SAndroid Build Coastguard Worker * Set a particular UDisplayContext value in the formatter, such as
798*0e209d39SAndroid Build Coastguard Worker * UDISPCTX_CAPITALIZATION_FOR_STANDALONE. Note: For getContext, see
799*0e209d39SAndroid Build Coastguard Worker * DateFormat.
800*0e209d39SAndroid Build Coastguard Worker * @param value The UDisplayContext value to set.
801*0e209d39SAndroid Build Coastguard Worker * @param status Input/output status. If at entry this indicates a failure
802*0e209d39SAndroid Build Coastguard Worker * status, the function will do nothing; otherwise this will be
803*0e209d39SAndroid Build Coastguard Worker * updated with any new status from the function.
804*0e209d39SAndroid Build Coastguard Worker * @stable ICU 53
805*0e209d39SAndroid Build Coastguard Worker */
806*0e209d39SAndroid Build Coastguard Worker virtual void setContext(UDisplayContext value, UErrorCode& status) override;
807*0e209d39SAndroid Build Coastguard Worker
808*0e209d39SAndroid Build Coastguard Worker /**
809*0e209d39SAndroid Build Coastguard Worker * Overrides base class method and
810*0e209d39SAndroid Build Coastguard Worker * This method clears per field NumberFormat instances
811*0e209d39SAndroid Build Coastguard Worker * previously set by {@see adoptNumberFormat(const UnicodeString&, NumberFormat*, UErrorCode)}
812*0e209d39SAndroid Build Coastguard Worker * @param formatToAdopt the NumbeferFormat used
813*0e209d39SAndroid Build Coastguard Worker * @stable ICU 54
814*0e209d39SAndroid Build Coastguard Worker */
815*0e209d39SAndroid Build Coastguard Worker void adoptNumberFormat(NumberFormat *formatToAdopt) override;
816*0e209d39SAndroid Build Coastguard Worker
817*0e209d39SAndroid Build Coastguard Worker /**
818*0e209d39SAndroid Build Coastguard Worker * Allow the user to set the NumberFormat for several fields
819*0e209d39SAndroid Build Coastguard Worker * It can be a single field like: "y"(year) or "M"(month)
820*0e209d39SAndroid Build Coastguard Worker * It can be several field combined together: "yM"(year and month)
821*0e209d39SAndroid Build Coastguard Worker * Note:
822*0e209d39SAndroid Build Coastguard Worker * 1 symbol field is enough for multiple symbol field (so "y" will override "yy", "yyy")
823*0e209d39SAndroid Build Coastguard Worker * If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field)
824*0e209d39SAndroid Build Coastguard Worker * Per field NumberFormat can also be cleared in {@see DateFormat::setNumberFormat(const NumberFormat& newNumberFormat)}
825*0e209d39SAndroid Build Coastguard Worker *
826*0e209d39SAndroid Build Coastguard Worker * @param fields the fields to override(like y)
827*0e209d39SAndroid Build Coastguard Worker * @param formatToAdopt the NumbeferFormat used
828*0e209d39SAndroid Build Coastguard Worker * @param status Receives a status code, which will be U_ZERO_ERROR
829*0e209d39SAndroid Build Coastguard Worker * if the operation succeeds.
830*0e209d39SAndroid Build Coastguard Worker * @stable ICU 54
831*0e209d39SAndroid Build Coastguard Worker */
832*0e209d39SAndroid Build Coastguard Worker void adoptNumberFormat(const UnicodeString& fields, NumberFormat *formatToAdopt, UErrorCode &status);
833*0e209d39SAndroid Build Coastguard Worker
834*0e209d39SAndroid Build Coastguard Worker /**
835*0e209d39SAndroid Build Coastguard Worker * Get the numbering system to be used for a particular field.
836*0e209d39SAndroid Build Coastguard Worker * @param field The UDateFormatField to get
837*0e209d39SAndroid Build Coastguard Worker * @stable ICU 54
838*0e209d39SAndroid Build Coastguard Worker */
839*0e209d39SAndroid Build Coastguard Worker const NumberFormat * getNumberFormatForField(char16_t field) const;
840*0e209d39SAndroid Build Coastguard Worker
841*0e209d39SAndroid Build Coastguard Worker #ifndef U_HIDE_INTERNAL_API
842*0e209d39SAndroid Build Coastguard Worker /**
843*0e209d39SAndroid Build Coastguard Worker * This is for ICU internal use only. Please do not use.
844*0e209d39SAndroid Build Coastguard Worker * Check whether the 'field' is smaller than all the fields covered in
845*0e209d39SAndroid Build Coastguard Worker * pattern, return true if it is. The sequence of calendar field,
846*0e209d39SAndroid Build Coastguard Worker * from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...
847*0e209d39SAndroid Build Coastguard Worker * @param field the calendar field need to check against
848*0e209d39SAndroid Build Coastguard Worker * @return true if the 'field' is smaller than all the fields
849*0e209d39SAndroid Build Coastguard Worker * covered in pattern. false otherwise.
850*0e209d39SAndroid Build Coastguard Worker * @internal ICU 4.0
851*0e209d39SAndroid Build Coastguard Worker */
852*0e209d39SAndroid Build Coastguard Worker UBool isFieldUnitIgnored(UCalendarDateFields field) const;
853*0e209d39SAndroid Build Coastguard Worker
854*0e209d39SAndroid Build Coastguard Worker
855*0e209d39SAndroid Build Coastguard Worker /**
856*0e209d39SAndroid Build Coastguard Worker * This is for ICU internal use only. Please do not use.
857*0e209d39SAndroid Build Coastguard Worker * Check whether the 'field' is smaller than all the fields covered in
858*0e209d39SAndroid Build Coastguard Worker * pattern, return true if it is. The sequence of calendar field,
859*0e209d39SAndroid Build Coastguard Worker * from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...
860*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern to check against
861*0e209d39SAndroid Build Coastguard Worker * @param field the calendar field need to check against
862*0e209d39SAndroid Build Coastguard Worker * @return true if the 'field' is smaller than all the fields
863*0e209d39SAndroid Build Coastguard Worker * covered in pattern. false otherwise.
864*0e209d39SAndroid Build Coastguard Worker * @internal ICU 4.0
865*0e209d39SAndroid Build Coastguard Worker */
866*0e209d39SAndroid Build Coastguard Worker static UBool isFieldUnitIgnored(const UnicodeString& pattern,
867*0e209d39SAndroid Build Coastguard Worker UCalendarDateFields field);
868*0e209d39SAndroid Build Coastguard Worker
869*0e209d39SAndroid Build Coastguard Worker /**
870*0e209d39SAndroid Build Coastguard Worker * This is for ICU internal use only. Please do not use.
871*0e209d39SAndroid Build Coastguard Worker * Get the locale of this simple date formatter.
872*0e209d39SAndroid Build Coastguard Worker * It is used in DateIntervalFormat.
873*0e209d39SAndroid Build Coastguard Worker *
874*0e209d39SAndroid Build Coastguard Worker * @return locale in this simple date formatter
875*0e209d39SAndroid Build Coastguard Worker * @internal ICU 4.0
876*0e209d39SAndroid Build Coastguard Worker */
877*0e209d39SAndroid Build Coastguard Worker const Locale& getSmpFmtLocale() const;
878*0e209d39SAndroid Build Coastguard Worker #endif /* U_HIDE_INTERNAL_API */
879*0e209d39SAndroid Build Coastguard Worker
880*0e209d39SAndroid Build Coastguard Worker private:
881*0e209d39SAndroid Build Coastguard Worker friend class DateFormat;
882*0e209d39SAndroid Build Coastguard Worker friend class DateIntervalFormat;
883*0e209d39SAndroid Build Coastguard Worker
884*0e209d39SAndroid Build Coastguard Worker void initializeDefaultCentury();
885*0e209d39SAndroid Build Coastguard Worker
886*0e209d39SAndroid Build Coastguard Worker void initializeBooleanAttributes();
887*0e209d39SAndroid Build Coastguard Worker
888*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat() = delete; // default constructor not implemented
889*0e209d39SAndroid Build Coastguard Worker
890*0e209d39SAndroid Build Coastguard Worker /**
891*0e209d39SAndroid Build Coastguard Worker * Used by the DateFormat factory methods to construct a SimpleDateFormat.
892*0e209d39SAndroid Build Coastguard Worker * @param timeStyle the time style.
893*0e209d39SAndroid Build Coastguard Worker * @param dateStyle the date style.
894*0e209d39SAndroid Build Coastguard Worker * @param locale the given locale.
895*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code on
896*0e209d39SAndroid Build Coastguard Worker * exit.
897*0e209d39SAndroid Build Coastguard Worker */
898*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(EStyle timeStyle, EStyle dateStyle, const Locale& locale, UErrorCode& status);
899*0e209d39SAndroid Build Coastguard Worker
900*0e209d39SAndroid Build Coastguard Worker /**
901*0e209d39SAndroid Build Coastguard Worker * Construct a SimpleDateFormat for the given locale. If no resource data
902*0e209d39SAndroid Build Coastguard Worker * is available, create an object of last resort, using hard-coded strings.
903*0e209d39SAndroid Build Coastguard Worker * This is an internal method, called by DateFormat. It should never fail.
904*0e209d39SAndroid Build Coastguard Worker * @param locale the given locale.
905*0e209d39SAndroid Build Coastguard Worker * @param status Output param set to success/failure code on
906*0e209d39SAndroid Build Coastguard Worker * exit.
907*0e209d39SAndroid Build Coastguard Worker */
908*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat(const Locale& locale, UErrorCode& status); // Use default pattern
909*0e209d39SAndroid Build Coastguard Worker
910*0e209d39SAndroid Build Coastguard Worker /**
911*0e209d39SAndroid Build Coastguard Worker * Hook called by format(... FieldPosition& ...) and format(...FieldPositionIterator&...)
912*0e209d39SAndroid Build Coastguard Worker */
913*0e209d39SAndroid Build Coastguard Worker UnicodeString& _format(Calendar& cal, UnicodeString& appendTo, FieldPositionHandler& handler, UErrorCode& status) const;
914*0e209d39SAndroid Build Coastguard Worker
915*0e209d39SAndroid Build Coastguard Worker /**
916*0e209d39SAndroid Build Coastguard Worker * Called by format() to format a single field.
917*0e209d39SAndroid Build Coastguard Worker *
918*0e209d39SAndroid Build Coastguard Worker * @param appendTo Output parameter to receive result.
919*0e209d39SAndroid Build Coastguard Worker * Result is appended to existing contents.
920*0e209d39SAndroid Build Coastguard Worker * @param ch The format character we encountered in the pattern.
921*0e209d39SAndroid Build Coastguard Worker * @param count Number of characters in the current pattern symbol (e.g.,
922*0e209d39SAndroid Build Coastguard Worker * "yyyy" in the pattern would result in a call to this function
923*0e209d39SAndroid Build Coastguard Worker * with ch equal to 'y' and count equal to 4)
924*0e209d39SAndroid Build Coastguard Worker * @param capitalizationContext Capitalization context for this date format.
925*0e209d39SAndroid Build Coastguard Worker * @param fieldNum Zero-based numbering of current field within the overall format.
926*0e209d39SAndroid Build Coastguard Worker * @param handler Records information about field positions.
927*0e209d39SAndroid Build Coastguard Worker * @param cal Calendar to use
928*0e209d39SAndroid Build Coastguard Worker * @param status Receives a status code, which will be U_ZERO_ERROR if the operation
929*0e209d39SAndroid Build Coastguard Worker * succeeds.
930*0e209d39SAndroid Build Coastguard Worker */
931*0e209d39SAndroid Build Coastguard Worker void subFormat(UnicodeString &appendTo,
932*0e209d39SAndroid Build Coastguard Worker char16_t ch,
933*0e209d39SAndroid Build Coastguard Worker int32_t count,
934*0e209d39SAndroid Build Coastguard Worker UDisplayContext capitalizationContext,
935*0e209d39SAndroid Build Coastguard Worker int32_t fieldNum,
936*0e209d39SAndroid Build Coastguard Worker char16_t fieldToOutput,
937*0e209d39SAndroid Build Coastguard Worker FieldPositionHandler& handler,
938*0e209d39SAndroid Build Coastguard Worker Calendar& cal,
939*0e209d39SAndroid Build Coastguard Worker UErrorCode& status) const; // in case of illegal argument
940*0e209d39SAndroid Build Coastguard Worker
941*0e209d39SAndroid Build Coastguard Worker /**
942*0e209d39SAndroid Build Coastguard Worker * Used by subFormat() to format a numeric value.
943*0e209d39SAndroid Build Coastguard Worker * Appends to toAppendTo a string representation of "value"
944*0e209d39SAndroid Build Coastguard Worker * having a number of digits between "minDigits" and
945*0e209d39SAndroid Build Coastguard Worker * "maxDigits". Uses the DateFormat's NumberFormat.
946*0e209d39SAndroid Build Coastguard Worker *
947*0e209d39SAndroid Build Coastguard Worker * @param currentNumberFormat
948*0e209d39SAndroid Build Coastguard Worker * @param appendTo Output parameter to receive result.
949*0e209d39SAndroid Build Coastguard Worker * Formatted number is appended to existing contents.
950*0e209d39SAndroid Build Coastguard Worker * @param value Value to format.
951*0e209d39SAndroid Build Coastguard Worker * @param minDigits Minimum number of digits the result should have
952*0e209d39SAndroid Build Coastguard Worker * @param maxDigits Maximum number of digits the result should have
953*0e209d39SAndroid Build Coastguard Worker */
954*0e209d39SAndroid Build Coastguard Worker void zeroPaddingNumber(const NumberFormat *currentNumberFormat,
955*0e209d39SAndroid Build Coastguard Worker UnicodeString &appendTo,
956*0e209d39SAndroid Build Coastguard Worker int32_t value,
957*0e209d39SAndroid Build Coastguard Worker int32_t minDigits,
958*0e209d39SAndroid Build Coastguard Worker int32_t maxDigits) const;
959*0e209d39SAndroid Build Coastguard Worker
960*0e209d39SAndroid Build Coastguard Worker /**
961*0e209d39SAndroid Build Coastguard Worker * Return true if the given format character, occurring count
962*0e209d39SAndroid Build Coastguard Worker * times, represents a numeric field.
963*0e209d39SAndroid Build Coastguard Worker */
964*0e209d39SAndroid Build Coastguard Worker static UBool isNumeric(char16_t formatChar, int32_t count);
965*0e209d39SAndroid Build Coastguard Worker
966*0e209d39SAndroid Build Coastguard Worker /**
967*0e209d39SAndroid Build Coastguard Worker * Returns true if the patternOffset is at the start of a numeric field.
968*0e209d39SAndroid Build Coastguard Worker */
969*0e209d39SAndroid Build Coastguard Worker static UBool isAtNumericField(const UnicodeString &pattern, int32_t patternOffset);
970*0e209d39SAndroid Build Coastguard Worker
971*0e209d39SAndroid Build Coastguard Worker /**
972*0e209d39SAndroid Build Coastguard Worker * Returns true if the patternOffset is right after a non-numeric field.
973*0e209d39SAndroid Build Coastguard Worker */
974*0e209d39SAndroid Build Coastguard Worker static UBool isAfterNonNumericField(const UnicodeString &pattern, int32_t patternOffset);
975*0e209d39SAndroid Build Coastguard Worker
976*0e209d39SAndroid Build Coastguard Worker /**
977*0e209d39SAndroid Build Coastguard Worker * initializes fCalendar from parameters. Returns fCalendar as a convenience.
978*0e209d39SAndroid Build Coastguard Worker * @param adoptZone Zone to be adopted, or nullptr for TimeZone::createDefault().
979*0e209d39SAndroid Build Coastguard Worker * @param locale Locale of the calendar
980*0e209d39SAndroid Build Coastguard Worker * @param status Error code
981*0e209d39SAndroid Build Coastguard Worker * @return the newly constructed fCalendar
982*0e209d39SAndroid Build Coastguard Worker */
983*0e209d39SAndroid Build Coastguard Worker Calendar *initializeCalendar(TimeZone* adoptZone, const Locale& locale, UErrorCode& status);
984*0e209d39SAndroid Build Coastguard Worker
985*0e209d39SAndroid Build Coastguard Worker /**
986*0e209d39SAndroid Build Coastguard Worker * Called by several of the constructors to load pattern data and formatting symbols
987*0e209d39SAndroid Build Coastguard Worker * out of a resource bundle and initialize the locale based on it.
988*0e209d39SAndroid Build Coastguard Worker * @param timeStyle The time style, as passed to DateFormat::createDateInstance().
989*0e209d39SAndroid Build Coastguard Worker * @param dateStyle The date style, as passed to DateFormat::createTimeInstance().
990*0e209d39SAndroid Build Coastguard Worker * @param locale The locale to load the patterns from.
991*0e209d39SAndroid Build Coastguard Worker * @param status Filled in with an error code if loading the data from the
992*0e209d39SAndroid Build Coastguard Worker * resources fails.
993*0e209d39SAndroid Build Coastguard Worker */
994*0e209d39SAndroid Build Coastguard Worker void construct(EStyle timeStyle, EStyle dateStyle, const Locale& locale, UErrorCode& status);
995*0e209d39SAndroid Build Coastguard Worker
996*0e209d39SAndroid Build Coastguard Worker /**
997*0e209d39SAndroid Build Coastguard Worker * Called by construct() and the various constructors to set up the SimpleDateFormat's
998*0e209d39SAndroid Build Coastguard Worker * Calendar and NumberFormat objects.
999*0e209d39SAndroid Build Coastguard Worker * @param locale The locale for which we want a Calendar and a NumberFormat.
1000*0e209d39SAndroid Build Coastguard Worker * @param status Filled in with an error code if creating either subobject fails.
1001*0e209d39SAndroid Build Coastguard Worker */
1002*0e209d39SAndroid Build Coastguard Worker void initialize(const Locale& locale, UErrorCode& status);
1003*0e209d39SAndroid Build Coastguard Worker
1004*0e209d39SAndroid Build Coastguard Worker /**
1005*0e209d39SAndroid Build Coastguard Worker * Private code-size reduction function used by subParse.
1006*0e209d39SAndroid Build Coastguard Worker * @param text the time text being parsed.
1007*0e209d39SAndroid Build Coastguard Worker * @param start where to start parsing.
1008*0e209d39SAndroid Build Coastguard Worker * @param field the date field being parsed.
1009*0e209d39SAndroid Build Coastguard Worker * @param stringArray the string array to parsed.
1010*0e209d39SAndroid Build Coastguard Worker * @param stringArrayCount the size of the array.
1011*0e209d39SAndroid Build Coastguard Worker * @param monthPattern pointer to leap month pattern, or nullptr if none.
1012*0e209d39SAndroid Build Coastguard Worker * @param cal a Calendar set to the date and time to be formatted
1013*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
1014*0e209d39SAndroid Build Coastguard Worker * @return the new start position if matching succeeded; a negative number
1015*0e209d39SAndroid Build Coastguard Worker * indicating matching failure, otherwise.
1016*0e209d39SAndroid Build Coastguard Worker */
1017*0e209d39SAndroid Build Coastguard Worker int32_t matchString(const UnicodeString& text, int32_t start, UCalendarDateFields field,
1018*0e209d39SAndroid Build Coastguard Worker const UnicodeString* stringArray, int32_t stringArrayCount,
1019*0e209d39SAndroid Build Coastguard Worker const UnicodeString* monthPattern, Calendar& cal) const;
1020*0e209d39SAndroid Build Coastguard Worker
1021*0e209d39SAndroid Build Coastguard Worker /**
1022*0e209d39SAndroid Build Coastguard Worker * Private code-size reduction function used by subParse. Only for UCAL_MONTH
1023*0e209d39SAndroid Build Coastguard Worker * @param text the time text being parsed.
1024*0e209d39SAndroid Build Coastguard Worker * @param start where to start parsing.
1025*0e209d39SAndroid Build Coastguard Worker * @param wideStringArray the wide string array to parsed.
1026*0e209d39SAndroid Build Coastguard Worker * @param shortStringArray the short string array to parsed.
1027*0e209d39SAndroid Build Coastguard Worker * @param stringArrayCount the size of the string arrays.
1028*0e209d39SAndroid Build Coastguard Worker * @param cal a Calendar set to the date and time to be formatted
1029*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
1030*0e209d39SAndroid Build Coastguard Worker * @return the new start position if matching succeeded; a negative number
1031*0e209d39SAndroid Build Coastguard Worker * indicating matching failure, otherwise.
1032*0e209d39SAndroid Build Coastguard Worker */
1033*0e209d39SAndroid Build Coastguard Worker int32_t matchAlphaMonthStrings(const UnicodeString& text, int32_t start,
1034*0e209d39SAndroid Build Coastguard Worker const UnicodeString* wideStringArray, const UnicodeString* shortStringArray,
1035*0e209d39SAndroid Build Coastguard Worker int32_t stringArrayCount, Calendar& cal) const;
1036*0e209d39SAndroid Build Coastguard Worker
1037*0e209d39SAndroid Build Coastguard Worker /**
1038*0e209d39SAndroid Build Coastguard Worker * Private code-size reduction function used by subParse.
1039*0e209d39SAndroid Build Coastguard Worker * @param text the time text being parsed.
1040*0e209d39SAndroid Build Coastguard Worker * @param start where to start parsing.
1041*0e209d39SAndroid Build Coastguard Worker * @param field the date field being parsed.
1042*0e209d39SAndroid Build Coastguard Worker * @param stringArray the string array to parsed.
1043*0e209d39SAndroid Build Coastguard Worker * @param stringArrayCount the size of the array.
1044*0e209d39SAndroid Build Coastguard Worker * @param cal a Calendar set to the date and time to be formatted
1045*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
1046*0e209d39SAndroid Build Coastguard Worker * @return the new start position if matching succeeded; a negative number
1047*0e209d39SAndroid Build Coastguard Worker * indicating matching failure, otherwise.
1048*0e209d39SAndroid Build Coastguard Worker */
1049*0e209d39SAndroid Build Coastguard Worker int32_t matchQuarterString(const UnicodeString& text, int32_t start, UCalendarDateFields field,
1050*0e209d39SAndroid Build Coastguard Worker const UnicodeString* stringArray, int32_t stringArrayCount, Calendar& cal) const;
1051*0e209d39SAndroid Build Coastguard Worker
1052*0e209d39SAndroid Build Coastguard Worker /**
1053*0e209d39SAndroid Build Coastguard Worker * Used by subParse() to match localized day period strings.
1054*0e209d39SAndroid Build Coastguard Worker */
1055*0e209d39SAndroid Build Coastguard Worker int32_t matchDayPeriodStrings(const UnicodeString& text, int32_t start,
1056*0e209d39SAndroid Build Coastguard Worker const UnicodeString* stringArray, int32_t stringArrayCount,
1057*0e209d39SAndroid Build Coastguard Worker int32_t &dayPeriod) const;
1058*0e209d39SAndroid Build Coastguard Worker
1059*0e209d39SAndroid Build Coastguard Worker /**
1060*0e209d39SAndroid Build Coastguard Worker * Private function used by subParse to match literal pattern text.
1061*0e209d39SAndroid Build Coastguard Worker *
1062*0e209d39SAndroid Build Coastguard Worker * @param pattern the pattern string
1063*0e209d39SAndroid Build Coastguard Worker * @param patternOffset the starting offset into the pattern text. On
1064*0e209d39SAndroid Build Coastguard Worker * output will be set the offset of the first non-literal character in the pattern
1065*0e209d39SAndroid Build Coastguard Worker * @param text the text being parsed
1066*0e209d39SAndroid Build Coastguard Worker * @param textOffset the starting offset into the text. On output
1067*0e209d39SAndroid Build Coastguard Worker * will be set to the offset of the character after the match
1068*0e209d39SAndroid Build Coastguard Worker * @param whitespaceLenient <code>true</code> if whitespace parse is lenient, <code>false</code> otherwise.
1069*0e209d39SAndroid Build Coastguard Worker * @param partialMatchLenient <code>true</code> if partial match parse is lenient, <code>false</code> otherwise.
1070*0e209d39SAndroid Build Coastguard Worker * @param oldLeniency <code>true</code> if old leniency control is lenient, <code>false</code> otherwise.
1071*0e209d39SAndroid Build Coastguard Worker *
1072*0e209d39SAndroid Build Coastguard Worker * @return <code>true</code> if the literal text could be matched, <code>false</code> otherwise.
1073*0e209d39SAndroid Build Coastguard Worker */
1074*0e209d39SAndroid Build Coastguard Worker static UBool matchLiterals(const UnicodeString &pattern, int32_t &patternOffset,
1075*0e209d39SAndroid Build Coastguard Worker const UnicodeString &text, int32_t &textOffset,
1076*0e209d39SAndroid Build Coastguard Worker UBool whitespaceLenient, UBool partialMatchLenient, UBool oldLeniency);
1077*0e209d39SAndroid Build Coastguard Worker
1078*0e209d39SAndroid Build Coastguard Worker /**
1079*0e209d39SAndroid Build Coastguard Worker * Private member function that converts the parsed date strings into
1080*0e209d39SAndroid Build Coastguard Worker * timeFields. Returns -start (for ParsePosition) if failed.
1081*0e209d39SAndroid Build Coastguard Worker * @param text the time text to be parsed.
1082*0e209d39SAndroid Build Coastguard Worker * @param start where to start parsing.
1083*0e209d39SAndroid Build Coastguard Worker * @param ch the pattern character for the date field text to be parsed.
1084*0e209d39SAndroid Build Coastguard Worker * @param count the count of a pattern character.
1085*0e209d39SAndroid Build Coastguard Worker * @param obeyCount if true then the count is strictly obeyed.
1086*0e209d39SAndroid Build Coastguard Worker * @param allowNegative
1087*0e209d39SAndroid Build Coastguard Worker * @param ambiguousYear If true then the two-digit year == the default start year.
1088*0e209d39SAndroid Build Coastguard Worker * @param saveHebrewMonth Used to hang onto month until year is known.
1089*0e209d39SAndroid Build Coastguard Worker * @param cal a Calendar set to the date and time to be formatted
1090*0e209d39SAndroid Build Coastguard Worker * into a date/time string.
1091*0e209d39SAndroid Build Coastguard Worker * @param patLoc
1092*0e209d39SAndroid Build Coastguard Worker * @param numericLeapMonthFormatter If non-null, used to parse numeric leap months.
1093*0e209d39SAndroid Build Coastguard Worker * @param tzTimeType the type of parsed time zone - standard, daylight or unknown (output).
1094*0e209d39SAndroid Build Coastguard Worker * This parameter can be nullptr if caller does not need the information.
1095*0e209d39SAndroid Build Coastguard Worker * @return the new start position if matching succeeded; a negative number
1096*0e209d39SAndroid Build Coastguard Worker * indicating matching failure, otherwise.
1097*0e209d39SAndroid Build Coastguard Worker */
1098*0e209d39SAndroid Build Coastguard Worker int32_t subParse(const UnicodeString& text, int32_t& start, char16_t ch, int32_t count,
1099*0e209d39SAndroid Build Coastguard Worker UBool obeyCount, UBool allowNegative, UBool ambiguousYear[], int32_t& saveHebrewMonth, Calendar& cal,
1100*0e209d39SAndroid Build Coastguard Worker int32_t patLoc, MessageFormat * numericLeapMonthFormatter, UTimeZoneFormatTimeType *tzTimeType,
1101*0e209d39SAndroid Build Coastguard Worker int32_t *dayPeriod=nullptr) const;
1102*0e209d39SAndroid Build Coastguard Worker
1103*0e209d39SAndroid Build Coastguard Worker void parseInt(const UnicodeString& text,
1104*0e209d39SAndroid Build Coastguard Worker Formattable& number,
1105*0e209d39SAndroid Build Coastguard Worker ParsePosition& pos,
1106*0e209d39SAndroid Build Coastguard Worker UBool allowNegative,
1107*0e209d39SAndroid Build Coastguard Worker const NumberFormat *fmt) const;
1108*0e209d39SAndroid Build Coastguard Worker
1109*0e209d39SAndroid Build Coastguard Worker void parseInt(const UnicodeString& text,
1110*0e209d39SAndroid Build Coastguard Worker Formattable& number,
1111*0e209d39SAndroid Build Coastguard Worker int32_t maxDigits,
1112*0e209d39SAndroid Build Coastguard Worker ParsePosition& pos,
1113*0e209d39SAndroid Build Coastguard Worker UBool allowNegative,
1114*0e209d39SAndroid Build Coastguard Worker const NumberFormat *fmt) const;
1115*0e209d39SAndroid Build Coastguard Worker
1116*0e209d39SAndroid Build Coastguard Worker int32_t checkIntSuffix(const UnicodeString& text, int32_t start,
1117*0e209d39SAndroid Build Coastguard Worker int32_t patLoc, UBool isNegative) const;
1118*0e209d39SAndroid Build Coastguard Worker
1119*0e209d39SAndroid Build Coastguard Worker /**
1120*0e209d39SAndroid Build Coastguard Worker * Counts number of digit code points in the specified text.
1121*0e209d39SAndroid Build Coastguard Worker *
1122*0e209d39SAndroid Build Coastguard Worker * @param text input text
1123*0e209d39SAndroid Build Coastguard Worker * @param start start index, inclusive
1124*0e209d39SAndroid Build Coastguard Worker * @param end end index, exclusive
1125*0e209d39SAndroid Build Coastguard Worker * @return number of digits found in the text in the specified range.
1126*0e209d39SAndroid Build Coastguard Worker */
1127*0e209d39SAndroid Build Coastguard Worker int32_t countDigits(const UnicodeString& text, int32_t start, int32_t end) const;
1128*0e209d39SAndroid Build Coastguard Worker
1129*0e209d39SAndroid Build Coastguard Worker /**
1130*0e209d39SAndroid Build Coastguard Worker * Translate a pattern, mapping each character in the from string to the
1131*0e209d39SAndroid Build Coastguard Worker * corresponding character in the to string. Return an error if the original
1132*0e209d39SAndroid Build Coastguard Worker * pattern contains an unmapped character, or if a quote is unmatched.
1133*0e209d39SAndroid Build Coastguard Worker * Quoted (single quotes only) material is not translated.
1134*0e209d39SAndroid Build Coastguard Worker * @param originalPattern the original pattern.
1135*0e209d39SAndroid Build Coastguard Worker * @param translatedPattern Output param to receive the translited pattern.
1136*0e209d39SAndroid Build Coastguard Worker * @param from the characters to be translited from.
1137*0e209d39SAndroid Build Coastguard Worker * @param to the characters to be translited to.
1138*0e209d39SAndroid Build Coastguard Worker * @param status Receives a status code, which will be U_ZERO_ERROR
1139*0e209d39SAndroid Build Coastguard Worker * if the operation succeeds.
1140*0e209d39SAndroid Build Coastguard Worker */
1141*0e209d39SAndroid Build Coastguard Worker static void translatePattern(const UnicodeString& originalPattern,
1142*0e209d39SAndroid Build Coastguard Worker UnicodeString& translatedPattern,
1143*0e209d39SAndroid Build Coastguard Worker const UnicodeString& from,
1144*0e209d39SAndroid Build Coastguard Worker const UnicodeString& to,
1145*0e209d39SAndroid Build Coastguard Worker UErrorCode& status);
1146*0e209d39SAndroid Build Coastguard Worker
1147*0e209d39SAndroid Build Coastguard Worker /**
1148*0e209d39SAndroid Build Coastguard Worker * Sets the starting date of the 100-year window that dates with 2-digit years
1149*0e209d39SAndroid Build Coastguard Worker * are considered to fall within.
1150*0e209d39SAndroid Build Coastguard Worker * @param startDate the start date
1151*0e209d39SAndroid Build Coastguard Worker * @param status Receives a status code, which will be U_ZERO_ERROR
1152*0e209d39SAndroid Build Coastguard Worker * if the operation succeeds.
1153*0e209d39SAndroid Build Coastguard Worker */
1154*0e209d39SAndroid Build Coastguard Worker void parseAmbiguousDatesAsAfter(UDate startDate, UErrorCode& status);
1155*0e209d39SAndroid Build Coastguard Worker
1156*0e209d39SAndroid Build Coastguard Worker /**
1157*0e209d39SAndroid Build Coastguard Worker * Return the length matched by the given affix, or -1 if none.
1158*0e209d39SAndroid Build Coastguard Worker * Runs of white space in the affix, match runs of white space in
1159*0e209d39SAndroid Build Coastguard Worker * the input.
1160*0e209d39SAndroid Build Coastguard Worker * @param affix pattern string, taken as a literal
1161*0e209d39SAndroid Build Coastguard Worker * @param input input text
1162*0e209d39SAndroid Build Coastguard Worker * @param pos offset into input at which to begin matching
1163*0e209d39SAndroid Build Coastguard Worker * @return length of input that matches, or -1 if match failure
1164*0e209d39SAndroid Build Coastguard Worker */
1165*0e209d39SAndroid Build Coastguard Worker int32_t compareSimpleAffix(const UnicodeString& affix,
1166*0e209d39SAndroid Build Coastguard Worker const UnicodeString& input,
1167*0e209d39SAndroid Build Coastguard Worker int32_t pos) const;
1168*0e209d39SAndroid Build Coastguard Worker
1169*0e209d39SAndroid Build Coastguard Worker /**
1170*0e209d39SAndroid Build Coastguard Worker * Skip over a run of zero or more Pattern_White_Space characters at
1171*0e209d39SAndroid Build Coastguard Worker * pos in text.
1172*0e209d39SAndroid Build Coastguard Worker */
1173*0e209d39SAndroid Build Coastguard Worker int32_t skipPatternWhiteSpace(const UnicodeString& text, int32_t pos) const;
1174*0e209d39SAndroid Build Coastguard Worker
1175*0e209d39SAndroid Build Coastguard Worker /**
1176*0e209d39SAndroid Build Coastguard Worker * Skip over a run of zero or more isUWhiteSpace() characters at pos
1177*0e209d39SAndroid Build Coastguard Worker * in text.
1178*0e209d39SAndroid Build Coastguard Worker */
1179*0e209d39SAndroid Build Coastguard Worker int32_t skipUWhiteSpace(const UnicodeString& text, int32_t pos) const;
1180*0e209d39SAndroid Build Coastguard Worker
1181*0e209d39SAndroid Build Coastguard Worker /**
1182*0e209d39SAndroid Build Coastguard Worker * Initialize SimpleNumberFormat instance
1183*0e209d39SAndroid Build Coastguard Worker */
1184*0e209d39SAndroid Build Coastguard Worker void initSimpleNumberFormatter(UErrorCode &status);
1185*0e209d39SAndroid Build Coastguard Worker
1186*0e209d39SAndroid Build Coastguard Worker /**
1187*0e209d39SAndroid Build Coastguard Worker * Initialize NumberFormat instances used for numbering system overrides.
1188*0e209d39SAndroid Build Coastguard Worker */
1189*0e209d39SAndroid Build Coastguard Worker void initNumberFormatters(const Locale &locale,UErrorCode &status);
1190*0e209d39SAndroid Build Coastguard Worker
1191*0e209d39SAndroid Build Coastguard Worker /**
1192*0e209d39SAndroid Build Coastguard Worker * Parse the given override string and set up structures for number formats
1193*0e209d39SAndroid Build Coastguard Worker */
1194*0e209d39SAndroid Build Coastguard Worker void processOverrideString(const Locale &locale, const UnicodeString &str, int8_t type, UErrorCode &status);
1195*0e209d39SAndroid Build Coastguard Worker
1196*0e209d39SAndroid Build Coastguard Worker /**
1197*0e209d39SAndroid Build Coastguard Worker * Used to map pattern characters to Calendar field identifiers.
1198*0e209d39SAndroid Build Coastguard Worker */
1199*0e209d39SAndroid Build Coastguard Worker static const UCalendarDateFields fgPatternIndexToCalendarField[];
1200*0e209d39SAndroid Build Coastguard Worker
1201*0e209d39SAndroid Build Coastguard Worker /**
1202*0e209d39SAndroid Build Coastguard Worker * Map index into pattern character string to DateFormat field number
1203*0e209d39SAndroid Build Coastguard Worker */
1204*0e209d39SAndroid Build Coastguard Worker static const UDateFormatField fgPatternIndexToDateFormatField[];
1205*0e209d39SAndroid Build Coastguard Worker
1206*0e209d39SAndroid Build Coastguard Worker /**
1207*0e209d39SAndroid Build Coastguard Worker * Lazy TimeZoneFormat instantiation, semantically const
1208*0e209d39SAndroid Build Coastguard Worker */
1209*0e209d39SAndroid Build Coastguard Worker TimeZoneFormat *tzFormat(UErrorCode &status) const;
1210*0e209d39SAndroid Build Coastguard Worker
1211*0e209d39SAndroid Build Coastguard Worker const NumberFormat* getNumberFormatByIndex(UDateFormatField index) const;
1212*0e209d39SAndroid Build Coastguard Worker
1213*0e209d39SAndroid Build Coastguard Worker /**
1214*0e209d39SAndroid Build Coastguard Worker * Used to map Calendar field to field level.
1215*0e209d39SAndroid Build Coastguard Worker * The larger the level, the smaller the field unit.
1216*0e209d39SAndroid Build Coastguard Worker * For example, UCAL_ERA level is 0, UCAL_YEAR level is 10,
1217*0e209d39SAndroid Build Coastguard Worker * UCAL_MONTH level is 20.
1218*0e209d39SAndroid Build Coastguard Worker */
1219*0e209d39SAndroid Build Coastguard Worker static const int32_t fgCalendarFieldToLevel[];
1220*0e209d39SAndroid Build Coastguard Worker
1221*0e209d39SAndroid Build Coastguard Worker /**
1222*0e209d39SAndroid Build Coastguard Worker * Map calendar field letter into calendar field level.
1223*0e209d39SAndroid Build Coastguard Worker */
1224*0e209d39SAndroid Build Coastguard Worker static int32_t getLevelFromChar(char16_t ch);
1225*0e209d39SAndroid Build Coastguard Worker
1226*0e209d39SAndroid Build Coastguard Worker /**
1227*0e209d39SAndroid Build Coastguard Worker * Tell if a character can be used to define a field in a format string.
1228*0e209d39SAndroid Build Coastguard Worker */
1229*0e209d39SAndroid Build Coastguard Worker static UBool isSyntaxChar(char16_t ch);
1230*0e209d39SAndroid Build Coastguard Worker
1231*0e209d39SAndroid Build Coastguard Worker /**
1232*0e209d39SAndroid Build Coastguard Worker * The formatting pattern for this formatter.
1233*0e209d39SAndroid Build Coastguard Worker */
1234*0e209d39SAndroid Build Coastguard Worker UnicodeString fPattern;
1235*0e209d39SAndroid Build Coastguard Worker
1236*0e209d39SAndroid Build Coastguard Worker /**
1237*0e209d39SAndroid Build Coastguard Worker * The numbering system override for dates.
1238*0e209d39SAndroid Build Coastguard Worker */
1239*0e209d39SAndroid Build Coastguard Worker UnicodeString fDateOverride;
1240*0e209d39SAndroid Build Coastguard Worker
1241*0e209d39SAndroid Build Coastguard Worker /**
1242*0e209d39SAndroid Build Coastguard Worker * The numbering system override for times.
1243*0e209d39SAndroid Build Coastguard Worker */
1244*0e209d39SAndroid Build Coastguard Worker UnicodeString fTimeOverride;
1245*0e209d39SAndroid Build Coastguard Worker
1246*0e209d39SAndroid Build Coastguard Worker
1247*0e209d39SAndroid Build Coastguard Worker /**
1248*0e209d39SAndroid Build Coastguard Worker * The original locale used (for reloading symbols)
1249*0e209d39SAndroid Build Coastguard Worker */
1250*0e209d39SAndroid Build Coastguard Worker Locale fLocale;
1251*0e209d39SAndroid Build Coastguard Worker
1252*0e209d39SAndroid Build Coastguard Worker /**
1253*0e209d39SAndroid Build Coastguard Worker * A pointer to an object containing the strings to use in formatting (e.g.,
1254*0e209d39SAndroid Build Coastguard Worker * month and day names, AM and PM strings, time zone names, etc.)
1255*0e209d39SAndroid Build Coastguard Worker */
1256*0e209d39SAndroid Build Coastguard Worker DateFormatSymbols* fSymbols = nullptr; // Owned
1257*0e209d39SAndroid Build Coastguard Worker
1258*0e209d39SAndroid Build Coastguard Worker /**
1259*0e209d39SAndroid Build Coastguard Worker * The time zone formatter
1260*0e209d39SAndroid Build Coastguard Worker */
1261*0e209d39SAndroid Build Coastguard Worker TimeZoneFormat* fTimeZoneFormat = nullptr;
1262*0e209d39SAndroid Build Coastguard Worker
1263*0e209d39SAndroid Build Coastguard Worker /**
1264*0e209d39SAndroid Build Coastguard Worker * If dates have ambiguous years, we map them into the century starting
1265*0e209d39SAndroid Build Coastguard Worker * at defaultCenturyStart, which may be any date. If defaultCenturyStart is
1266*0e209d39SAndroid Build Coastguard Worker * set to SYSTEM_DEFAULT_CENTURY, which it is by default, then the system
1267*0e209d39SAndroid Build Coastguard Worker * values are used. The instance values defaultCenturyStart and
1268*0e209d39SAndroid Build Coastguard Worker * defaultCenturyStartYear are only used if explicitly set by the user
1269*0e209d39SAndroid Build Coastguard Worker * through the API method parseAmbiguousDatesAsAfter().
1270*0e209d39SAndroid Build Coastguard Worker */
1271*0e209d39SAndroid Build Coastguard Worker UDate fDefaultCenturyStart;
1272*0e209d39SAndroid Build Coastguard Worker
1273*0e209d39SAndroid Build Coastguard Worker UBool fHasMinute;
1274*0e209d39SAndroid Build Coastguard Worker UBool fHasSecond;
1275*0e209d39SAndroid Build Coastguard Worker UBool fHasHanYearChar; // pattern contains the Han year character \u5E74
1276*0e209d39SAndroid Build Coastguard Worker
1277*0e209d39SAndroid Build Coastguard Worker /**
1278*0e209d39SAndroid Build Coastguard Worker * Sets fHasMinutes and fHasSeconds.
1279*0e209d39SAndroid Build Coastguard Worker */
1280*0e209d39SAndroid Build Coastguard Worker void parsePattern();
1281*0e209d39SAndroid Build Coastguard Worker
1282*0e209d39SAndroid Build Coastguard Worker /**
1283*0e209d39SAndroid Build Coastguard Worker * See documentation for defaultCenturyStart.
1284*0e209d39SAndroid Build Coastguard Worker */
1285*0e209d39SAndroid Build Coastguard Worker /*transient*/ int32_t fDefaultCenturyStartYear;
1286*0e209d39SAndroid Build Coastguard Worker
1287*0e209d39SAndroid Build Coastguard Worker struct NSOverride : public UMemory {
1288*0e209d39SAndroid Build Coastguard Worker const SharedNumberFormat *snf;
1289*0e209d39SAndroid Build Coastguard Worker int32_t hash;
1290*0e209d39SAndroid Build Coastguard Worker NSOverride *next;
1291*0e209d39SAndroid Build Coastguard Worker void free();
NSOverrideNSOverride1292*0e209d39SAndroid Build Coastguard Worker NSOverride() : snf(nullptr), hash(0), next(nullptr) {
1293*0e209d39SAndroid Build Coastguard Worker }
1294*0e209d39SAndroid Build Coastguard Worker ~NSOverride();
1295*0e209d39SAndroid Build Coastguard Worker };
1296*0e209d39SAndroid Build Coastguard Worker
1297*0e209d39SAndroid Build Coastguard Worker /**
1298*0e209d39SAndroid Build Coastguard Worker * The number format in use for each date field. nullptr means fall back
1299*0e209d39SAndroid Build Coastguard Worker * to fNumberFormat in DateFormat.
1300*0e209d39SAndroid Build Coastguard Worker */
1301*0e209d39SAndroid Build Coastguard Worker const SharedNumberFormat **fSharedNumberFormatters = nullptr;
1302*0e209d39SAndroid Build Coastguard Worker
1303*0e209d39SAndroid Build Coastguard Worker /**
1304*0e209d39SAndroid Build Coastguard Worker * Number formatter pre-allocated for fast performance
1305*0e209d39SAndroid Build Coastguard Worker *
1306*0e209d39SAndroid Build Coastguard Worker * This references the decimal symbols from fNumberFormatter if it is an instance
1307*0e209d39SAndroid Build Coastguard Worker * of DecimalFormat (and is otherwise null). This should always be cleaned up before
1308*0e209d39SAndroid Build Coastguard Worker * destroying fNumberFormatter.
1309*0e209d39SAndroid Build Coastguard Worker */
1310*0e209d39SAndroid Build Coastguard Worker const number::SimpleNumberFormatter* fSimpleNumberFormatter = nullptr;
1311*0e209d39SAndroid Build Coastguard Worker
1312*0e209d39SAndroid Build Coastguard Worker UBool fHaveDefaultCentury;
1313*0e209d39SAndroid Build Coastguard Worker
1314*0e209d39SAndroid Build Coastguard Worker const BreakIterator* fCapitalizationBrkIter = nullptr;
1315*0e209d39SAndroid Build Coastguard Worker };
1316*0e209d39SAndroid Build Coastguard Worker
1317*0e209d39SAndroid Build Coastguard Worker inline UDate
get2DigitYearStart(UErrorCode &)1318*0e209d39SAndroid Build Coastguard Worker SimpleDateFormat::get2DigitYearStart(UErrorCode& /*status*/) const
1319*0e209d39SAndroid Build Coastguard Worker {
1320*0e209d39SAndroid Build Coastguard Worker return fDefaultCenturyStart;
1321*0e209d39SAndroid Build Coastguard Worker }
1322*0e209d39SAndroid Build Coastguard Worker
1323*0e209d39SAndroid Build Coastguard Worker U_NAMESPACE_END
1324*0e209d39SAndroid Build Coastguard Worker
1325*0e209d39SAndroid Build Coastguard Worker #endif /* #if !UCONFIG_NO_FORMATTING */
1326*0e209d39SAndroid Build Coastguard Worker
1327*0e209d39SAndroid Build Coastguard Worker #endif /* U_SHOW_CPLUSPLUS_API */
1328*0e209d39SAndroid Build Coastguard Worker
1329*0e209d39SAndroid Build Coastguard Worker #endif // _SMPDTFMT
1330*0e209d39SAndroid Build Coastguard Worker //eof
1331