ICU 60.1  60.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends
icu::DateFormatSymbols Class Referencefinal

DateFormatSymbols is a public class for encapsulating localizable date-time formatting data – including timezone data. More...

#include <dtfmtsym.h>

Inheritance diagram for icu::DateFormatSymbols:
icu::UObject icu::UMemory

Public Types

enum  DtContextType { FORMAT, STANDALONE, DT_CONTEXT_COUNT }
 Selector for date formatting context. More...
 
enum  DtWidthType {
  ABBREVIATED, WIDE, NARROW, SHORT,
  DT_WIDTH_COUNT = 4
}
 Selector for date formatting width. More...
 
enum  EMonthPatternType {
  kLeapMonthPatternFormatWide, kLeapMonthPatternFormatAbbrev, kLeapMonthPatternFormatNarrow, kLeapMonthPatternStandaloneWide,
  kLeapMonthPatternStandaloneAbbrev, kLeapMonthPatternStandaloneNarrow, kLeapMonthPatternNumeric, kMonthPatternsCount
}
 Somewhat temporary constants for leap month pattern types, adequate for supporting just leap month patterns as needed for Chinese lunar calendar. More...
 
enum  ECapitalizationContextUsageType {
  kCapContextUsageOther = 0, kCapContextUsageMonthFormat, kCapContextUsageMonthStandalone, kCapContextUsageMonthNarrow,
  kCapContextUsageDayFormat, kCapContextUsageDayStandalone, kCapContextUsageDayNarrow, kCapContextUsageEraWide,
  kCapContextUsageEraAbbrev, kCapContextUsageEraNarrow, kCapContextUsageZoneLong, kCapContextUsageZoneShort,
  kCapContextUsageMetazoneLong, kCapContextUsageMetazoneShort, kCapContextUsageTypeCount = 14
}
 Constants for capitalization context usage types. 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). More...
 
 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). More...
 
 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). More...
 
 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). More...
 
 DateFormatSymbols (const DateFormatSymbols &)
 Copy constructor. More...
 
DateFormatSymbolsoperator= (const DateFormatSymbols &)
 Assignment operator. More...
 
virtual ~DateFormatSymbols ()
 Destructor. More...
 
UBool operator== (const DateFormatSymbols &other) const
 Return true if another object is semantically equal to this one. More...
 
UBool operator!= (const DateFormatSymbols &other) const
 Return true if another object is semantically unequal to this one. More...
 
const UnicodeStringgetEras (int32_t &count) const
 Gets abbreviated era strings. More...
 
void setEras (const UnicodeString *eras, int32_t count)
 Sets abbreviated era strings. More...
 
const UnicodeStringgetEraNames (int32_t &count) const
 Gets era name strings. More...
 
void setEraNames (const UnicodeString *eraNames, int32_t count)
 Sets era name strings. More...
 
const UnicodeStringgetNarrowEras (int32_t &count) const
 Gets narrow era strings. More...
 
void setNarrowEras (const UnicodeString *narrowEras, int32_t count)
 Sets narrow era strings. More...
 
const UnicodeStringgetMonths (int32_t &count) const
 Gets month strings. More...
 
void setMonths (const UnicodeString *months, int32_t count)
 Sets month strings. More...
 
const UnicodeStringgetShortMonths (int32_t &count) const
 Gets short month strings. More...
 
void setShortMonths (const UnicodeString *shortMonths, int32_t count)
 Sets short month strings. More...
 
const UnicodeStringgetMonths (int32_t &count, DtContextType context, DtWidthType width) const
 Gets month strings by width and context. More...
 
void setMonths (const UnicodeString *months, int32_t count, DtContextType context, DtWidthType width)
 Sets month strings by width and context. More...
 
const UnicodeStringgetWeekdays (int32_t &count) const
 Gets wide weekday strings. More...
 
void setWeekdays (const UnicodeString *weekdays, int32_t count)
 Sets wide weekday strings. More...
 
const UnicodeStringgetShortWeekdays (int32_t &count) const
 Gets abbreviated weekday strings. More...
 
void setShortWeekdays (const UnicodeString *abbrevWeekdays, int32_t count)
 Sets abbreviated weekday strings. More...
 
const UnicodeStringgetWeekdays (int32_t &count, DtContextType context, DtWidthType width) const
 Gets weekday strings by width and context. More...
 
void setWeekdays (const UnicodeString *weekdays, int32_t count, DtContextType context, DtWidthType width)
 Sets weekday strings by width and context. More...
 
const UnicodeStringgetQuarters (int32_t &count, DtContextType context, DtWidthType width) const
 Gets quarter strings by width and context. More...
 
void setQuarters (const UnicodeString *quarters, int32_t count, DtContextType context, DtWidthType width)
 Sets quarter strings by width and context. More...
 
const UnicodeStringgetAmPmStrings (int32_t &count) const
 Gets AM/PM strings. More...
 
void setAmPmStrings (const UnicodeString *ampms, int32_t count)
 Sets ampm strings. More...
 
UnicodeStringgetTimeSeparatorString (UnicodeString &result) const
 Gets the time separator string. More...
 
void setTimeSeparatorString (const UnicodeString &newTimeSeparator)
 Sets the time separator string. More...
 
const UnicodeStringgetYearNames (int32_t &count, DtContextType context, DtWidthType width) const
 Gets cyclic year name strings if the calendar has them, by width and context. More...
 
void setYearNames (const UnicodeString *yearNames, int32_t count, DtContextType context, DtWidthType width)
 Sets cyclic year name strings by width and context. More...
 
const UnicodeStringgetZodiacNames (int32_t &count, DtContextType context, DtWidthType width) const
 Gets calendar zodiac name strings if the calendar has them, by width and context. More...
 
void setZodiacNames (const UnicodeString *zodiacNames, int32_t count, DtContextType context, DtWidthType width)
 Sets calendar zodiac name strings by width and context. More...
 
const UnicodeStringgetLeapMonthPatterns (int32_t &count) const
 Somewhat temporary function for getting complete set of leap month patterns for all contexts & widths, indexed by EMonthPatternType values. More...
 
const UnicodeString ** getZoneStrings (int32_t &rowCount, int32_t &columnCount) const
 Gets timezone strings. More...
 
void setZoneStrings (const UnicodeString *const *strings, int32_t rowCount, int32_t columnCount)
 Sets timezone strings. More...
 
UnicodeStringgetLocalPatternChars (UnicodeString &result) const
 Gets localized date-time pattern characters. More...
 
void setLocalPatternChars (const UnicodeString &newLocalPatternChars)
 Sets localized date-time pattern characters. More...
 
Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const
 Returns the locale for this object. More...
 
virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...
 
- Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor. More...
 

Static Public Member Functions

static const char16_t * getPatternUChars (void)
 Get the non-localized date-time pattern characters. More...
 
static UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class. More...
 
static DateFormatSymbolscreateForLocale (const Locale &locale, UErrorCode &status)
 Gets a DateFormatSymbols by locale. More...
 

Static Public Attributes

static const char16_t DEFAULT_TIME_SEPARATOR = 0x003a
 This default time separator is used for formatting when the locale doesn't specify any time separator, and always recognized when parsing. More...
 
static const char16_t ALTERNATE_TIME_SEPARATOR = 0x002e
 This alternate time separator is always recognized when parsing. More...
 

Friends

class SimpleDateFormat
 
class DateFormatSymbolsSingleSetter
 

Detailed Description

DateFormatSymbols is a public class for encapsulating localizable date-time formatting data – including timezone data.

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 82 of file dtfmtsym.h.

Member Enumeration Documentation

◆ DtContextType

Selector for date formatting context.

Stable:
ICU 3.6
Enumerator
DT_CONTEXT_COUNT 

One more than the highest normal DtContextType value.

Deprecated:
ICU 58 The numeric value may change over time, see ICU ticket #12420.

Definition at line 275 of file dtfmtsym.h.

◆ DtWidthType

Selector for date formatting width.

Stable:
ICU 3.6
Enumerator
SHORT 

Short width is currently only supported for weekday names.

Stable:
ICU 51
DT_WIDTH_COUNT 

One more than the highest normal DtWidthType value.

Deprecated:
ICU 58 The numeric value may change over time, see ICU ticket #12420.

Definition at line 291 of file dtfmtsym.h.

◆ ECapitalizationContextUsageType

Constants for capitalization context usage types.

Internal:
Do not use. This API is for internal use only.

Definition at line 605 of file dtfmtsym.h.

◆ EMonthPatternType

Somewhat temporary constants for leap month pattern types, adequate for supporting just leap month patterns as needed for Chinese lunar calendar.

Eventually we will add full support for different month pattern types (needed for other calendars such as Hindu) at which point this approach will be replaced by a more complete approach.

Internal:
Do not use. This API is for internal use only.

Definition at line 513 of file dtfmtsym.h.

Constructor & Destructor Documentation

◆ DateFormatSymbols() [1/5]

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

Parameters
statusStatus code. Failure results if the resources for the default cannot be found or cannot be loaded
Stable:
ICU 2.0

◆ DateFormatSymbols() [2/5]

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

Parameters
localeLocale to load format data from.
statusStatus code. Failure results if the resources for the locale cannot be found or cannot be loaded
Stable:
ICU 2.0

◆ DateFormatSymbols() [3/5]

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

Parameters
typeType of calendar (as returned by Calendar::getType). Will be used to access the correct set of strings. (NULL or empty string defaults to "gregorian".)
statusStatus code. Failure results if the resources for the default cannot be found or cannot be loaded
Internal:
Do not use. This API is for internal use only.

◆ DateFormatSymbols() [4/5]

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

Parameters
localeLocale to load format data from.
typeType of calendar (as returned by Calendar::getType). Will be used to access the correct set of strings. (NULL or empty string defaults to "gregorian".)
statusStatus code. Failure results if the resources for the locale cannot be found or cannot be loaded
Internal:
Do not use. This API is for internal use only.

◆ DateFormatSymbols() [5/5]

icu::DateFormatSymbols::DateFormatSymbols ( const DateFormatSymbols )

Copy constructor.

Stable:
ICU 2.0

◆ ~DateFormatSymbols()

virtual icu::DateFormatSymbols::~DateFormatSymbols ( )
virtual

Destructor.

This is nonvirtual because this class is not designed to be subclassed.

Stable:
ICU 2.0

Member Function Documentation

◆ createForLocale()

static DateFormatSymbols* icu::DateFormatSymbols::createForLocale ( const Locale locale,
UErrorCode status 
)
static

Gets a DateFormatSymbols by locale.

Unlike the constructors which always use gregorian calendar, this method uses the calendar in the locale. If the locale contains no explicit calendar, this method uses the default calendar for that locale.

Parameters
localethe locale.
statuserror returned here.
Returns
the new DateFormatSymbols which the caller owns.
Internal:
Do not use. This API is for internal use only. For ICU use only.

◆ getAmPmStrings()

const UnicodeString* icu::DateFormatSymbols::getAmPmStrings ( int32_t &  count) const

Gets AM/PM strings.

For example: "AM" and "PM".

Parameters
countFilled in with length of the array.
Returns
the weekday strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 2.0

◆ getDynamicClassID()

virtual UClassID icu::DateFormatSymbols::getDynamicClassID ( ) const
virtual

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
ICU 2.2

Reimplemented from icu::UObject.

◆ getEraNames()

const UnicodeString* icu::DateFormatSymbols::getEraNames ( int32_t &  count) const

Gets era name strings.

For example: "Anno Domini" and "Before Christ".

Parameters
countFilled in with length of the array.
Returns
the era name strings.
Stable:
ICU 3.4

◆ getEras()

const UnicodeString* icu::DateFormatSymbols::getEras ( int32_t &  count) const

Gets abbreviated era strings.

For example: "AD" and "BC".

Parameters
countFilled in with length of the array.
Returns
the era strings.
Stable:
ICU 2.0

◆ getLeapMonthPatterns()

const UnicodeString* icu::DateFormatSymbols::getLeapMonthPatterns ( int32_t &  count) const

Somewhat temporary function for getting complete set of leap month patterns for all contexts & widths, indexed by EMonthPatternType values.

Returns NULL if calendar does not have leap month patterns. Note, there is currently no setter for this. Eventually we will add full support for different month pattern types (needed for other calendars such as Hindu) at which point this approach will be replaced by a more complete approach.

Parameters
countFilled in with length of the array (may be 0).
Returns
The leap month patterns (DateFormatSymbols retains ownership). May be NULL if there are no leap month patterns for this calendar.
Internal:
Do not use. This API is for internal use only.

◆ getLocale()

Locale icu::DateFormatSymbols::getLocale ( ULocDataLocaleType  type,
UErrorCode status 
) const

Returns the locale for this object.

Two flavors are available: valid and actual locale.

Stable:
ICU 2.8

◆ getLocalPatternChars()

UnicodeString& icu::DateFormatSymbols::getLocalPatternChars ( UnicodeString result) const

Gets localized date-time pattern characters.

For example: 'u', 't', etc.

Note: ICU no longer provides localized date-time pattern characters for a locale starting ICU 3.8. This method returns the non-localized date-time pattern characters unless user defined localized data is set by setLocalPatternChars.

Parameters
resultOutput param which will receive the localized date-time pattern characters.
Returns
A reference to 'result'.
Stable:
ICU 2.0

◆ getMonths() [1/2]

const UnicodeString* icu::DateFormatSymbols::getMonths ( int32_t &  count) const

Gets month strings.

For example: "January", "February", etc.

Parameters
countFilled in with length of the array.
Returns
the month strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 2.0

◆ getMonths() [2/2]

const UnicodeString* icu::DateFormatSymbols::getMonths ( int32_t &  count,
DtContextType  context,
DtWidthType  width 
) const

Gets month strings by width and context.

For example: "January", "February", etc.

Parameters
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE, ABBREVIATED, or NARROW.
Returns
the month strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 3.4

◆ getNarrowEras()

const UnicodeString* icu::DateFormatSymbols::getNarrowEras ( int32_t &  count) const

Gets narrow era strings.

For example: "A" and "B".

Parameters
countFilled in with length of the array.
Returns
the narrow era strings.
Stable:
ICU 4.2

◆ getPatternUChars()

static const char16_t* icu::DateFormatSymbols::getPatternUChars ( void  )
static

Get the non-localized date-time pattern characters.

Returns
the non-localized date-time pattern characters
Stable:
ICU 2.0

◆ getQuarters()

const UnicodeString* icu::DateFormatSymbols::getQuarters ( int32_t &  count,
DtContextType  context,
DtWidthType  width 
) const

Gets quarter strings by width and context.

For example: "1st Quarter", "2nd Quarter", etc.

Parameters
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE or ABBREVIATED. There are no NARROW quarters.
Returns
the quarter strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 3.6

◆ getShortMonths()

const UnicodeString* icu::DateFormatSymbols::getShortMonths ( int32_t &  count) const

Gets short month strings.

For example: "Jan", "Feb", etc.

Parameters
countFilled in with length of the array.
Returns
the short month strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 2.0

◆ getShortWeekdays()

const UnicodeString* icu::DateFormatSymbols::getShortWeekdays ( int32_t &  count) const

Gets abbreviated weekday strings.

For example: "Sun", "Mon", etc. (Note: The method name is misleading; it does not get the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)

Parameters
countFilled in with length of the array.
Returns
the abbreviated weekday strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 2.0

◆ getStaticClassID()

static UClassID icu::DateFormatSymbols::getStaticClassID ( )
static

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:
ICU 2.2

◆ getTimeSeparatorString()

UnicodeString& icu::DateFormatSymbols::getTimeSeparatorString ( UnicodeString result) const

Gets the time separator string.

For example: ":".

Parameters
resultOutput param which will receive the time separator string.
Returns
A reference to 'result'.
Internal:
Do not use. This API is for internal use only.

◆ getWeekdays() [1/2]

const UnicodeString* icu::DateFormatSymbols::getWeekdays ( int32_t &  count) const

Gets wide weekday strings.

For example: "Sunday", "Monday", etc.

Parameters
countFilled in with length of the array.
Returns
the weekday strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 2.0

◆ getWeekdays() [2/2]

const UnicodeString* icu::DateFormatSymbols::getWeekdays ( int32_t &  count,
DtContextType  context,
DtWidthType  width 
) const

Gets weekday strings by width and context.

For example: "Sunday", "Monday", etc.

Parameters
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE, ABBREVIATED, SHORT, or NARROW
Returns
the month strings. (DateFormatSymbols retains ownership.)
Stable:
ICU 3.4

◆ getYearNames()

const UnicodeString* icu::DateFormatSymbols::getYearNames ( int32_t &  count,
DtContextType  context,
DtWidthType  width 
) const

Gets cyclic year name strings if the calendar has them, by width and context.

For example: "jia-zi", "yi-chou", etc.

Parameters
countFilled in with length of the array.
contextThe usage context: FORMAT, STANDALONE.
widthThe requested name width: WIDE, ABBREVIATED, NARROW.
Returns
The year name strings (DateFormatSymbols retains ownership), or null if they are not available for this calendar.
Stable:
ICU 54

◆ getZodiacNames()

const UnicodeString* icu::DateFormatSymbols::getZodiacNames ( int32_t &  count,
DtContextType  context,
DtWidthType  width 
) const

Gets calendar zodiac name strings if the calendar has them, by width and context.

For example: "Rat", "Ox", "Tiger", etc.

Parameters
countFilled in with length of the array.
contextThe usage context: FORMAT, STANDALONE.
widthThe requested name width: WIDE, ABBREVIATED, NARROW.
Returns
The zodiac name strings (DateFormatSymbols retains ownership), or null if they are not available for this calendar.
Stable:
ICU 54

◆ getZoneStrings()

const UnicodeString** icu::DateFormatSymbols::getZoneStrings ( int32_t &  rowCount,
int32_t &  columnCount 
) const

Gets timezone strings.

These strings are stored in a 2-dimensional array.

Parameters
rowCountOutput param to receive number of rows.
columnCountOutput param to receive number of columns.
Returns
The timezone strings as a 2-d array. (DateFormatSymbols retains ownership.)
Deprecated:
ICU 3.6

◆ operator!=()

UBool icu::DateFormatSymbols::operator!= ( const DateFormatSymbols other) const
inline

Return true if another object is semantically unequal to this one.

Parameters
otherthe DateFormatSymbols object to be compared with.
Returns
true if other is semantically unequal to this.
Stable:
ICU 2.0

Definition at line 184 of file dtfmtsym.h.

References icu::operator==().

◆ operator=()

DateFormatSymbols& icu::DateFormatSymbols::operator= ( const DateFormatSymbols )

Assignment operator.

Stable:
ICU 2.0

◆ operator==()

UBool icu::DateFormatSymbols::operator== ( const DateFormatSymbols other) const

Return true if another object is semantically equal to this one.

Parameters
otherthe DateFormatSymbols object to be compared with.
Returns
true if other is semantically equal to this.
Stable:
ICU 2.0

◆ setAmPmStrings()

void icu::DateFormatSymbols::setAmPmStrings ( const UnicodeString ampms,
int32_t  count 
)

Sets ampm strings.

For example: "AM" and "PM".

Parameters
ampmsthe new ampm strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
Stable:
ICU 2.0

◆ setEraNames()

void icu::DateFormatSymbols::setEraNames ( const UnicodeString eraNames,
int32_t  count 
)

Sets era name strings.

For example: "Anno Domini" and "Before Christ".

Parameters
eraNamesArray of era name strings (DateFormatSymbols retains ownership.)
countFilled in with length of the array.
Stable:
ICU 3.6

◆ setEras()

void icu::DateFormatSymbols::setEras ( const UnicodeString eras,
int32_t  count 
)

Sets abbreviated era strings.

For example: "AD" and "BC".

Parameters
erasArray of era strings (DateFormatSymbols retains ownership.)
countFilled in with length of the array.
Stable:
ICU 2.0

◆ setLocalPatternChars()

void icu::DateFormatSymbols::setLocalPatternChars ( const UnicodeString newLocalPatternChars)

Sets localized date-time pattern characters.

For example: 'u', 't', etc.

Parameters
newLocalPatternCharsthe new localized date-time pattern characters.
Stable:
ICU 2.0

◆ setMonths() [1/2]

void icu::DateFormatSymbols::setMonths ( const UnicodeString months,
int32_t  count 
)

Sets month strings.

For example: "January", "February", etc.

Parameters
monthsthe new month strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
Stable:
ICU 2.0

◆ setMonths() [2/2]

void icu::DateFormatSymbols::setMonths ( const UnicodeString months,
int32_t  count,
DtContextType  context,
DtWidthType  width 
)

Sets month strings by width and context.

For example: "January", "February", etc.

Parameters
monthsThe new month strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE, ABBREVIATED, or NARROW.
Stable:
ICU 3.6

◆ setNarrowEras()

void icu::DateFormatSymbols::setNarrowEras ( const UnicodeString narrowEras,
int32_t  count 
)

Sets narrow era strings.

For example: "A" and "B".

Parameters
narrowErasArray of narrow era strings (DateFormatSymbols retains ownership.)
countFilled in with length of the array.
Stable:
ICU 4.2

◆ setQuarters()

void icu::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.

Parameters
quartersThe new quarter strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE or ABBREVIATED. There are no NARROW quarters.
Stable:
ICU 3.6

◆ setShortMonths()

void icu::DateFormatSymbols::setShortMonths ( const UnicodeString shortMonths,
int32_t  count 
)

Sets short month strings.

For example: "Jan", "Feb", etc.

Parameters
countFilled in with length of the array.
shortMonthsthe new short month strings. (not adopted; caller retains ownership)
Stable:
ICU 2.0

◆ setShortWeekdays()

void icu::DateFormatSymbols::setShortWeekdays ( const UnicodeString abbrevWeekdays,
int32_t  count 
)

Sets abbreviated weekday strings.

For example: "Sun", "Mon", etc. (Note: The method name is misleading; it does not set the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)

Parameters
abbrevWeekdaysthe new abbreviated weekday strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
Stable:
ICU 2.0

◆ setTimeSeparatorString()

void icu::DateFormatSymbols::setTimeSeparatorString ( const UnicodeString newTimeSeparator)

Sets the time separator string.

For example: ":".

Parameters
newTimeSeparatorthe new time separator string.
Internal:
Do not use. This API is for internal use only.

◆ setWeekdays() [1/2]

void icu::DateFormatSymbols::setWeekdays ( const UnicodeString weekdays,
int32_t  count 
)

Sets wide weekday strings.

For example: "Sunday", "Monday", etc.

Parameters
weekdaysthe new weekday strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
Stable:
ICU 2.0

◆ setWeekdays() [2/2]

void icu::DateFormatSymbols::setWeekdays ( const UnicodeString weekdays,
int32_t  count,
DtContextType  context,
DtWidthType  width 
)

Sets weekday strings by width and context.

For example: "Sunday", "Monday", etc.

Parameters
weekdaysThe new weekday strings. (not adopted; caller retains ownership)
countFilled in with length of the array.
contextThe formatting context, either FORMAT or STANDALONE
widthThe width of returned strings, either WIDE, ABBREVIATED, SHORT, or NARROW
Stable:
ICU 3.6

◆ setYearNames()

void icu::DateFormatSymbols::setYearNames ( const UnicodeString yearNames,
int32_t  count,
DtContextType  context,
DtWidthType  width 
)

Sets cyclic year name strings by width and context.

For example: "jia-zi", "yi-chou", etc.

Parameters
yearNamesThe new cyclic year name strings (not adopted; caller retains ownership).
countThe length of the array.
contextThe usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
widthThe name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
Stable:
ICU 54

◆ setZodiacNames()

void icu::DateFormatSymbols::setZodiacNames ( const UnicodeString zodiacNames,
int32_t  count,
DtContextType  context,
DtWidthType  width 
)

Sets calendar zodiac name strings by width and context.

For example: "Rat", "Ox", "Tiger", etc.

Parameters
zodiacNamesThe new zodiac name strings (not adopted; caller retains ownership).
countThe length of the array.
contextThe usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
widthThe name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
Stable:
ICU 54

◆ setZoneStrings()

void icu::DateFormatSymbols::setZoneStrings ( const UnicodeString *const *  strings,
int32_t  rowCount,
int32_t  columnCount 
)

Sets timezone strings.

These strings are stored in a 2-dimensional array.

Note: SimpleDateFormat no longer use the zone strings stored in a DateFormatSymbols. Therefore, the time zone strings set by this mthod have no effects in an instance of SimpleDateFormat for formatting time zones.

Parameters
stringsThe timezone strings as a 2-d array to be copied. (not adopted; caller retains ownership)
rowCountThe number of rows (count of first index).
columnCountThe number of columns (count of second index).
Stable:
ICU 2.0

Field Documentation

◆ ALTERNATE_TIME_SEPARATOR

const char16_t icu::DateFormatSymbols::ALTERNATE_TIME_SEPARATOR = 0x002e
static

This alternate time separator is always recognized when parsing.

Internal:
Do not use. This API is for internal use only.

Definition at line 436 of file dtfmtsym.h.

◆ DEFAULT_TIME_SEPARATOR

const char16_t icu::DateFormatSymbols::DEFAULT_TIME_SEPARATOR = 0x003a
static

This default time separator is used for formatting when the locale doesn't specify any time separator, and always recognized when parsing.

Internal:
Do not use. This API is for internal use only.

Definition at line 430 of file dtfmtsym.h.


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