com.ibm.icu.text

Class DateFormatSymbols

public class DateFormatSymbols extends Object implements Serializable, Cloneable

DateFormatSymbols is a public class for encapsulating localizable date-time formatting data, such as the names of the months, the names of the days of the week, and the time zone data. DateFormat and SimpleDateFormat both use DateFormatSymbols to encapsulate this information.

Typically you shouldn't use DateFormatSymbols directly. Rather, you are encouraged to create a date-time formatter with the DateFormat class's factory methods: getTimeInstance, getDateInstance, or getDateTimeInstance. These methods automatically create a DateFormatSymbols for the formatter so that you don't have to. After the formatter is created, you may modify its format pattern using the setPattern method. For more information about creating formatters using DateFormat's factory methods, see {@link DateFormat}.

If you decide to create a date-time formatter with a specific format pattern for a specific locale, you can do so with:

 new SimpleDateFormat(aPattern, new DateFormatSymbols(aLocale)).
 

DateFormatSymbols objects are clonable. When you obtain a DateFormatSymbols object, feel free to modify the date-time formatting data. For instance, you can replace the localized date-time format pattern characters with the ones that you feel easy to remember. Or you can change the representative cities to your favorite ones.

New DateFormatSymbols subclasses may be added to support SimpleDateFormat for date-time formatting for additional locales.

Author: Chen-Lieh Huang

See Also: DateFormat SimpleDateFormat SimpleTimeZone

UNKNOWN: ICU 2.0

Field Summary
static intABBREVIATED
Constant for width.
static intDT_CONTEXT_COUNT
Constant for context.
static intDT_WIDTH_COUNT
Constant for width.
static intFORMAT
Constant for context.
static intNARROW
Constant for width.
static intSTANDALONE
Constant for context.
static intWIDE
Constant for width.
Constructor Summary
DateFormatSymbols()
Construct a DateFormatSymbols object by loading format data from resources for the default locale.
DateFormatSymbols(Locale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given locale.
DateFormatSymbols(ULocale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given ulocale.
DateFormatSymbols(Calendar cal, Locale locale)
Get the {@link DateFormatSymbols} object that should be used to format a calendar system's dates in the given locale.
DateFormatSymbols(Calendar cal, ULocale locale)
Get the {@link DateFormatSymbols} object that should be used to format a calendar system's dates in the given locale.
DateFormatSymbols(Class calendarClass, Locale locale)
Variant of DateFormatSymbols(Calendar, Locale) that takes the Calendar class instead of a Calandar instance.
DateFormatSymbols(Class calendarClass, ULocale locale)
Variant of DateFormatSymbols(Calendar, ULocale) that takes the Calendar class instead of a Calandar instance.
DateFormatSymbols(ResourceBundle bundle, Locale locale)
Fetch a custom calendar's DateFormatSymbols out of the given resource bundle.
DateFormatSymbols(ResourceBundle bundle, ULocale locale)
Fetch a custom calendar's DateFormatSymbols out of the given resource bundle.
Method Summary
Objectclone()
Overrides Cloneable
booleanequals(Object obj)
Override equals
String[]getAmPmStrings()
Gets ampm strings.
static ResourceBundlegetDateFormatBundle(Class calendarClass, Locale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
static ResourceBundlegetDateFormatBundle(Class calendarClass, ULocale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
static ResourceBundlegetDateFormatBundle(Calendar cal, Locale locale)
Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.
static ResourceBundlegetDateFormatBundle(Calendar cal, ULocale locale)
Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.
String[]getEraNames()
Gets era name strings.
String[]getEras()
Gets era strings.
ULocalegetLocale(ULocale.Type type)
Return the locale that was used to create this object, or null.
StringgetLocalPatternChars()
Gets localized date-time pattern characters.
String[]getMonths()
Gets month strings.
String[]getMonths(int context, int width)
Gets month strings.
String[]getShortMonths()
Gets short month strings.
String[]getShortWeekdays()
Gets short weekday strings.
String[]getWeekdays()
Gets weekday strings.
String[]getWeekdays(int context, int width)
Gets weekday strings.
String[][]getZoneStrings()
Gets timezone strings.
inthashCode()
Override hashCode.
protected voidinitializeData(ULocale desiredLocale, String type)
protected voidinitializeData(ULocale desiredLocale, CalendarData calData)
voidsetAmPmStrings(String[] newAmpms)
Sets ampm strings.
voidsetEraNames(String[] newEraNames)
Sets era name strings.
voidsetEras(String[] newEras)
Sets era strings.
voidsetLocalPatternChars(String newLocalPatternChars)
Sets localized date-time pattern characters.
voidsetMonths(String[] newMonths)
Sets month strings.
voidsetMonths(String[] newMonths, int context, int width)
Sets month strings.
voidsetShortMonths(String[] newShortMonths)
Sets short month strings.
voidsetShortWeekdays(String[] newShortWeekdays)
Sets short weekday strings.
voidsetWeekdays(String[] newWeekdays, int context, int width)
Sets weekday strings.
voidsetWeekdays(String[] newWeekdays)
Sets weekday strings.
voidsetZoneStrings(String[][] newZoneStrings)
Sets timezone strings.

Field Detail

ABBREVIATED

public static final int ABBREVIATED
Constant for width.

UNKNOWN: ICU 3.6 This API might change or be removed in a future release.

DT_CONTEXT_COUNT

public static final int DT_CONTEXT_COUNT
Constant for context.

UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.

DT_WIDTH_COUNT

public static final int DT_WIDTH_COUNT
Constant for width.

UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.

FORMAT

public static final int FORMAT
Constant for context.

UNKNOWN: ICU 3.6 This API might change or be removed in a future release.

NARROW

public static final int NARROW
Constant for width.

UNKNOWN: ICU 3.6 This API might change or be removed in a future release.

STANDALONE

public static final int STANDALONE
Constant for context.

UNKNOWN: ICU 3.6 This API might change or be removed in a future release.

WIDE

public static final int WIDE
Constant for width.

UNKNOWN: ICU 3.6 This API might change or be removed in a future release.

Constructor Detail

DateFormatSymbols

public DateFormatSymbols()
Construct a DateFormatSymbols object by loading format data from resources for the default locale.

Throws: java.util.MissingResourceException if the resources for the default locale cannot be found or cannot be loaded.

UNKNOWN: ICU 2.0

DateFormatSymbols

public DateFormatSymbols(Locale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given locale.

Throws: java.util.MissingResourceException if the resources for the specified locale cannot be found or cannot be loaded.

UNKNOWN: ICU 2.0

DateFormatSymbols

public DateFormatSymbols(ULocale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given ulocale.

Throws: java.util.MissingResourceException if the resources for the specified locale cannot be found or cannot be loaded.

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

DateFormatSymbols

public DateFormatSymbols(Calendar cal, Locale locale)
Get the {@link DateFormatSymbols} object that should be used to format a calendar system's dates in the given locale.

Subclassing:
When creating a new Calendar subclass, you must create the {@link ResourceBundle ResourceBundle} containing its {@link DateFormatSymbols DateFormatSymbols} in a specific place. The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

Within the ResourceBundle, this method searches for five keys:

Parameters: cal The calendar system whose date format symbols are desired. locale The locale whose symbols are desired.

See Also: DateFormatSymbols

UNKNOWN: ICU 2.0

DateFormatSymbols

public DateFormatSymbols(Calendar cal, ULocale locale)
Get the {@link DateFormatSymbols} object that should be used to format a calendar system's dates in the given locale.

Subclassing:
When creating a new Calendar subclass, you must create the {@link ResourceBundle ResourceBundle} containing its {@link DateFormatSymbols DateFormatSymbols} in a specific place. The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

Within the ResourceBundle, this method searches for five keys:

Parameters: cal The calendar system whose date format symbols are desired. locale The ulocale whose symbols are desired.

See Also: DateFormatSymbols

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

DateFormatSymbols

public DateFormatSymbols(Class calendarClass, Locale locale)
Variant of DateFormatSymbols(Calendar, Locale) that takes the Calendar class instead of a Calandar instance.

See Also: DateFormatSymbols

UNKNOWN: ICU 2.2

DateFormatSymbols

public DateFormatSymbols(Class calendarClass, ULocale locale)
Variant of DateFormatSymbols(Calendar, ULocale) that takes the Calendar class instead of a Calandar instance.

See Also: DateFormatSymbols

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

DateFormatSymbols

public DateFormatSymbols(ResourceBundle bundle, Locale locale)
Fetch a custom calendar's DateFormatSymbols out of the given resource bundle. Symbols that are not overridden are inherited from the default DateFormatSymbols for the locale.

See Also: DateFormatSymbols

UNKNOWN: ICU 2.0

DateFormatSymbols

public DateFormatSymbols(ResourceBundle bundle, ULocale locale)
Fetch a custom calendar's DateFormatSymbols out of the given resource bundle. Symbols that are not overridden are inherited from the default DateFormatSymbols for the locale.

See Also: DateFormatSymbols

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

Method Detail

clone

public Object clone()
Overrides Cloneable

UNKNOWN: ICU 2.0

equals

public boolean equals(Object obj)
Override equals

UNKNOWN: ICU 2.0

getAmPmStrings

public String[] getAmPmStrings()
Gets ampm strings. For example: "AM" and "PM".

Returns: the weekday strings.

UNKNOWN: ICU 2.0

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Class calendarClass, Locale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.

The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

UNKNOWN: ICU 2.0

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Class calendarClass, ULocale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.

The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Calendar cal, Locale locale)
Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

See Also: DateFormatSymbols

UNKNOWN: ICU 2.2

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Calendar cal, ULocale locale)
Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

See Also: DateFormatSymbols

UNKNOWN: ICU 3.2 This API might change or be removed in a future release.

getEraNames

public String[] getEraNames()
Gets era name strings. For example: "Anno Domini" and "Before Christ".

Returns: the era strings.

UNKNOWN: ICU 3.4 This API might change or be removed in a future release.

getEras

public String[] getEras()
Gets era strings. For example: "AD" and "BC".

Returns: the era strings.

UNKNOWN: ICU 2.0

getLocale

public final ULocale getLocale(ULocale.Type type)
Return the locale that was used to create this object, or null. This may may differ from the locale requested at the time of this object's creation. For example, if an object is created for locale en_US_CALIFORNIA, the actual data may be drawn from en (the actual locale), and en_US may be the most specific locale that exists (the valid locale).

Note: This method will be implemented in ICU 3.0; ICU 2.8 contains a partial preview implementation. The * actual locale is returned correctly, but the valid locale is not, in most cases.

Parameters: type type of information requested, either {@link com.ibm.icu.util.ULocale#VALID_LOCALE} or {@link com.ibm.icu.util.ULocale#ACTUAL_LOCALE}.

Returns: the information specified by type, or null if this object was not constructed from locale data.

See Also: ULocale VALID_LOCALE ACTUAL_LOCALE

UNKNOWN: ICU 2.8 (retain) This API might change or be removed in a future release.

getLocalPatternChars

public String getLocalPatternChars()
Gets localized date-time pattern characters. For example: 'u', 't', etc.

Returns: the localized date-time pattern characters.

UNKNOWN: ICU 2.0

getMonths

public String[] getMonths()
Gets month strings. For example: "January", "February", etc.

Returns: the month strings.

UNKNOWN: ICU 2.0

getMonths

public String[] getMonths(int context, int width)
Gets month strings. For example: "January", "February", etc.

Parameters: context The month context, FORMAT or STANDALONE. width The width or the returned month string, either WIDE, ABBREVIATED, or NARROW.

Returns: the month strings.

UNKNOWN: ICU 3.4 This API might change or be removed in a future release.

getShortMonths

public String[] getShortMonths()
Gets short month strings. For example: "Jan", "Feb", etc.

Returns: the short month strings.

UNKNOWN: ICU 2.0

getShortWeekdays

public String[] getShortWeekdays()
Gets short weekday strings. For example: "Sun", "Mon", etc.

Returns: the short weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

UNKNOWN: ICU 2.0

getWeekdays

public String[] getWeekdays()
Gets weekday strings. For example: "Sunday", "Monday", etc.

Returns: the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

UNKNOWN: ICU 2.0

getWeekdays

public String[] getWeekdays(int context, int width)
Gets weekday strings. For example: "Sunday", "Monday", etc.

Parameters: context Formatting context, either FORMAT or STANDALONE. width Width of strings to be returned, either WIDE, ABBREVIATED, or NARROW

Returns: the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

UNKNOWN: ICU 3.4 This API might change or be removed in a future release.

getZoneStrings

public String[][] getZoneStrings()
Gets timezone strings.

Returns: the timezone strings.

UNKNOWN: ICU 2.0

hashCode

public int hashCode()
Override hashCode. Generates a hash code for the DateFormatSymbols object.

UNKNOWN: ICU 2.0

initializeData

protected void initializeData(ULocale desiredLocale, String type)

Parameters: desiredLocale type

UNKNOWN: ICU 3.0 This API might change or be removed in a future release.

initializeData

protected void initializeData(ULocale desiredLocale, CalendarData calData)

Parameters: desiredLocale calData

UNKNOWN: ICU 3.0 This API might change or be removed in a future release.

setAmPmStrings

public void setAmPmStrings(String[] newAmpms)
Sets ampm strings. For example: "AM" and "PM".

Parameters: newAmpms the new ampm strings.

UNKNOWN: ICU 2.0

setEraNames

public void setEraNames(String[] newEraNames)
Sets era name strings. For example: "Anno Domini" and "Before Christ".

Parameters: newEraNames the new era strings.

UNKNOWN: revisit for ICU 3.6

setEras

public void setEras(String[] newEras)
Sets era strings. For example: "AD" and "BC".

Parameters: newEras the new era strings.

UNKNOWN: ICU 2.0

setLocalPatternChars

public void setLocalPatternChars(String newLocalPatternChars)
Sets localized date-time pattern characters. For example: 'u', 't', etc.

Parameters: newLocalPatternChars the new localized date-time pattern characters.

UNKNOWN: ICU 2.0

setMonths

public void setMonths(String[] newMonths)
Sets month strings. For example: "January", "February", etc.

Parameters: newMonths the new month strings.

UNKNOWN: ICU 2.0

setMonths

public void setMonths(String[] newMonths, int context, int width)
Sets month strings. For example: "January", "February", etc.

Parameters: newMonths the new month strings. context The formatting context, FORMAT or STANDALONE. width The width of the month string, either WIDE, ABBREVIATED, or NARROW.

UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.

setShortMonths

public void setShortMonths(String[] newShortMonths)
Sets short month strings. For example: "Jan", "Feb", etc.

Parameters: newShortMonths the new short month strings.

UNKNOWN: ICU 2.0

setShortWeekdays

public void setShortWeekdays(String[] newShortWeekdays)
Sets short weekday strings. For example: "Sun", "Mon", etc.

Parameters: newShortWeekdays the new short weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.

UNKNOWN: ICU 2.0

setWeekdays

public void setWeekdays(String[] newWeekdays, int context, int width)
Sets weekday strings. For example: "Sunday", "Monday", etc.

Parameters: newWeekdays The new weekday strings. context The formatting context, FORMAT or STANDALONE. width The width of the strings, either WIDE, ABBREVIATED, or NARROW.

UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.

setWeekdays

public void setWeekdays(String[] newWeekdays)
Sets weekday strings. For example: "Sunday", "Monday", etc.

Parameters: newWeekdays the new weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.

UNKNOWN: ICU 2.0

setZoneStrings

public void setZoneStrings(String[][] newZoneStrings)
Sets timezone strings.

Parameters: newZoneStrings the new timezone strings.

UNKNOWN: ICU 2.0