#include <dtfmtsym.h>
Inheritance diagram for DateFormatSymbols:
Public Types | |
enum | DtContextType { FORMAT, STANDALONE, DT_CONTEXT_COUNT } |
Selector for date formatting context. More... | |
enum | DtWidthType { ABBREVIATED, WIDE, NARROW, DT_WIDTH_COUNT } |
Selector for date formatting width. More... | |
enum | TimeZoneTranslationType { TIMEZONE_SHORT_GENERIC, TIMEZONE_SHORT_STANDARD, TIMEZONE_SHORT_DAYLIGHT, TIMEZONE_LONG_GENERIC, TIMEZONE_LONG_STANDARD, TIMEZONE_LONG_DAYLIGHT, TIMEZONE_EXEMPLAR_CITY, TIMEZONE_COUNT } |
The translation type of the translated zone strings. More... | |
Public Member Functions | |
DateFormatSymbols (UErrorCode &status) | |
Construct a DateFormatSymbols object by loading format data from resources for the default locale, in the default calendar (Gregorian). | |
DateFormatSymbols (const Locale &locale, UErrorCode &status) | |
Construct a DateFormatSymbols object by loading format data from resources for the given locale, in the default calendar (Gregorian). | |
DateFormatSymbols (const char *type, UErrorCode &status) | |
Construct a DateFormatSymbols object by loading format data from resources for the default locale, in the default calendar (Gregorian). | |
DateFormatSymbols (const Locale &locale, const char *type, UErrorCode &status) | |
Construct a DateFormatSymbols object by loading format data from resources for the given locale, in the default calendar (Gregorian). | |
DateFormatSymbols (const DateFormatSymbols &) | |
Copy constructor. | |
DateFormatSymbols & | operator= (const DateFormatSymbols &) |
Assignment operator. | |
virtual | ~DateFormatSymbols () |
Destructor. | |
UBool | operator== (const DateFormatSymbols &other) const |
Return true if another object is semantically equal to this one. | |
UBool | operator!= (const DateFormatSymbols &other) const |
Return true if another object is semantically unequal to this one. | |
const UnicodeString * | getEras (int32_t &count) const |
Gets era strings. | |
void | setEras (const UnicodeString *eras, int32_t count) |
Sets era strings. | |
const UnicodeString * | getEraNames (int32_t &count) const |
Gets era name strings. | |
void | setEraNames (const UnicodeString *eraNames, int32_t count) |
Sets era name strings. | |
const UnicodeString * | getMonths (int32_t &count) const |
Gets month strings. | |
void | setMonths (const UnicodeString *months, int32_t count) |
Sets month strings. | |
const UnicodeString * | getShortMonths (int32_t &count) const |
Gets short month strings. | |
void | setShortMonths (const UnicodeString *shortMonths, int32_t count) |
Sets short month strings. | |
const UnicodeString * | getMonths (int32_t &count, DtContextType context, DtWidthType width) const |
Gets month strings by width and context. | |
void | setMonths (const UnicodeString *months, int32_t count, DtContextType context, DtWidthType width) |
Sets month strings by width and context. | |
const UnicodeString * | getWeekdays (int32_t &count) const |
Gets weekday strings. | |
void | setWeekdays (const UnicodeString *weekdays, int32_t count) |
Sets weekday strings. | |
const UnicodeString * | getShortWeekdays (int32_t &count) const |
Gets short weekday strings. | |
void | setShortWeekdays (const UnicodeString *shortWeekdays, int32_t count) |
Sets short weekday strings. | |
const UnicodeString * | getWeekdays (int32_t &count, DtContextType context, DtWidthType width) const |
Gets weekday strings by width and context. | |
void | setWeekdays (const UnicodeString *weekdays, int32_t count, DtContextType context, DtWidthType width) |
Sets weekday strings by width and context. | |
const UnicodeString * | getQuarters (int32_t &count, DtContextType context, DtWidthType width) const |
Gets quarter strings by width and context. | |
void | setQuarters (const UnicodeString *quarters, int32_t count, DtContextType context, DtWidthType width) |
Sets quarter strings by width and context. | |
const UnicodeString * | getAmPmStrings (int32_t &count) const |
Gets AM/PM strings. | |
void | setAmPmStrings (const UnicodeString *ampms, int32_t count) |
Sets ampm strings. | |
const UnicodeString ** | getZoneStrings (int32_t &rowCount, int32_t &columnCount) const |
Gets timezone strings. | |
void | setZoneStrings (const UnicodeString *const *strings, int32_t rowCount, int32_t columnCount) |
Sets timezone strings. | |
UnicodeString & | getLocalPatternChars (UnicodeString &result) const |
Gets localized date-time pattern characters. | |
void | setLocalPatternChars (const UnicodeString &newLocalPatternChars) |
Sets localized date-time pattern characters. | |
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const |
Returns the locale for this object. | |
virtual UClassID | getDynamicClassID () const |
ICU "poor man's RTTI", returns a UClassID for the actual class. | |
virtual StringEnumeration * | createZoneStringIDs (UErrorCode &status) |
Creates an enumeration of time zone IDs. | |
UnicodeString & | getZoneString (const UnicodeString &ID, const TimeZoneTranslationType type, UnicodeString &result, UErrorCode &status) |
Gets timezone string give the key and translation type. | |
void | setZoneString (const UnicodeString &ID, const TimeZoneTranslationType type, const UnicodeString &value, UErrorCode &status) |
Sets timezone string for the given the ID and translation type. | |
Static Public Member Functions | |
static const UChar * | getPatternUChars (void) |
Get the non-localized date-time pattern characters. | |
static UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. | |
Friends | |
class | SimpleDateFormat |
class | DateFormatSymbolsSingleSetter |
DateFormatSymbols is used by DateFormat and SimpleDateFormat.
Rather than first creating a DateFormatSymbols to get a date-time formatter by using a SimpleDateFormat constructor, clients are encouraged to create a date-time formatter using the getTimeInstance(), getDateInstance(), or getDateTimeInstance() method in DateFormat. Each of these methods can return a date/time formatter initialized with a default format pattern along with the date-time formatting data for a given or default locale. After a formatter is created, clients may modify the format pattern using the setPattern function as so desired. For more information on using these formatter factory functions, see DateFormat.
If clients decide to create a date-time formatter with a particular format pattern and locale, they can do so with new SimpleDateFormat(aPattern, new DateFormatSymbols(aLocale)). This will load the appropriate date-time formatting data from the locale.
DateFormatSymbols objects are clonable. When clients obtain a DateFormatSymbols object, they can feel free to modify the date-time formatting data as necessary. For instance, clients can replace the localized date-time format pattern characters with the ones that they feel easy to remember. Or they can change the representative cities originally picked by default to using their favorite ones.
DateFormatSymbols are not expected to be subclassed. Data for a calendar is loaded out of resource bundles. The 'type' parameter indicates the type of calendar, for example, "gregorian" or "japanese". If the type is not gregorian (or NULL, or an empty string) then the type is appended to the resource name, for example, 'Eras_japanese' instead of 'Eras'. If the resource 'Eras_japanese' did not exist (even in root), then this class will fall back to just 'Eras', that is, Gregorian data. Therefore, the calendar implementor MUST ensure that the root locale at least contains any resources that are to be particularized for the calendar type.
Definition at line 77 of file dtfmtsym.h.
Selector for date formatting context.
Definition at line 251 of file dtfmtsym.h.
Selector for date formatting width.
Definition at line 261 of file dtfmtsym.h.
The translation type of the translated zone strings.
TIMEZONE_SHORT_GENERIC | |
TIMEZONE_SHORT_STANDARD | |
TIMEZONE_SHORT_DAYLIGHT | |
TIMEZONE_LONG_GENERIC | |
TIMEZONE_LONG_STANDARD | |
TIMEZONE_LONG_DAYLIGHT | |
TIMEZONE_EXEMPLAR_CITY | |
TIMEZONE_COUNT |
Definition at line 447 of file dtfmtsym.h.
DateFormatSymbols::DateFormatSymbols | ( | UErrorCode & | status | ) |
Construct a DateFormatSymbols object by loading format data from resources for the default locale, in the default calendar (Gregorian).
NOTE: This constructor will never fail; if it cannot get resource data for the default locale, it will return a last-resort object based on hard-coded strings.
status | Status code. Failure results if the resources for the default cannot be found or cannot be loaded |
DateFormatSymbols::DateFormatSymbols | ( | const Locale & | locale, | |
UErrorCode & | status | |||
) |
Construct a DateFormatSymbols object by loading format data from resources for the given locale, in the default calendar (Gregorian).
locale | Locale to load format data from. | |
status | Status code. Failure results if the resources for the locale cannot be found or cannot be loaded |
DateFormatSymbols::DateFormatSymbols | ( | const char * | type, | |
UErrorCode & | status | |||
) |
Construct a DateFormatSymbols object by loading format data from resources for the default locale, in the default calendar (Gregorian).
NOTE: This constructor will never fail; if it cannot get resource data for the default locale, it will return a last-resort object based on hard-coded strings.
type | Type of calendar (as returned by Calendar::getType). Will be used to access the correct set of strings. (NULL or empty string defaults to "gregorian".) | |
status | Status code. Failure results if the resources for the default cannot be found or cannot be loaded |
DateFormatSymbols::DateFormatSymbols | ( | const Locale & | locale, | |
const char * | type, | |||
UErrorCode & | status | |||
) |
Construct a DateFormatSymbols object by loading format data from resources for the given locale, in the default calendar (Gregorian).
locale | Locale to load format data from. | |
type | Type of calendar (as returned by Calendar::getType). Will be used to access the correct set of strings. (NULL or empty string defaults to "gregorian".) | |
status | Status code. Failure results if the resources for the locale cannot be found or cannot be loaded |
DateFormatSymbols::DateFormatSymbols | ( | const DateFormatSymbols & | ) |
virtual DateFormatSymbols::~DateFormatSymbols | ( | ) | [virtual] |
DateFormatSymbols& DateFormatSymbols::operator= | ( | const DateFormatSymbols & | ) |
UBool DateFormatSymbols::operator== | ( | const DateFormatSymbols & | other | ) | const |
Return true if another object is semantically equal to this one.
other | the DateFormatSymbols object to be compared with. |
UBool DateFormatSymbols::operator!= | ( | const DateFormatSymbols & | other | ) | const [inline] |
Return true if another object is semantically unequal to this one.
other | the DateFormatSymbols object to be compared with. |
Definition at line 177 of file dtfmtsym.h.
const UnicodeString* DateFormatSymbols::getEras | ( | int32_t & | count | ) | const |
Gets era strings.
For example: "AD" and "BC".
count | Filled in with length of the array. |
void DateFormatSymbols::setEras | ( | const UnicodeString * | eras, | |
int32_t | count | |||
) |
Sets era strings.
For example: "AD" and "BC".
eras | Array of era strings (DateFormatSymbols retains ownership.) | |
count | Filled in with length of the array. |
const UnicodeString* DateFormatSymbols::getEraNames | ( | int32_t & | count | ) | const |
Gets era name strings.
For example: "Anno Domini" and "Before Christ".
count | Filled in with length of the array. |
void DateFormatSymbols::setEraNames | ( | const UnicodeString * | eraNames, | |
int32_t | count | |||
) |
Sets era name strings.
For example: "Anno Domini" and "Before Christ".
eraNames | Array of era name strings (DateFormatSymbols retains ownership.) | |
count | Filled in with length of the array. |
const UnicodeString* DateFormatSymbols::getMonths | ( | int32_t & | count | ) | const |
Gets month strings.
For example: "January", "February", etc.
count | Filled in with length of the array. |
void DateFormatSymbols::setMonths | ( | const UnicodeString * | months, | |
int32_t | count | |||
) |
Sets month strings.
For example: "January", "February", etc.
months | the new month strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. |
const UnicodeString* DateFormatSymbols::getShortMonths | ( | int32_t & | count | ) | const |
Gets short month strings.
For example: "Jan", "Feb", etc.
count | Filled in with length of the array. |
void DateFormatSymbols::setShortMonths | ( | const UnicodeString * | shortMonths, | |
int32_t | count | |||
) |
Sets short month strings.
For example: "Jan", "Feb", etc.
count | Filled in with length of the array. | |
shortMonths | the new short month strings. (not adopted; caller retains ownership) |
const UnicodeString* DateFormatSymbols::getMonths | ( | int32_t & | count, | |
DtContextType | context, | |||
DtWidthType | width | |||
) | const |
Gets month strings by width and context.
For example: "January", "February", etc.
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE, ABBREVIATED, or NARROW. |
void DateFormatSymbols::setMonths | ( | const UnicodeString * | months, | |
int32_t | count, | |||
DtContextType | context, | |||
DtWidthType | width | |||
) |
Sets month strings by width and context.
For example: "January", "February", etc.
months | The new month strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE, ABBREVIATED, or NARROW. |
const UnicodeString* DateFormatSymbols::getWeekdays | ( | int32_t & | count | ) | const |
Gets weekday strings.
For example: "Sunday", "Monday", etc.
count | Filled in with length of the array. |
void DateFormatSymbols::setWeekdays | ( | const UnicodeString * | weekdays, | |
int32_t | count | |||
) |
Sets weekday strings.
For example: "Sunday", "Monday", etc.
weekdays | the new weekday strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. |
const UnicodeString* DateFormatSymbols::getShortWeekdays | ( | int32_t & | count | ) | const |
Gets short weekday strings.
For example: "Sun", "Mon", etc.
count | Filled in with length of the array. |
void DateFormatSymbols::setShortWeekdays | ( | const UnicodeString * | shortWeekdays, | |
int32_t | count | |||
) |
Sets short weekday strings.
For example: "Sun", "Mon", etc.
shortWeekdays | the new short weekday strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. |
const UnicodeString* DateFormatSymbols::getWeekdays | ( | int32_t & | count, | |
DtContextType | context, | |||
DtWidthType | width | |||
) | const |
Gets weekday strings by width and context.
For example: "Sunday", "Monday", etc.
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE, ABBREVIATED, or NARROW |
void DateFormatSymbols::setWeekdays | ( | const UnicodeString * | weekdays, | |
int32_t | count, | |||
DtContextType | context, | |||
DtWidthType | width | |||
) |
Sets weekday strings by width and context.
For example: "Sunday", "Monday", etc.
weekdays | The new weekday strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE, ABBREVIATED, or NARROW |
const UnicodeString* DateFormatSymbols::getQuarters | ( | int32_t & | count, | |
DtContextType | context, | |||
DtWidthType | width | |||
) | const |
Gets quarter strings by width and context.
For example: "1st Quarter", "2nd Quarter", etc.
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE or ABBREVIATED. There are no NARROW quarters. |
void DateFormatSymbols::setQuarters | ( | const UnicodeString * | quarters, | |
int32_t | count, | |||
DtContextType | context, | |||
DtWidthType | width | |||
) |
Sets quarter strings by width and context.
For example: "1st Quarter", "2nd Quarter", etc.
quarters | The new quarter strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. | |
context | The formatting context, either FORMAT or STANDALONE | |
width | The width of returned strings, either WIDE or ABBREVIATED. There are no NARROW quarters. |
const UnicodeString* DateFormatSymbols::getAmPmStrings | ( | int32_t & | count | ) | const |
Gets AM/PM strings.
For example: "AM" and "PM".
count | Filled in with length of the array. |
void DateFormatSymbols::setAmPmStrings | ( | const UnicodeString * | ampms, | |
int32_t | count | |||
) |
Sets ampm strings.
For example: "AM" and "PM".
ampms | the new ampm strings. (not adopted; caller retains ownership) | |
count | Filled in with length of the array. |
const UnicodeString** DateFormatSymbols::getZoneStrings | ( | int32_t & | rowCount, | |
int32_t & | columnCount | |||
) | const |
Gets timezone strings.
These strings are stored in a 2-dimensional array.
rowCount | Output param to receive number of rows. | |
columnCount | Output param to receive number of columns. |
void DateFormatSymbols::setZoneStrings | ( | const UnicodeString *const * | strings, | |
int32_t | rowCount, | |||
int32_t | columnCount | |||
) |
Sets timezone strings.
These strings are stored in a 2-dimensional array.
strings | The timezone strings as a 2-d array to be copied. (not adopted; caller retains ownership) | |
rowCount | The number of rows (count of first index). | |
columnCount | The number of columns (count of second index). |
static const UChar* DateFormatSymbols::getPatternUChars | ( | void | ) | [static] |
Get the non-localized date-time pattern characters.
UnicodeString& DateFormatSymbols::getLocalPatternChars | ( | UnicodeString & | result | ) | const |
Gets localized date-time pattern characters.
For example: 'u', 't', etc.
result | Output param which will receive the localized date-time pattern characters. |
void DateFormatSymbols::setLocalPatternChars | ( | const UnicodeString & | newLocalPatternChars | ) |
Sets localized date-time pattern characters.
For example: 'u', 't', etc.
newLocalPatternChars | the new localized date-time pattern characters. |
Locale DateFormatSymbols::getLocale | ( | ULocDataLocaleType | type, | |
UErrorCode & | status | |||
) | const |
Returns the locale for this object.
Two flavors are available: valid and actual locale.
virtual UClassID DateFormatSymbols::getDynamicClassID | ( | ) | const [virtual] |
static UClassID DateFormatSymbols::getStaticClassID | ( | ) | [static] |
virtual StringEnumeration* DateFormatSymbols::createZoneStringIDs | ( | UErrorCode & | status | ) | [virtual] |
Creates an enumeration of time zone IDs.
The object is owned by the caller and should delete it after use. The time zone IDs are just for programmatic lookup. NOT LOCALIZED!!!
status | Input/output parameter, set to success or failure code upon return. |
UnicodeString& DateFormatSymbols::getZoneString | ( | const UnicodeString & | ID, | |
const TimeZoneTranslationType | type, | |||
UnicodeString & | result, | |||
UErrorCode & | status | |||
) |
Gets timezone string give the key and translation type.
ID | The ID of zone strings, e.g: "America/Los_Angeles". The time zone ID is for programmatic lookup. | |
type | The translation type requested | |
result | Output parameter to recieve the translation string | |
status | Input/output parameter, set to success or failure code upon return. |
void DateFormatSymbols::setZoneString | ( | const UnicodeString & | ID, | |
const TimeZoneTranslationType | type, | |||
const UnicodeString & | value, | |||
UErrorCode & | status | |||
) |
Sets timezone string for the given the ID and translation type.
ID | The ID of zone strings, e.g: "America/Los_Angeles". The time zone ID is for programmatic lookup. | |
type | The translation type to set the value for | |
value | The string with which current translation needs to be replaced | |
status | Input/output parameter, set to success or |