Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

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 SimpleDateFormat::

DateFormat Format UObject UMemory List of all members.

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

UnicodeStringformat (UDate date, UnicodeString &appendTo, FieldPosition &fieldPosition) 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 Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this date format object. More...

virtual const char * getLocaleInternal (ULocDataLocaleType type, UErrorCode &status) const
 Get the locale for this date format object. More...


Static Public Methods

UClassID getStaticClassID (void)
 Return the class ID for this class. More...


Private Methods

void initializeDefaultCentury (void)
 SimpleDateFormat ()
 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...

void subFormat (UnicodeString &appendTo, UChar ch, int32_t count, FieldPosition &pos, Calendar &cal, UErrorCode &status) const
 Called by format() to format a single field. More...

void zeroPaddingNumber (UnicodeString &appendTo, int32_t value, int32_t minDigits, int32_t maxDigits) const
 Used by subFormat() to format a numeric value. More...

CalendarinitializeCalendar (TimeZone *adoptZone, const Locale &locale, UErrorCode &status)
 initializes fCalendar from parameters. More...

void initializeSymbols (const Locale &locale, Calendar *calendar, UErrorCode &status)
 initializes fSymbols from parameters. 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, int32_t start, UCalendarDateFields field, const UnicodeString *stringArray, int32_t stringArrayCount, Calendar &cal) 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 allowNegative, UBool ambiguousYear[], Calendar &cal) const
 Private member function that converts the parsed date strings into timeFields. More...

void parseInt (const UnicodeString &text, Formattable &number, ParsePosition &pos, UBool allowNegative) const
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...


Static Private Methods

UBool isNumeric (UChar formatChar, int32_t count)
 Return true if the given format character, occuring count times, represents a numeric field. More...

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


Private Attributes

UnicodeString fPattern
 The formatting pattern for this formatter. More...

Locale fLocale
 The original locale used (for reloading symbols). More...

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

UBool fHaveDefaultCentury

Static Private Attributes

const UCalendarDateFields 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...


Friends

class DateFormat

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)           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                               '
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 PM
Code 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.

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.

Definition at line 190 of file smpdtfmt.h.


Constructor & Destructor Documentation

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:
status  Output param set to success/failure code.
Stable:
ICU 2.0

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:
pattern  the pattern for the format.
status  Output param set to success/failure code.
Stable:
ICU 2.0

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:
pattern  the pattern for the format.
locale  the given locale.
status  Output param set to success/failure code.
Stable:
ICU 2.0

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:
pattern  the given pattern for the format.
formatDataToAdopt  the symbols to be adopted.
status  Output param set to success/faulure code.
Stable:
ICU 2.0

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:
pattern  the given pattern for the format.
formatData  the formatting symbols to be use.
status  Output param set to success/faulure code.
Stable:
ICU 2.0

SimpleDateFormat::SimpleDateFormat const SimpleDateFormat &   
 

Copy constructor.

Stable:
ICU 2.0

virtual SimpleDateFormat::~SimpleDateFormat   [virtual]
 

Destructor.

Stable:
ICU 2.0

SimpleDateFormat::SimpleDateFormat   [private]
 

SimpleDateFormat::SimpleDateFormat EStyle    timeStyle,
EStyle    dateStyle,
const Locale   locale,
UErrorCode   status
[private]
 

Used by the DateFormat factory methods to construct a SimpleDateFormat.

Parameters:
timeStyle  the time style.
dateStyle  the date style.
locale  the given locale.
status  Output param set to success/failure code on exit.

SimpleDateFormat::SimpleDateFormat const Locale   locale,
UErrorCode   status
[private]
 

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.

Parameters:
locale  the given locale.
status  Output param set to success/failure code on exit.


Member Function Documentation

virtual void 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:
calendarToAdopt  Calendar object to be adopted.
Stable:
ICU 2.0

Reimplemented from DateFormat.

virtual void 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:
newFormatSymbols  the given date-time formatting symbols to copy.
Stable:
ICU 2.0

virtual void 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:
pattern  The localized pattern to be applied.
status  Output 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 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:
pattern  The pattern to be applied.
Stable:
ICU 2.0

virtual Format* 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

Reimplemented from Format.

void SimpleDateFormat::construct EStyle    timeStyle,
EStyle    dateStyle,
const Locale   locale,
UErrorCode   status
[private]
 

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.

Parameters:
timeStyle  The time style, as passed to DateFormat::createDateInstance().
dateStyle  The date style, as passed to DateFormat::createTimeInstance().
locale  The locale to load the patterns from.
status  Filled in with an error code if loading the data from the resources fails.

UnicodeString & SimpleDateFormat::format UDate    date,
UnicodeString   appendTo
const [inline]
 

Redeclared DateFormat method.

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

Reimplemented from DateFormat.

Definition at line 844 of file smpdtfmt.h.

UnicodeString & SimpleDateFormat::format const Formattable   obj,
UnicodeString   appendTo,
UErrorCode   status
const [inline]
 

Redeclared DateFormat method.

Parameters:
obj  Object to be formatted.
appendTo  Output parameter to receive result. Result is appended to existing contents.
status  Input/output success/failure code.
Returns:
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Reimplemented from DateFormat.

Definition at line 826 of file smpdtfmt.h.

UnicodeString & SimpleDateFormat::format UDate    date,
UnicodeString   appendTo,
FieldPosition   fieldPosition
const [inline]
 

Redeclared DateFormat method.

Parameters:
date  the Date value to be formatted.
appendTo  Output parameter to receive result. Result is appended to existing contents.
fieldPosition  The 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

Reimplemented from DateFormat.

Definition at line 835 of file smpdtfmt.h.

virtual UnicodeString& SimpleDateFormat::format const Formattable   obj,
UnicodeString   appendTo,
FieldPosition   pos,
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:
obj  A 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.
appendTo  Output parameter to receive result. Result is appended to existing contents.
pos  The formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
status  Output param set to success/faulure code.
Returns:
Reference to 'appendTo' parameter.
Stable:
ICU 2.0

Reimplemented from DateFormat.

virtual UnicodeString& 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:
cal  Calendar set to the date and time to be formatted into a date/time string.
appendTo  Output parameter to receive result. Result is appended to existing contents.
pos  The 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

Reimplemented from DateFormat.

UDate 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:
status  Filled 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 820 of file smpdtfmt.h.

virtual const DateFormatSymbols* 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 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

Reimplemented from Format.

virtual Locale SimpleDateFormat::getLocale ULocDataLocaleType    type,
UErrorCode   status
const [virtual]
 

Get the locale for this date format object.

You can choose between valid and actual locale.

Parameters:
type  type of the locale we're looking for (valid or actual)
status  error code for the operation
Returns:
the locale
Draft:
This API has been introduced in ICU 2.8. It is still in draft state and may be modified in a future release.

Reimplemented from DateFormat.

virtual const char* SimpleDateFormat::getLocaleInternal ULocDataLocaleType    type,
UErrorCode   status
const [virtual]
 

Get the locale for this date format object.

You can choose between valid and actual locale.

Parameters:
type  type of the locale we're looking for (valid or actual)
status  error code for the operation
Returns:
the locale
Internal:
For internal use only.

Reimplemented from Format.

UClassID 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

void SimpleDateFormat::initialize const Locale   locale,
UErrorCode   status
[private]
 

Called by construct() and the various constructors to set up the SimpleDateFormat's Calendar and NumberFormat objects.

Parameters:
locale  The locale for which we want a Calendar and a NumberFormat.
statuc  Filled in with an error code if creating either subobject fails.

Calendar* SimpleDateFormat::initializeCalendar TimeZone   adoptZone,
const Locale   locale,
UErrorCode   status
[private]
 

initializes fCalendar from parameters.

Returns fCalendar as a convenience.

Parameters:
adoptZone  Zone to be adopted, or NULL for TimeZone::createDefault().
locale  Locale of the calendar
status  Error code
Returns:
the newly constructed fCalendar

void SimpleDateFormat::initializeDefaultCentury void    [private]
 

void SimpleDateFormat::initializeSymbols const Locale   locale,
Calendar   calendar,
UErrorCode   status
[private]
 

initializes fSymbols from parameters.

Parameters:
locale  Locale of the symbols
calendar  Alias to Calendar that will be used.
status  Error code

UBool SimpleDateFormat::isNumeric UChar    formatChar,
int32_t    count
[static, private]
 

Return true if the given format character, occuring count times, represents a numeric field.

int32_t SimpleDateFormat::matchString const UnicodeString   text,
int32_t    start,
UCalendarDateFields    field,
const UnicodeString   stringArray,
int32_t    stringArrayCount,
Calendar   cal
const [private]
 

Private code-size reduction function used by subParse.

Parameters:
text  the time text being parsed.
start  where to start parsing.
field  the date field being parsed.
stringArray  the string array to parsed.
stringArrayCount  the size of the array.
cal  a Calendar set to the date and time to be formatted into a date/time string.
Returns:
the new start position if matching succeeded; a negative number indicating matching failure, otherwise.

SimpleDateFormat& SimpleDateFormat::operator= const SimpleDateFormat &   
 

Assignment operator.

Stable:
ICU 2.0

virtual UBool 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:
other  the object to be compared with.
Returns:
true if the given Format objects are semantically equal.
Stable:
ICU 2.0

Reimplemented from DateFormat.

virtual UDate 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.

Parameters:
text  The date/time string to be parsed
status  Filled 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 DateFormat.

UDate 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)
Parameters:
text  The date/time string to be parsed
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.
Returns:
A valid UDate if the input could be parsed.
Stable:
ICU 2.0

Reimplemented from DateFormat.

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

Parameters:
text  The date/time string to be parsed
cal  a Calendar set to the date and time to be formatted into a date/time string.
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.
Returns:
A valid UDate if the input could be parsed.
Stable:
ICU 2.1

Reimplemented from DateFormat.

void SimpleDateFormat::parseAmbiguousDatesAsAfter UDate    startDate,
UErrorCode   status
[private]
 

Sets the starting date of the 100-year window that dates with 2-digit years are considered to fall within.

Parameters:
startDate  the start date
status  Receives a status code, which will be U_ZERO_ERROR if the operation succeeds.

void SimpleDateFormat::parseInt const UnicodeString   text,
Formattable   number,
ParsePosition   pos,
UBool    allowNegative
const [private]
 

virtual void 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:
d  start UDate used to interpret two-digit year strings.
status  Filled 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 SimpleDateFormat::setDateFormatSymbols const DateFormatSymbols   newFormatSymbols [virtual]
 

Set the date/time formatting data.

Parameters:
newFormatSymbols  the given date-time formatting symbols to copy.
Stable:
ICU 2.0

void SimpleDateFormat::subFormat UnicodeString   appendTo,
UChar    ch,
int32_t    count,
FieldPosition   pos,
Calendar   cal,
UErrorCode   status
const [private]
 

Called by format() to format a single field.

Parameters:
appendTo  Output parameter to receive result. Result is appended to existing contents.
ch  The format character we encountered in the pattern.
count  Number of characters in the current pattern symbol (e.g., "yyyy" in the pattern would result in a call to this function with ch equal to 'y' and count equal to 4)
pos  The FieldPosition being filled in by the format() call. If this function is formatting the field specfied by pos, it will fill in pos with the beginning and ending offsets of the field.
status  Receives a status code, which will be U_ZERO_ERROR if the operation succeeds.

int32_t SimpleDateFormat::subParse const UnicodeString   text,
int32_t &    start,
UChar    ch,
int32_t    count,
UBool    obeyCount,
UBool    allowNegative,
UBool    ambiguousYear[],
Calendar   cal
const [private]
 

Private member function that converts the parsed date strings into timeFields.

Returns -start (for ParsePosition) if failed.

Parameters:
text  the time text to be parsed.
start  where to start parsing.
ch  the pattern character for the date field text to be parsed.
count  the count of a pattern character.
obeyCount  if true then the count is strictly obeyed.
ambiguousYear  If true then the two-digit year == the default start year.
cal  a Calendar set to the date and time to be formatted into a date/time string.
Returns:
the new start position if matching succeeded; a negative number indicating matching failure, otherwise.

virtual UnicodeString& 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:
result  Receives the localized pattern.
status  Output 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& SimpleDateFormat::toPattern UnicodeString   result const [virtual]
 

Return a pattern string describing this date format.

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

void SimpleDateFormat::translatePattern const UnicodeString   originalPattern,
UnicodeString   translatedPattern,
const UnicodeString   from,
const UnicodeString   to,
UErrorCode   status
[static, private]
 

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.

Parameters:
originalPattern  the original pattern.
translatedPattern  Output param to receive the translited pattern.
from  the characters to be translited from.
to  the characters to be translited to.
status  Receives a status code, which will be U_ZERO_ERROR if the operation succeeds.

void SimpleDateFormat::zeroPaddingNumber UnicodeString   appendTo,
int32_t    value,
int32_t    minDigits,
int32_t    maxDigits
const [private]
 

Used by subFormat() to format a numeric value.

Appends to toAppendTo a string representation of "value" having a number of digits between "minDigits" and "maxDigits". Uses the DateFormat's NumberFormat.

Parameters:
appendTo  Output parameter to receive result. Formatted number is appended to existing contents.
value  Value to format.
minDigits  Minimum number of digits the result should have
maxDigits  Maximum number of digits the result should have


Friends And Related Function Documentation

friend class DateFormat [friend]
 

Definition at line 603 of file smpdtfmt.h.


Member Data Documentation

UDate SimpleDateFormat::fDefaultCenturyStart [private]
 

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 809 of file smpdtfmt.h.

int32_t SimpleDateFormat::fDefaultCenturyStartYear [private]
 

See documentation for defaultCenturyStart.

Definition at line 814 of file smpdtfmt.h.

UBool SimpleDateFormat::fHaveDefaultCentury [private]
 

Definition at line 816 of file smpdtfmt.h.

Locale SimpleDateFormat::fLocale [private]
 

The original locale used (for reloading symbols).

Definition at line 793 of file smpdtfmt.h.

UnicodeString SimpleDateFormat::fPattern [private]
 

The formatting pattern for this formatter.

Definition at line 788 of file smpdtfmt.h.

DateFormatSymbols* SimpleDateFormat::fSymbols [private]
 

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 799 of file smpdtfmt.h.

const UCalendarDateFields SimpleDateFormat::fgPatternIndexToCalendarField[] [static, private]
 

Used to map pattern characters to Calendar field identifiers.

Definition at line 778 of file smpdtfmt.h.

const DateFormat::EField SimpleDateFormat::fgPatternIndexToDateFormatField[] [static, private]
 

Map index into pattern character string to DateFormat field number.

Definition at line 783 of file smpdtfmt.h.


The documentation for this class was generated from the following file:
Generated on Mon Nov 24 14:36:52 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001