SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manner
SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manner. 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:
. Symbol Meaning Presentation Example . ------ ------- ------------ ------- . G era designator (Text) AD . y 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 in week (Text) Tuesday . D day in 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 'The count of pattern letters determine the format.(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:
. 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 PMCode Sample:. 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 );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.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.
[Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.
[Note:] Not all locales support SimpleDateFormat; for full generality,
use the factory methods in the DateFormat class.
[Note:] Not all locales support SimpleDateFormat; for full generality,
use the factory methods in the DateFormat class.
Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->>
1996.07.10 AD at 15:08:56 PDT
Example: using the US locale: "yyyy.MM.dd e 'at' HH:mm:ss zzz" ->>
1996.07.10 AD at 15:08:56 PDT
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).
By default, the two digit start date is set to 80 years before the current
time at which a SimpleDateFormat object is created.
By default, the two digit start date is set to 80 years before the current
time at which a SimpleDateFormat object is created.
SimpleDateFormat(const UnicodeString& pattern, UErrorCode& status)
SimpleDateFormat(const UnicodeString& pattern, const Locale& locale, UErrorCode& status)
SimpleDateFormat(const UnicodeString& pattern, DateFormatSymbols* formatDataToAdopt, UErrorCode& status)
SimpleDateFormat(const UnicodeString& pattern, const DateFormatSymbols& formatData, UErrorCode& status)
SimpleDateFormat(const SimpleDateFormat&)
SimpleDateFormat& operator=(const SimpleDateFormat&)
virtual ~SimpleDateFormat()
virtual Format* clone(void) const
virtual bool_t operator==(const Format& other) const
virtual UnicodeString& format( UDate date, UnicodeString& toAppendTo, FieldPosition& pos) const
toAppendTo - The result of the formatting operation is appended to this
string.
pos - The formatting position. On input: an alignment field,
if desired. On output: the offsets of the alignment field.
virtual UnicodeString& format( const Formattable& obj, UnicodeString& toAppendTo, FieldPosition& pos, UErrorCode& status) const
toAppendTo - The result of the formatting operation is appended to this
string.
pos - The formatting position. On input: an alignment field,
if desired. On output: the offsets of the alignment field.
UnicodeString& format(const Formattable& obj, UnicodeString& result, UErrorCode& status) const
UnicodeString& format(UDate date, UnicodeString& result) const
virtual UDate parse( const UnicodeString& text, ParsePosition& pos) const
pos - On input, the position at which to start parsing; on
output, the position at which parsing terminated, or the
start position if the parse failed.
virtual UDate parse( const UnicodeString& text, UErrorCode& status) const
status - Filled in with U_ZERO_ERROR if the parse was successful, and with
an error value if there was a parse error.
virtual void set2DigitYearStart(UDate d, UErrorCode& status)
UDate get2DigitYearStart(UErrorCode& status) const
virtual UnicodeString& toPattern(UnicodeString& result) const
virtual UnicodeString& toLocalizedPattern(UnicodeString& result, UErrorCode& status) const
status - Output param set to success/failure code on
exit. If the pattern is invalid, this will be
set to a failure result. virtual void applyPattern(const UnicodeString& pattern)
virtual void applyLocalizedPattern(const UnicodeString& pattern, UErrorCode& status)
status - Output param set to success/failure code on
exit. If the pattern is invalid, this will be
set to a failure result. virtual const DateFormatSymbols* getDateFormatSymbols(void) const
virtual void adoptDateFormatSymbols(DateFormatSymbols* newFormatSymbols)
virtual void setDateFormatSymbols(const DateFormatSymbols& newFormatSymbols)
static const UnicodeString fgErasTag
static UClassID getStaticClassID(void)
. Base* polymorphic_pointer = createPolymorphicObject();
. if (polymorphic_pointer->getDynamicClassID() ==
. erived::getStaticClassID()) ...
virtual UClassID getDynamicClassID(void) const
static void translatePattern(const UnicodeString& originalPattern, UnicodeString& translatedPattern, const UnicodeString& from, const UnicodeString& to, UErrorCode& status)
void parseAmbiguousDatesAsAfter(UDate startDate, UErrorCode& status)
static const UDate fgSystemDefaultCentury
alphabetic index hierarchy of classes
this page has been generated automatically by doc++
(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de