ICU 50.1.2  50.1.2
Data Structures | Public Member Functions | Static Public Member Functions | Friends
icu::SimpleDateFormat Class Reference

SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manner. More...

#include <smpdtfmt.h>

Inheritance diagram for icu::SimpleDateFormat:
icu::DateFormat icu::Format icu::UObject icu::UMemory

Public Member Functions

 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 UnicodeString &override, UErrorCode &status)
 Construct a SimpleDateFormat using the given pattern, numbering system override, 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, const UnicodeString &override, const Locale &locale, UErrorCode &status)
 Construct a SimpleDateFormat using the given pattern, numbering system override, 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...
 
SimpleDateFormatoperator= (const SimpleDateFormat &)
 Assignment operator. More...
 
virtual ~SimpleDateFormat ()
 Destructor. More...
 
virtual Formatclone (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 UnicodeStringformat (Calendar &cal, UnicodeString &appendTo, FieldPosition &pos) const
 Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More...
 
virtual UnicodeStringformat (Calendar &cal, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
 Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More...
 
virtual UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
 Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More...
 
virtual UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
 Format a date or time, which is the standard millis since 24:00 GMT, Jan 1, 1970. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo, FieldPosition &fieldPosition) const
 Redeclared DateFormat method. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
 Redeclared DateFormat method. More...
 
UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
 Redeclared DateFormat method. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo) const
 Redeclared DateFormat method. More...
 
virtual void parse (const UnicodeString &text, Calendar &cal, ParsePosition &pos) const
 Parse a date/time string beginning at the given parse position. More...
 
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 UnicodeStringtoPattern (UnicodeString &result) const
 Return a pattern string describing this date format. More...
 
virtual UnicodeStringtoLocalizedPattern (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 DateFormatSymbolsgetDateFormatSymbols (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...
 
virtual void adoptCalendar (Calendar *calendarToAdopt)
 Set the calendar to be used by this date format. More...
 
virtual void setContext (UDisplayContext value, UErrorCode &status)
 Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE. More...
 
virtual UDisplayContext getContext (UDisplayContextType type, UErrorCode &status) const
 Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION. More...
 
virtual void adoptTimeZoneFormat (TimeZoneFormat *timeZoneFormatToAdopt)
 Sets the TimeZoneFormat to be used by this date/time formatter. More...
 
virtual void setTimeZoneFormat (const TimeZoneFormat &newTimeZoneFormat)
 Sets the TimeZoneFormat to be used by this date/time formatter. More...
 
virtual const TimeZoneFormatgetTimeZoneFormat (void) const
 Gets the time zone format object associated with this date/time formatter. More...
 
UBool isFieldUnitIgnored (UCalendarDateFields field) const
 This is for ICU internal use only. More...
 
const LocalegetSmpFmtLocale (void) const
 This is for ICU internal use only. More...
 
- Public Member Functions inherited from icu::DateFormat
virtual ~DateFormat ()
 Destructor. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo, FieldPosition &fieldPosition) const
 Formats a UDate into a date/time string. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const
 Formats a UDate into a date/time string. More...
 
UnicodeStringformat (UDate date, UnicodeString &appendTo) const
 Formats a UDate into a date/time string. More...
 
UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
 Redeclared Format method. More...
 
UDate parse (const UnicodeString &text, ParsePosition &pos) const
 Parse a date/time string beginning at the given parse position. More...
 
virtual void parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const
 Parse a string to produce an object. More...
 
virtual UBool isLenient (void) const
 Returns true if the formatter is set for lenient parsing. More...
 
virtual void setLenient (UBool lenient)
 Specify whether or not date/time parsing is to be lenient. More...
 
virtual const CalendargetCalendar (void) const
 Gets the calendar associated with this date/time formatter. More...
 
virtual void setCalendar (const Calendar &newCalendar)
 Set the calendar to be used by this date format. More...
 
virtual const NumberFormatgetNumberFormat (void) const
 Gets the number formatter which this date/time formatter uses to format and parse the numeric portions of the pattern. More...
 
virtual void adoptNumberFormat (NumberFormat *formatToAdopt)
 Allows you to set the number formatter. More...
 
virtual void setNumberFormat (const NumberFormat &newNumberFormat)
 Allows you to set the number formatter. More...
 
virtual const TimeZonegetTimeZone (void) const
 Returns a reference to the TimeZone used by this DateFormat's calendar. More...
 
virtual void adoptTimeZone (TimeZone *zoneToAdopt)
 Sets the time zone for the calendar of this DateFormat object. More...
 
virtual void setTimeZone (const TimeZone &zone)
 Sets the time zone for the calendar of this DateFormat object. More...
 
- Public Member Functions inherited from icu::Format
virtual ~Format ()
 Destructor. More...
 
UBool operator!= (const Format &other) const
 Return true if the given Format objects are not semantically equal. More...
 
UnicodeStringformat (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
 Formats an object to produce a string. More...
 
void parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const
 Parses a string to produce an object. More...
 
Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this format object. More...
 
const char * getLocaleID (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this format object. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static UClassID getStaticClassID (void)
 Return the class ID for this class. More...
 
static UBool isFieldUnitIgnored (const UnicodeString &pattern, UCalendarDateFields field)
 This is for ICU internal use only. More...
 
- Static Public Member Functions inherited from icu::DateFormat
static DateFormatcreateInstance (void)
 Create a default date/time formatter that uses the SHORT style for both the date and the time. More...
 
static DateFormatcreateTimeInstance (EStyle style=kDefault, const Locale &aLocale=Locale::getDefault())
 Creates a time formatter with the given formatting style for the given locale. More...
 
static DateFormatcreateDateInstance (EStyle style=kDefault, const Locale &aLocale=Locale::getDefault())
 Creates a date formatter with the given formatting style for the given const locale. More...
 
static DateFormatcreateDateTimeInstance (EStyle dateStyle=kDefault, EStyle timeStyle=kDefault, const Locale &aLocale=Locale::getDefault())
 Creates a date/time formatter with the given formatting styles for the given locale. More...
 
static const LocalegetAvailableLocales (int32_t &count)
 Gets the set of locales for which DateFormats are installed. More...
 

Friends

class DateFormat
 

Additional Inherited Members

- Public Types inherited from icu::DateFormat
enum  EStyle {
  kNone = -1, kFull = 0, kLong = 1, kMedium = 2,
  kShort = 3, kDateOffset = kShort + 1, kDateTime = 8, kDateTimeOffset = kDateTime + 1,
  kRelative = (1 << 7), kFullRelative = (kFull | kRelative), kLongRelative = kLong | kRelative, kMediumRelative = kMedium | kRelative,
  kShortRelative = kShort | kRelative, kDefault = kMedium, FULL = kFull, LONG = kLong,
  MEDIUM = kMedium, SHORT = kShort, DEFAULT = kDefault, DATE_OFFSET = kDateOffset,
  NONE = kNone, DATE_TIME = kDateTime
}
 Constants for various style patterns. More...
 
enum  EField {
  kEraField = UDAT_ERA_FIELD, kYearField = UDAT_YEAR_FIELD, kMonthField = UDAT_MONTH_FIELD, kDateField = UDAT_DATE_FIELD,
  kHourOfDay1Field = UDAT_HOUR_OF_DAY1_FIELD, kHourOfDay0Field = UDAT_HOUR_OF_DAY0_FIELD, kMinuteField = UDAT_MINUTE_FIELD, kSecondField = UDAT_SECOND_FIELD,
  kMillisecondField = UDAT_FRACTIONAL_SECOND_FIELD, kDayOfWeekField = UDAT_DAY_OF_WEEK_FIELD, kDayOfYearField = UDAT_DAY_OF_YEAR_FIELD, kDayOfWeekInMonthField = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
  kWeekOfYearField = UDAT_WEEK_OF_YEAR_FIELD, kWeekOfMonthField = UDAT_WEEK_OF_MONTH_FIELD, kAmPmField = UDAT_AM_PM_FIELD, kHour1Field = UDAT_HOUR1_FIELD,
  kHour0Field = UDAT_HOUR0_FIELD, kTimezoneField = UDAT_TIMEZONE_FIELD, kYearWOYField = UDAT_YEAR_WOY_FIELD, kDOWLocalField = UDAT_DOW_LOCAL_FIELD,
  kExtendedYearField = UDAT_EXTENDED_YEAR_FIELD, kJulianDayField = UDAT_JULIAN_DAY_FIELD, kMillisecondsInDayField = UDAT_MILLISECONDS_IN_DAY_FIELD, ERA_FIELD = UDAT_ERA_FIELD,
  YEAR_FIELD = UDAT_YEAR_FIELD, MONTH_FIELD = UDAT_MONTH_FIELD, DATE_FIELD = UDAT_DATE_FIELD, HOUR_OF_DAY1_FIELD = UDAT_HOUR_OF_DAY1_FIELD,
  HOUR_OF_DAY0_FIELD = UDAT_HOUR_OF_DAY0_FIELD, MINUTE_FIELD = UDAT_MINUTE_FIELD, SECOND_FIELD = UDAT_SECOND_FIELD, MILLISECOND_FIELD = UDAT_FRACTIONAL_SECOND_FIELD,
  DAY_OF_WEEK_FIELD = UDAT_DAY_OF_WEEK_FIELD, DAY_OF_YEAR_FIELD = UDAT_DAY_OF_YEAR_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD, WEEK_OF_YEAR_FIELD = UDAT_WEEK_OF_YEAR_FIELD,
  WEEK_OF_MONTH_FIELD = UDAT_WEEK_OF_MONTH_FIELD, AM_PM_FIELD = UDAT_AM_PM_FIELD, HOUR1_FIELD = UDAT_HOUR1_FIELD, HOUR0_FIELD = UDAT_HOUR0_FIELD,
  TIMEZONE_FIELD = UDAT_TIMEZONE_FIELD
}
 Field selector for FieldPosition for DateFormat fields. More...
 
- Protected Member Functions inherited from icu::DateFormat
 DateFormat ()
 Default constructor. More...
 
 DateFormat (const DateFormat &)
 Copy constructor. More...
 
DateFormatoperator= (const DateFormat &)
 Default assignment operator. More...
 
- Protected Member Functions inherited from icu::Format
void setLocaleIDs (const char *valid, const char *actual)
 
 Format ()
 Default constructor for subclass use only. More...
 
 Format (const Format &)
 
Formatoperator= (const Format &)
 
- Static Protected Member Functions inherited from icu::Format
static void syntaxError (const UnicodeString &pattern, int32_t pos, UParseError &parseError)
 Simple function for initializing a UParseError from a UnicodeString. More...
 
- Protected Attributes inherited from icu::DateFormat
CalendarfCalendar
 The calendar that DateFormat uses to produce the time field values needed to implement date/time formatting. More...
 
NumberFormatfNumberFormat
 The number formatter that DateFormat uses to format numbers in dates and times. More...
 

Detailed Description

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
* Y year (week of year) (Number) 1997
* u extended year (Number) 4601
* U cyclic year name (Text,NumFallback) ren-chen (29)
* Q Quarter (Text & Number) Q2 & 02
* 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 fractional second (Number) 978
* (maximum resolution of SSS; truncated if shorter, zero-padded if longer)
* E day of week (Text) Tuesday
* e day of week (local 1~7) (Text & Number) Tues & 2
* 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) PST
* zzzz time zone (Text) Pacific Standard Time
* Z time zone (RFC 822) (Number) -0800
* ZZZZ time zone (RFC 822) (Text & Number) GMT-08:00
* ZZZZZ time zone (ISO 8601) (Text & Number) -08:00 & Z
* v time zone (generic) (Text) PT
* vvvv time zone (generic) (Text) Pacific Time
* V time zone (abreviation) (Text) PST
* VVVV time zone (location) (Text) United States Time (Los Angeles)
* g Julian day (Number) 2451334
* A milliseconds in day (Number) 69540000
* q stand alone quarter (Text & Number) Q2 & 02
* L stand alone month (Text & Number) July & 07
* c stand alone day of week (Text & Number) Tuesday & 2
* ' escape for text (Delimiter) 'Date='
* '' single quote (Literal) 'o''clock'
*

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".) Unlike other fields, fractional seconds are padded on the right with zero.

(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".)

(Text,NumFallback): Behaves like Text if there is supporting data, like Number otherwise.

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 vvvv" ->> 1996.07.10 AD at 15:08:56 Pacific Time
* "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, vvv" ->> 0:00 PM, PT
* "yyyyy.MMMMM.dd GGG hh:mm aaa" ->> 1996.July.10 AD 12:08 PM
*

Code Sample:

* 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 (for the Gregorian calendar), using the same pattern, as Jan 2, 3 AD. Likewise (but only in lenient parse mode, the default) "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.

When numeric fields abut one another directly, with no intervening delimiter characters, they constitute a run of abutting numeric fields. Such runs are parsed specially. For example, the format "HHmmss" parses the input text "123456" to 12:34:56, parses the input text "12345" to 1:23:45, and fails to parse "1234". In other words, the leftmost field of the run is flexible, while the others keep a fixed width. If the parse fails anywhere in the run, then the leftmost field is shortened by one character, and the entire run is parsed again. This is repeated until either the parse succeeds or the leftmost field is one character in length. If the parse still fails at that point, the parse of the run fails.

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.

User subclasses are not supported. While clients may write subclasses, such code will not necessarily work and will not be guaranteed to work stably from release to release.

Definition at line 227 of file smpdtfmt.h.

Constructor & Destructor Documentation

icu::SimpleDateFormat::SimpleDateFormat ( UErrorCode status)

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.

Parameters
statusOutput param set to success/failure code.
Stable:
ICU 2.0
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
UErrorCode status 
)

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.

Parameters
patternthe pattern for the format.
statusOutput param set to success/failure code.
Stable:
ICU 2.0
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
const UnicodeString override,
UErrorCode status 
)

Construct a SimpleDateFormat using the given pattern, numbering system override, 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.

A numbering system override is a string containing either the name of a known numbering system, or a set of field and numbering system pairs that specify which fields are to be formattied with the alternate numbering system. For example, to specify that all numeric fields in the specified date or time pattern are to be rendered using Thai digits, simply specify the numbering system override as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering, use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.

[Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

Parameters
patternthe pattern for the format.
overridethe override string.
statusOutput param set to success/failure code.
Stable:
ICU 4.2
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
const Locale locale,
UErrorCode status 
)

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.

Parameters
patternthe pattern for the format.
localethe given locale.
statusOutput param set to success/failure code.
Stable:
ICU 2.0
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
const UnicodeString override,
const Locale locale,
UErrorCode status 
)

Construct a SimpleDateFormat using the given pattern, numbering system override, 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.

A numbering system override is a string containing either the name of a known numbering system, or a set of field and numbering system pairs that specify which fields are to be formattied with the alternate numbering system. For example, to specify that all numeric fields in the specified date or time pattern are to be rendered using Thai digits, simply specify the numbering system override as "thai". To specify that just the year portion of the date be formatted using Hebrew numbering, use the override string "y=hebrew". Numbering system overrides can be combined using a semi-colon character in the override string, such as "d=decimal;M=arabic;y=hebrew", etc.

[Note:] Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

Parameters
patternthe pattern for the format.
overridethe numbering system override.
localethe given locale.
statusOutput param set to success/failure code.
Stable:
ICU 4.2
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
DateFormatSymbols formatDataToAdopt,
UErrorCode status 
)

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.

Parameters
patternthe given pattern for the format.
formatDataToAdoptthe symbols to be adopted.
statusOutput param set to success/faulure code.
Stable:
ICU 2.0
icu::SimpleDateFormat::SimpleDateFormat ( const UnicodeString pattern,
const DateFormatSymbols formatData,
UErrorCode status 
)

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.

Parameters
patternthe given pattern for the format.
formatDatathe formatting symbols to be use.
statusOutput param set to success/faulure code.
Stable:
ICU 2.0
icu::SimpleDateFormat::SimpleDateFormat ( const SimpleDateFormat )

Copy constructor.

Stable:
ICU 2.0
virtual icu::SimpleDateFormat::~SimpleDateFormat ( )
virtual

Destructor.

Stable:
ICU 2.0

Member Function Documentation

virtual void icu::SimpleDateFormat::adoptCalendar ( Calendar calendarToAdopt)
virtual

Set the calendar to be used by this date format.

Initially, the default calendar for the specified or default locale is used. The caller should not delete the Calendar object after it is adopted by this call. Adopting a new calendar will change to the default symbols.

Parameters
calendarToAdoptCalendar object to be adopted.
Stable:
ICU 2.0

Reimplemented from icu::DateFormat.

virtual void icu::SimpleDateFormat::adoptDateFormatSymbols ( DateFormatSymbols newFormatSymbols)
virtual

Set the date/time formatting symbols.

The caller no longer owns the DateFormatSymbols object and should not delete it after making this call.

Parameters
newFormatSymbolsthe given date-time formatting symbols to copy.
Stable:
ICU 2.0
virtual void icu::SimpleDateFormat::adoptTimeZoneFormat ( TimeZoneFormat timeZoneFormatToAdopt)
virtual

Sets the TimeZoneFormat to be used by this date/time formatter.

The caller should not delete the TimeZoneFormat object after it is adopted by this call.

Parameters
timeZoneFormatToAdoptThe TimeZoneFormat object to be adopted.
Internal:
Do not use. This API is for internal use only. ICU 49 technology preview
virtual void icu::SimpleDateFormat::applyLocalizedPattern ( const UnicodeString pattern,
UErrorCode status 
)
virtual

Apply the given localized pattern string to this date format.

(see toLocalizedPattern() for more information on localized patterns.)

Parameters
patternThe localized pattern to be applied.
statusOutput param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.
Stable:
ICU 2.0
virtual void icu::SimpleDateFormat::applyPattern ( const UnicodeString pattern)
virtual

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)

Parameters
patternThe pattern to be applied.
Stable:
ICU 2.0
virtual Format* icu::SimpleDateFormat::clone ( void  ) const
virtual

Clone this Format object polymorphically.

The caller owns the result and should delete it when done.

Returns
A copy of the object.
Stable:
ICU 2.0

Implements icu::Format.

virtual UnicodeString& icu::SimpleDateFormat::format ( Calendar cal,
UnicodeString appendTo,
FieldPosition pos 
) const
virtual

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

Parameters
calCalendar set to the date and time to be formatted into a date/time string.
appendToOutput parameter to receive result. Result is appended to existing contents.
posThe formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.1

Implements icu::DateFormat.

virtual UnicodeString& icu::SimpleDateFormat::format ( Calendar cal,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const
virtual

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

Parameters
calCalendar set to the date and time to be formatted into a date/time string.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField.
statusInput/output param set to success/failure code.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

Reimplemented from icu::DateFormat.

UnicodeString & icu::SimpleDateFormat::format ( const Formattable obj,
UnicodeString appendTo,
FieldPosition pos,
UErrorCode status 
) const
inlinevirtual

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

Parameters
objA Formattable containing the date-time value to be formatted into a date-time string. If the type of the Formattable is a numeric type, it is treated as if it were an instance of Date.
appendToOutput parameter to receive result. Result is appended to existing contents.
posThe formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
statusInput/output param set to success/failure code.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Reimplemented from icu::DateFormat.

Definition at line 1251 of file smpdtfmt.h.

UnicodeString & icu::SimpleDateFormat::format ( const Formattable obj,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const
inlinevirtual

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

Parameters
objA Formattable containing the date-time value to be formatted into a date-time string. If the type of the Formattable is a numeric type, it is treated as if it were an instance of Date.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField.
statusInput/output param set to success/failure code.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

Reimplemented from icu::DateFormat.

Definition at line 1262 of file smpdtfmt.h.

UnicodeString & icu::SimpleDateFormat::format ( UDate  date,
UnicodeString appendTo,
FieldPosition fieldPosition 
) const
inline

Redeclared DateFormat method.

Parameters
datethe Date value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
fieldPositionThe formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.1

Definition at line 1273 of file smpdtfmt.h.

UnicodeString & icu::SimpleDateFormat::format ( UDate  date,
UnicodeString appendTo,
FieldPositionIterator posIter,
UErrorCode status 
) const
inline

Redeclared DateFormat method.

Parameters
datethe Date value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
posIterOn return, can be used to iterate over positions of fields generated by this format call. Field values are defined in UDateFormatField.
statusInput/output param set to success/failure code.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 4.4

Definition at line 1282 of file smpdtfmt.h.

UnicodeString & icu::SimpleDateFormat::format ( const Formattable obj,
UnicodeString appendTo,
UErrorCode status 
) const
inline

Redeclared DateFormat method.

Parameters
objObject to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
statusInput/output success/failure code.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Definition at line 1242 of file smpdtfmt.h.

UnicodeString & icu::SimpleDateFormat::format ( UDate  date,
UnicodeString appendTo 
) const
inline

Redeclared DateFormat method.

Parameters
dateDate value to be formatted.
appendToOutput parameter to receive result. Result is appended to existing contents.
Returns
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Definition at line 1292 of file smpdtfmt.h.

UDate icu::SimpleDateFormat::get2DigitYearStart ( UErrorCode status) const
inline

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.

Parameters
statusFilled in with U_ZERO_ERROR if the parse was successful, and with an error value if there was a parse error.
Stable:
ICU 2.0

Definition at line 1236 of file smpdtfmt.h.

virtual UDisplayContext icu::SimpleDateFormat::getContext ( UDisplayContextType  type,
UErrorCode status 
) const
virtual

Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.

Parameters
typeThe UDisplayContextType whose value to return
statusInput/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function.
Returns
The UDisplayContextValue for the specified type.
Internal:
Do not use. This API is for internal use only. ICU 50 technology preview
virtual const DateFormatSymbols* icu::SimpleDateFormat::getDateFormatSymbols ( void  ) const
virtual

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 copy of the date-time formatting data associated with this date-time formatter.
Stable:
ICU 2.0
virtual UClassID icu::SimpleDateFormat::getDynamicClassID ( void  ) const
virtual

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.

Returns
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.
Stable:
ICU 2.0

Implements icu::UObject.

const Locale& icu::SimpleDateFormat::getSmpFmtLocale ( void  ) const

This is for ICU internal use only.

Please do not use. Get the locale of this simple date formatter. It is used in DateIntervalFormat.

Returns
locale in this simple date formatter
Internal:
Do not use. This API is for internal use only. ICU 4.0
static UClassID icu::SimpleDateFormat::getStaticClassID ( void  )
static

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()) ...
Returns
The class ID for all objects of this class.
Stable:
ICU 2.0
virtual const TimeZoneFormat* icu::SimpleDateFormat::getTimeZoneFormat ( void  ) const
virtual

Gets the time zone format object associated with this date/time formatter.

Returns
the time zone format associated with this date/time formatter.
Internal:
Do not use. This API is for internal use only. ICU 49 technology preview
UBool icu::SimpleDateFormat::isFieldUnitIgnored ( UCalendarDateFields  field) const

This is for ICU internal use only.

Please do not use. Check whether the 'field' is smaller than all the fields covered in pattern, return TRUE if it is. The sequence of calendar field, from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...

Parameters
fieldthe calendar field need to check against
Returns
TRUE if the 'field' is smaller than all the fields covered in pattern. FALSE otherwise.
Internal:
Do not use. This API is for internal use only. ICU 4.0
static UBool icu::SimpleDateFormat::isFieldUnitIgnored ( const UnicodeString pattern,
UCalendarDateFields  field 
)
static

This is for ICU internal use only.

Please do not use. Check whether the 'field' is smaller than all the fields covered in pattern, return TRUE if it is. The sequence of calendar field, from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...

Parameters
patternthe pattern to check against
fieldthe calendar field need to check against
Returns
TRUE if the 'field' is smaller than all the fields covered in pattern. FALSE otherwise.
Internal:
Do not use. This API is for internal use only. ICU 4.0
SimpleDateFormat& icu::SimpleDateFormat::operator= ( const SimpleDateFormat )

Assignment operator.

Stable:
ICU 2.0
virtual UBool icu::SimpleDateFormat::operator== ( const Format other) const
virtual

Return true if the given Format objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters
otherthe object to be compared with.
Returns
true if the given Format objects are semantically equal.
Stable:
ICU 2.0

Reimplemented from icu::DateFormat.

virtual void icu::SimpleDateFormat::parse ( const UnicodeString text,
Calendar cal,
ParsePosition pos 
) const
virtual

Parse a date/time string beginning 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).

See Also
DateFormat::setLenient(boolean)
Parameters
textThe date/time string to be parsed
calA Calendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. When the calendar type is different from the internal calendar held by this SimpleDateFormat instance, the internal calendar will be cloned to a work calendar set to the same milliseconds and time zone as the cal parameter, field values will be parsed based on the work calendar, then the result (milliseconds and time zone) will be set in this calendar.
posOn input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.
Stable:
ICU 2.1

Implements icu::DateFormat.

UDate icu::SimpleDateFormat::parse ( const UnicodeString text,
ParsePosition pos 
) const

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).

See Also
DateFormat::setLenient(boolean)

Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of the Calendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the method parse(const UnicodeString&, Calendar& cal, ParsePosition&) with the Calendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.

Parameters
textThe date/time string to be parsed
posOn input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.
Returns
A valid UDate if the input could be parsed.
Stable:
ICU 2.0
virtual UDate icu::SimpleDateFormat::parse ( const UnicodeString text,
UErrorCode status 
) const
virtual

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.

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).

See Also
DateFormat::setLenient(boolean)

Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of the Calendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the method parse(const UnicodeString&, Calendar& cal, ParsePosition&) with the Calendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.

Parameters
textThe date/time string to be parsed into a UDate value.
statusFilled in with U_ZERO_ERROR if the parse was successful, and with an error value if there was a parse error.
Returns
A valid UDate if the input could be parsed.
Stable:
ICU 2.0

Reimplemented from icu::DateFormat.

virtual void icu::SimpleDateFormat::set2DigitYearStart ( UDate  d,
UErrorCode status 
)
virtual

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.

Parameters
dstart UDate used to interpret two-digit year strings.
statusFilled in with U_ZERO_ERROR if the parse was successful, and with an error value if there was a parse error.
Stable:
ICU 2.0
virtual void icu::SimpleDateFormat::setContext ( UDisplayContext  value,
UErrorCode status 
)
virtual

Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.

Parameters
valueThe UDisplayContext value to set.
statusInput/output status. If at entry this indicates a failure status, the function will do nothing; otherwise this will be updated with any new status from the function.
Internal:
Do not use. This API is for internal use only. ICU 50 technology preview
virtual void icu::SimpleDateFormat::setDateFormatSymbols ( const DateFormatSymbols newFormatSymbols)
virtual

Set the date/time formatting data.

Parameters
newFormatSymbolsthe given date-time formatting symbols to copy.
Stable:
ICU 2.0
virtual void icu::SimpleDateFormat::setTimeZoneFormat ( const TimeZoneFormat newTimeZoneFormat)
virtual

Sets the TimeZoneFormat to be used by this date/time formatter.

Parameters
newTimeZoneFormatThe TimeZoneFormat object to copy.
Internal:
Do not use. This API is for internal use only. ICU 49 technology preview
virtual UnicodeString& icu::SimpleDateFormat::toLocalizedPattern ( UnicodeString result,
UErrorCode status 
) const
virtual

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.

Parameters
resultReceives the localized pattern.
statusOutput param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.
Returns
A reference to 'result'.
Stable:
ICU 2.0
virtual UnicodeString& icu::SimpleDateFormat::toPattern ( UnicodeString result) const
virtual

Return a pattern string describing this date format.

Parameters
resultOutput param to receive the pattern.
Returns
A reference to 'result'.
Stable:
ICU 2.0

The documentation for this class was generated from the following file: