#include <smpdtfmt.h>
Inheritance diagram for SimpleDateFormat::
Public Methods | |
SimpleDateFormat (UErrorCode &status) | |
Construct a SimpleDateFormat using the default pattern for the default locale. More... | |
SimpleDateFormat (const UnicodeString &pattern, UErrorCode &status) | |
Construct a SimpleDateFormat using the given pattern and the default locale. More... | |
SimpleDateFormat (const UnicodeString &pattern, const Locale &locale, UErrorCode &status) | |
Construct a SimpleDateFormat using the given pattern and locale. More... | |
SimpleDateFormat (const UnicodeString &pattern, DateFormatSymbols *formatDataToAdopt, UErrorCode &status) | |
Construct a SimpleDateFormat using the given pattern and locale-specific symbol data. More... | |
SimpleDateFormat (const UnicodeString &pattern, const DateFormatSymbols &formatData, UErrorCode &status) | |
Construct a SimpleDateFormat using the given pattern and locale-specific symbol data. More... | |
SimpleDateFormat (const SimpleDateFormat &) | |
Copy constructor. More... | |
SimpleDateFormat & | operator= (const SimpleDateFormat &) |
Assignment operator. More... | |
virtual | ~SimpleDateFormat () |
Destructor. More... | |
virtual Format * | clone (void) const |
Clone this Format object polymorphically. More... | |
virtual UBool | operator== (const Format &other) const |
Return true if the given Format objects are semantically equal. More... | |
virtual UnicodeString & | format (UDate date, UnicodeString &toAppendTo, FieldPosition &pos) const |
Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More... | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &toAppendTo, FieldPosition &pos, UErrorCode &status) const |
Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More... | |
UnicodeString & | format (const Formattable &obj, UnicodeString &result, UErrorCode &status) const |
Redeclared DateFormat method. More... | |
UnicodeString & | format (UDate date, UnicodeString &result) const |
Redeclared DateFormat method. More... | |
virtual UDate | parse (const UnicodeString &text, ParsePosition &pos) const |
Parse a date/time string starting at the given parse position. More... | |
virtual UDate | parse (const UnicodeString &text, UErrorCode &status) const |
Parse a date/time string. More... | |
virtual void | set2DigitYearStart (UDate d, UErrorCode &status) |
Set the start UDate used to interpret two-digit year strings. More... | |
UDate | get2DigitYearStart (UErrorCode &status) const |
Get the start UDate used to interpret two-digit year strings. More... | |
virtual UnicodeString & | toPattern (UnicodeString &result) const |
Return a pattern string describing this date format. More... | |
virtual UnicodeString & | toLocalizedPattern (UnicodeString &result, UErrorCode &status) const |
Return a localized pattern string describing this date format. More... | |
virtual void | applyPattern (const UnicodeString &pattern) |
Apply the given unlocalized pattern string to this date format. More... | |
virtual void | applyLocalizedPattern (const UnicodeString &pattern, UErrorCode &status) |
Apply the given localized pattern string to this date format. More... | |
virtual const DateFormatSymbols * | getDateFormatSymbols (void) const |
Gets the date/time formatting symbols (this is an object carrying the various strings and other symbols used in formatting: e.g., month names and abbreviations, time zone names, AM/PM strings, etc.). More... | |
virtual void | adoptDateFormatSymbols (DateFormatSymbols *newFormatSymbols) |
Set the date/time formatting symbols. More... | |
virtual void | setDateFormatSymbols (const DateFormatSymbols &newFormatSymbols) |
Set the date/time formatting data. More... | |
virtual UClassID | getDynamicClassID (void) const |
Returns a unique class ID POLYMORPHICALLY. More... | |
Static Public Methods | |
UClassID | getStaticClassID (void) |
Return the class ID for this class. More... | |
Static Public Attributes | |
const UDate | fgSystemDefaultCentury |
If a start date is set to this value, that indicates that the system default start is in effect for this instance. More... | |
Private Methods | |
void | initializeDefaultCentury (void) |
Gets the index for the given time zone ID to obtain the timezone strings for formatting. More... | |
SimpleDateFormat (EStyle timeStyle, EStyle dateStyle, const Locale &locale, UErrorCode &status) | |
Used by the DateFormat factory methods to construct a SimpleDateFormat. More... | |
SimpleDateFormat (const Locale &locale, UErrorCode &status) | |
Construct a SimpleDateFormat for the given locale. More... | |
UnicodeString & | subFormat (UnicodeString &result, UChar ch, int32_t count, int32_t beginOffset, FieldPosition &pos, UErrorCode &status) const |
Called by format() to format a single field. More... | |
UnicodeString & | zeroPaddingNumber (UnicodeString &result, int32_t value, int32_t minDigits, int32_t maxDigits) const |
Used by subFormat() to format a numeric value. More... | |
void | construct (EStyle timeStyle, EStyle dateStyle, const Locale &locale, UErrorCode &status) |
Called by several of the constructors to load pattern data and formatting symbols out of a resource bundle and initialize the locale based on it. More... | |
void | initialize (const Locale &locale, UErrorCode &status) |
Called by construct() and the various constructors to set up the SimpleDateFormat's Calendar and NumberFormat objects. More... | |
int32_t | matchString (const UnicodeString &text, UTextOffset start, Calendar::EDateFields field, const UnicodeString *stringArray, int32_t stringArrayCount) const |
Private code-size reduction function used by subParse. More... | |
int32_t | subParse (const UnicodeString &text, int32_t &start, UChar ch, int32_t count, UBool obeyCount, UBool ambiguousYear[]) const |
Private member function that converts the parsed date strings into timeFields. More... | |
void | parseAmbiguousDatesAsAfter (UDate startDate, UErrorCode &status) |
Sets the starting date of the 100-year window that dates with 2-digit years are considered to fall within. More... | |
UDate | internalGetDefaultCenturyStart (void) const |
Returns the beginning date of the 100-year window that dates with 2-digit years are considered to fall within. More... | |
int32_t | internalGetDefaultCenturyStartYear (void) const |
Returns the first year of the 100-year window that dates with 2-digit years are considered to fall within. More... | |
Static Private Methods | |
void | translatePattern (const UnicodeString &originalPattern, UnicodeString &translatedPattern, const UnicodeString &from, const UnicodeString &to, UErrorCode &status) |
Translate a pattern, mapping each character in the from string to the corresponding character in the to string. More... | |
void | initializeSystemDefaultCentury (void) |
Initializes the 100-year window that dates with 2-digit years are considered to fall within so that its start date is 80 years before the current time. More... | |
Private Attributes | |
UnicodeString | fPattern |
The formatting pattern for this formatter. More... | |
DateFormatSymbols * | fSymbols |
A pointer to an object containing the strings to use in formatting (e.g., month and day names, AM and PM strings, time zone names, etc.). More... | |
UDate | fDefaultCenturyStart |
If dates have ambiguous years, we map them into the century starting at defaultCenturyStart, which may be any date. More... | |
int32_t | fDefaultCenturyStartYear |
See documentation for defaultCenturyStart. More... | |
Static Private Attributes | |
const char | fgClassID |
const char | fgDateTimePatternsTag [] |
const UChar | fgDefaultPattern [] |
const UChar | fgGmtPlus [] |
Last-resort string to use for "GMT" when constructing time zone strings. More... | |
const UChar | fgGmtMinus [] |
const UChar | fgGmt [] |
const Calendar::EDateFields | fgPatternIndexToCalendarField [] |
Used to map pattern characters to Calendar field identifiers. More... | |
const DateFormat::EField | fgPatternIndexToDateFormatField [] |
Map index into pattern character string to DateFormat field number. More... | |
UDate | fgSystemDefaultCenturyStart |
The system maintains a static default century start date. More... | |
int32_t | fgSystemDefaultCenturyStartYear |
See documentation for systemDefaultCenturyStart. More... | |
const int32_t | fgSystemDefaultCenturyYear |
Default value that indicates the defaultCenturyStartYear is unitialized. More... | |
Friends | |
class | DateFormat |
It allows for formatting (millis -> text), parsing (text -> millis), and normalization. Formats/Parses a date or time, which is the standard milliseconds since 24:00 GMT, Jan 1, 1970.
Clients are encouraged to create a date-time formatter using DateFormat::getInstance(), getDateInstance(), getDateInstance(), or getDateTimeInstance() rather than explicitly constructing an instance of SimpleDateFormat. This way, the client is guaranteed to get an appropriate formatting pattern for whatever locale the program is running in. However, if the client needs something more unusual than the default patterns in the locales, he can construct a SimpleDateFormat directly and give it an appropriate pattern (or use one of the factory methods on DateFormat and modify the pattern after the fact with toPattern() and applyPattern().
Date/Time format syntax:
The date/time format is specified by means of a string time pattern. In this pattern, all ASCII letters are reserved as pattern letters, which are defined as the following:
The count of pattern letters determine the format.Symbol Meaning Presentation Example ------ ------- ------------ ------- G era designator (Text) AD y year (Number) 1996 Y year/week of year (Number) 1996 M month in year (Text & Number) July & 07 d day in month (Number) 10 h hour in am/pm (1~12) (Number) 12 H hour in day (0~23) (Number) 0 m minute in hour (Number) 30 s second in minute (Number) 55 S millisecond (Number) 978 E day of week (Text) Tuesday e day of week/local (1~7) (Number) 2 D day of year (Number) 189 F day of week in month (Number) 2 (2nd Wed in July) w week in year (Number) 27 W week in month (Number) 2 a am/pm marker (Text) PM k hour in day (1~24) (Number) 24 K hour in am/pm (0~11) (Number) 0 z time zone (Text) Pacific Standard Time ' escape for text '' single quote '
(Text): 4 or more, use full form, <4, use short or abbreviated form if it exists. (e.g., "EEEE" produces "Monday", "EEE" produces "Mon")
(Number): the minimum number of digits. Shorter numbers are zero-padded to this amount (e.g. if "m" produces "6", "mm" produces "06"). Year is handled specially; that is, if the count of 'y' is 2, the Year will be truncated to 2 digits. (e.g., if "yyyy" produces "1997", "yy" produces "97".)
(Text & Number): 3 or over, use text, otherwise use number. (e.g., "M" produces "1", "MM" produces "01", "MMM" produces "Jan", and "MMMM" produces "January".)
Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like ':', '.', ' ', '#' and '@' will appear in the resulting time text even they are not embraced within single quotes.
A pattern containing any invalid pattern letter will result in a failing UErrorCode result during formatting or parsing.
Examples using the US locale:
Code Sample:Format Pattern Result -------------- ------- "yyyy.MM.dd G 'at' HH:mm:ss z" ->> 1996.07.10 AD at 15:08:56 PDT "EEE, MMM d, ''yy" ->> Wed, July 10, '96 "h:mm a" ->> 12:08 PM "hh 'o''clock' a, zzzz" ->> 12 o'clock PM, Pacific Daylight Time "K:mm a, z" ->> 0:00 PM, PST "yyyyy.MMMMM.dd GGG hh:mm aaa" ->> 1996.July.10 AD 12:08 PM
In the above example, the time value "currentTime_2" obtained from parsing will be equal to currentTime_1. However, they may not be equal if the am/pm marker 'a' is left out from the format pattern while the "hour in am/pm" pattern symbol is used. This information loss can happen when formatting the time in PM.UErrorCode success = U_ZERO_ERROR; SimpleTimeZone* pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, "PST"); pdt->setStartRule( Calendar::APRIL, 1, Calendar::SUNDAY, 2*60*60*1000); pdt->setEndRule( Calendar::OCTOBER, -1, Calendar::SUNDAY, 2*60*60*1000); // Format the current time. SimpleDateFormat* formatter = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz", success ); GregorianCalendar cal(success); UDate currentTime_1 = cal.getTime(success); FieldPosition fp(0); UnicodeString dateString; formatter->format( currentTime_1, dateString, fp ); cout << "result: " << dateString << endl; // Parse the previous string back into a Date. ParsePosition pp(0); UDate currentTime_2 = formatter->parse(dateString, pp );
When parsing a date string using the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, as defined by Unicode::isDigit()
, will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isn't all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.
If the year pattern has more than two 'y' characters, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.
For time zones that have no names, SimpleDateFormat uses strings GMT+hours:minutes or GMT-hours:minutes.
The calendar defines what is the first day of the week, the first week of the year, whether hours are zero based or not (0 vs 12 or 24), and the timezone. There is one common number format to handle all the numbers; the digit count is handled programmatically according to the pattern.
Definition at line 175 of file smpdtfmt.h.
|
Construct a SimpleDateFormat using the default pattern for the default locale.
[Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.
|
|
Construct a SimpleDateFormat using the given pattern and the default locale. The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern. [Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.
|
|
Construct a SimpleDateFormat using the given pattern and locale. The locale is used to obtain the symbols used in formatting (e.g., the names of the months), but not to provide the pattern. [Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.
|
|
Construct a SimpleDateFormat using the given pattern and locale-specific symbol data. The formatter takes ownership of the DateFormatSymbols object; the caller is no longer responsible for deleting it.
|
|
Construct a SimpleDateFormat using the given pattern and locale-specific symbol data. The DateFormatSymbols object is NOT adopted; the caller remains responsible for deleting it.
|
|
Copy constructor.
|
|
Destructor.
|
|
Used by the DateFormat factory methods to construct a SimpleDateFormat.
|
|
Construct a SimpleDateFormat for the given locale. If no resource data is available, create an object of last resort, using hard-coded strings. This is an internal method, called by DateFormat. It should never fail. |
|
Set the date/time formatting symbols. The caller no longer owns the DateFormatSymbols object and should not delete it after making this call.
|
|
Apply the given localized pattern string to this date format. (see toLocalizedPattern() for more information on localized patterns.)
|
|
Apply the given unlocalized pattern string to this date format. (i.e., after this call, this formatter will format dates according to the new pattern)
|
|
Clone this Format object polymorphically. The caller owns the result and should delete it when done.
Reimplemented from Format. |
|
Called by several of the constructors to load pattern data and formatting symbols out of a resource bundle and initialize the locale based on it.
|
|
Redeclared DateFormat method.
Reimplemented from DateFormat. Definition at line 749 of file smpdtfmt.h. |
|
Redeclared DateFormat method.
Reimplemented from DateFormat. Definition at line 740 of file smpdtfmt.h. |
|
Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. Overrides DateFormat pure virtual method. Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT
Reimplemented from DateFormat. |
|
Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. Overrides DateFormat pure virtual method. Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT
Reimplemented from DateFormat. |
|
Get the start UDate used to interpret two-digit year strings. When dates are parsed having 2-digit year strings, they are placed within a assumed range of 100 years starting on the two digit start date. For example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or some other year. SimpleDateFormat chooses a year so that the resultant date is on or after the two digit start date and within 100 years of the two digit start date. By default, the two digit start date is set to 80 years before the current time at which a SimpleDateFormat object is created.
Definition at line 734 of file smpdtfmt.h. |
|
Gets the date/time formatting symbols (this is an object carrying the various strings and other symbols used in formatting: e.g., month names and abbreviations, time zone names, AM/PM strings, etc.).
|
|
Returns a unique class ID POLYMORPHICALLY. Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.
Reimplemented from Format. Definition at line 487 of file smpdtfmt.h. |
|
Return the class ID for this class. This is useful only for comparing to a return value from getDynamicClassID(). For example: . Base* polymorphic_pointer = createPolymorphicObject(); . if (polymorphic_pointer->getDynamicClassID() == . erived::getStaticClassID()) ...
Definition at line 474 of file smpdtfmt.h. |
|
Called by construct() and the various constructors to set up the SimpleDateFormat's Calendar and NumberFormat objects.
|
|
Gets the index for the given time zone ID to obtain the timezone strings for formatting. The time zone ID is just for programmatic lookup. NOT LOCALIZED!!!
|
|
Initializes the 100-year window that dates with 2-digit years are considered to fall within so that its start date is 80 years before the current time.
|
|
Returns the beginning date of the 100-year window that dates with 2-digit years are considered to fall within.
|
|
Returns the first year of the 100-year window that dates with 2-digit years are considered to fall within.
|
|
Private code-size reduction function used by subParse.
|
|
Assignment operator.
|
|
Return true if the given Format objects are semantically equal. Objects of different subclasses are considered unequal.
Reimplemented from DateFormat. |
|
Parse a date/time string. For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a UDate that is equivalent to Date(837039928046). Parsing begins at the beginning of the string and proceeds as far as possible. Assuming no parse errors were encountered, this function doesn't return any information about how much of the string was consumed by the parsing. If you need that information, use the version of parse() that takes a ParsePosition.
Reimplemented from DateFormat. |
|
Parse a date/time string starting at the given parse position. For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046). By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).
Reimplemented from DateFormat. |
|
Sets the starting date of the 100-year window that dates with 2-digit years are considered to fall within.
|
|
Set the start UDate used to interpret two-digit year strings. When dates are parsed having 2-digit year strings, they are placed within a assumed range of 100 years starting on the two digit start date. For example, the string "24-Jan-17" may be in the year 1817, 1917, 2017, or some other year. SimpleDateFormat chooses a year so that the resultant date is on or after the two digit start date and within 100 years of the two digit start date. By default, the two digit start date is set to 80 years before the current time at which a SimpleDateFormat object is created.
|
|
Set the date/time formatting data.
|
|
Called by format() to format a single field.
|
|
Private member function that converts the parsed date strings into timeFields. Returns -start (for ParsePosition) if failed.
|
|
Return a localized pattern string describing this date format. In most cases, this will return the same thing as toPattern(), but a locale can specify characters to use in pattern descriptions in place of the ones described in this class's class documentation. (Presumably, letters that would be more mnemonic in that locale's language.) This function would produce a pattern using those letters.
|
|
Return a pattern string describing this date format.
|
|
Translate a pattern, mapping each character in the from string to the corresponding character in the to string. Return an error if the original pattern contains an unmapped character, or if a quote is unmatched. Quoted (single quotes only) material is not translated. |
|
Used by subFormat() to format a numeric value. Fills in "result" with a string representation of "value" having a number of digits between "minDigits" and "maxDigits". Uses the DateFormat's NumberFormat.
|
|
Definition at line 496 of file smpdtfmt.h. |
|
If dates have ambiguous years, we map them into the century starting at defaultCenturyStart, which may be any date. If defaultCenturyStart is set to SYSTEM_DEFAULT_CENTURY, which it is by default, then the system values are used. The instance values defaultCenturyStart and defaultCenturyStartYear are only used if explicitly set by the user through the API method parseAmbiguousDatesAsAfter(). Definition at line 700 of file smpdtfmt.h. |
|
See documentation for defaultCenturyStart.
Definition at line 705 of file smpdtfmt.h. |
|
The formatting pattern for this formatter.
Definition at line 684 of file smpdtfmt.h. |
|
A pointer to an object containing the strings to use in formatting (e.g., month and day names, AM and PM strings, time zone names, etc.).
Definition at line 690 of file smpdtfmt.h. |
|
Definition at line 490 of file smpdtfmt.h. |
|
Definition at line 492 of file smpdtfmt.h. |
|
Definition at line 494 of file smpdtfmt.h. |
|
Definition at line 669 of file smpdtfmt.h. |
|
Definition at line 668 of file smpdtfmt.h. |
|
Last-resort string to use for "GMT" when constructing time zone strings.
Definition at line 667 of file smpdtfmt.h. |
|
Used to map pattern characters to Calendar field identifiers.
Definition at line 674 of file smpdtfmt.h. |
|
Map index into pattern character string to DateFormat field number.
Definition at line 679 of file smpdtfmt.h. |
|
If a start date is set to this value, that indicates that the system default start is in effect for this instance.
Definition at line 730 of file smpdtfmt.h. |
|
The system maintains a static default century start date. This is initialized the first time it is used. Before then, it is set to SYSTEM_DEFAULT_CENTURY to indicate an uninitialized state. Once the system default century date and year are set, they do not change. Definition at line 713 of file smpdtfmt.h. |
|
See documentation for systemDefaultCenturyStart.
Definition at line 718 of file smpdtfmt.h. |
|
Default value that indicates the defaultCenturyStartYear is unitialized.
Definition at line 723 of file smpdtfmt.h. |