com.ibm.icu.text
Class DateFormatSymbols

java.lang.Object
  extended by com.ibm.icu.text.DateFormatSymbols
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
ChineseDateFormatSymbols

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 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, Serialized Form
Status:
Stable ICU 2.0.

Field Summary
static int ABBREVIATED
          Constant for width.
static int DT_CONTEXT_COUNT
          Deprecated. This API is ICU internal only.
static int DT_WIDTH_COUNT
          Deprecated. This API is ICU internal only.
static int FORMAT
          Constant for context.
static int NARROW
          Constant for width.
static int STANDALONE
          Constant for context.
static int WIDE
          Constant for width.
 
Constructor Summary
DateFormatSymbols()
          Construct a DateFormatSymbols object by loading format data from resources for the default locale.
DateFormatSymbols(Calendar cal, Locale locale)
          Get the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.
DateFormatSymbols(Calendar cal, ULocale locale)
          Get the 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(Locale locale)
          Construct a DateFormatSymbols object by loading format data from resources for the given locale.
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.
DateFormatSymbols(ULocale locale)
          Construct a DateFormatSymbols object by loading format data from resources for the given ulocale.
 
Method Summary
 Object clone()
          Overrides Cloneable
 boolean equals(Object obj)
          Override equals
 String[] getAmPmStrings()
          Gets ampm strings.
static Locale[] getAvailableLocales()
          Returns an array of all locales for which the getInstance methods of this class can return localized instances.
static ULocale[] getAvailableULocales()
          Returns an array of all locales for which the getInstance methods of this class can return localized instances.
static ResourceBundle getDateFormatBundle(Calendar cal, Locale locale)
          Deprecated. ICU 4.0
static ResourceBundle getDateFormatBundle(Calendar cal, ULocale locale)
          Deprecated. ICU 4.0
static ResourceBundle getDateFormatBundle(Class calendarClass, Locale locale)
          Deprecated. ICU 4.0
static ResourceBundle getDateFormatBundle(Class calendarClass, ULocale locale)
          Deprecated. ICU 4.0
 String[] getEraNames()
          Gets era name strings.
 String[] getEras()
          Gets era strings.
static DateFormatSymbols getInstance()
          Gets a DateFormatSymbols instance for the default locale.
static DateFormatSymbols getInstance(Locale locale)
          Gets a DateFormatSymbols instance for the given locale.
static DateFormatSymbols getInstance(ULocale locale)
          Gets a DateFormatSymbols instance for the given locale.
 ULocale getLocale(ULocale.Type type)
          Return the locale that was used to create this object, or null.
 String getLocalPatternChars()
          Gets localized date-time pattern characters.
 String[] getMonths()
          Gets month strings.
 String[] getMonths(int context, int width)
          Gets month strings.
 String[] getQuarters(int context, int width)
          Gets quarter 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.
 int hashCode()
          Override hashCode.
protected  void initializeData(ULocale desiredLocale, com.ibm.icu.impl.CalendarData calData)
          Deprecated. This API is ICU internal only.
protected  void initializeData(ULocale desiredLocale, String type)
          Initialize format symbols for the locale and calendar type
 void setAmPmStrings(String[] newAmpms)
          Sets ampm strings.
 void setEraNames(String[] newEraNames)
          Sets era name strings.
 void setEras(String[] newEras)
          Sets era strings.
 void setLocalPatternChars(String newLocalPatternChars)
          Sets localized date-time pattern characters.
 void setMonths(String[] newMonths)
          Sets month strings.
 void setMonths(String[] newMonths, int context, int width)
          Sets month strings.
 void setQuarters(String[] newQuarters, int context, int width)
          Sets quarter strings.
 void setShortMonths(String[] newShortMonths)
          Sets short month strings.
 void setShortWeekdays(String[] newShortWeekdays)
          Sets short weekday strings.
 void setWeekdays(String[] newWeekdays)
          Sets weekday strings.
 void setWeekdays(String[] newWeekdays, int context, int width)
          Sets weekday strings.
 void setZoneStrings(String[][] newZoneStrings)
          Sets timezone strings.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FORMAT

public static final int FORMAT
Constant for context.

See Also:
Constant Field Values
Status:
Stable ICU 3.6.

STANDALONE

public static final int STANDALONE
Constant for context.

See Also:
Constant Field Values
Status:
Stable ICU 3.6.

DT_CONTEXT_COUNT

public static final int DT_CONTEXT_COUNT
Deprecated. This API is ICU internal only.
Constant for context.

See Also:
Constant Field Values
Status:
Internal. This API is ICU internal only.

ABBREVIATED

public static final int ABBREVIATED
Constant for width.

See Also:
Constant Field Values
Status:
Stable ICU 3.6.

WIDE

public static final int WIDE
Constant for width.

See Also:
Constant Field Values
Status:
Stable ICU 3.6.

NARROW

public static final int NARROW
Constant for width.

See Also:
Constant Field Values
Status:
Stable ICU 3.6.

DT_WIDTH_COUNT

public static final int DT_WIDTH_COUNT
Deprecated. This API is ICU internal only.
Constant for width.

See Also:
Constant Field Values
Status:
Internal. This API is ICU internal only.
Constructor Detail

DateFormatSymbols

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

Throws:
MissingResourceException - if the resources for the default locale cannot be found or cannot be loaded.
Status:
Stable ICU 2.0.

DateFormatSymbols

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

Throws:
MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.
Status:
Stable ICU 2.0.

DateFormatSymbols

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

Throws:
MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.
Status:
Stable ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(Calendar cal,
                         Locale locale)
Get the 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 ResourceBundle containing its 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(java.util.Locale)
Status:
Stable ICU 2.0.

DateFormatSymbols

public DateFormatSymbols(Calendar cal,
                         ULocale locale)
Get the 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 ResourceBundle containing its 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(java.util.Locale)
Status:
Stable ICU 3.2.

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(Calendar, Locale)
Status:
Stable 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(Calendar, Locale)
Status:
Stable ICU 3.2.

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(java.util.Locale)
Status:
Stable 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(java.util.Locale)
Status:
Stable ICU 3.2.
Method Detail

getInstance

public static DateFormatSymbols getInstance()
Gets a DateFormatSymbols instance for the default locale.

Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:
A DateFormatSymbols instance.
Status:
Stable ICU 3.8.

getInstance

public static DateFormatSymbols getInstance(Locale locale)
Gets a DateFormatSymbols instance for the given locale.

Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Parameters:
locale - the locale.
Returns:
A DateFormatSymbols instance.
Status:
Stable ICU 3.8.

getInstance

public static DateFormatSymbols getInstance(ULocale locale)
Gets a DateFormatSymbols instance for the given locale.

Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Parameters:
locale - the locale.
Returns:
A DateFormatSymbols instance.
Status:
Draft ICU 3.8.

getAvailableLocales

public static Locale[] getAvailableLocales()
Returns an array of all locales for which the getInstance methods of this class can return localized instances.

Note: Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of Locales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:
An array of Locales for which localized DateFormatSymbols instances are available.
Status:
Stable ICU 3.8.

getAvailableULocales

public static ULocale[] getAvailableULocales()
Returns an array of all locales for which the getInstance methods of this class can return localized instances.

Note: Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of ULocales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:
An array of ULocales for which localized DateFormatSymbols instances are available.
Status:
Draft ICU 3.8.

getEras

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

Returns:
the era strings.
Status:
Stable ICU 2.0.

setEras

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

Parameters:
newEras - the new era strings.
Status:
Stable ICU 2.0.

getEraNames

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

Returns:
the era strings.
Status:
Stable ICU 3.4.

setEraNames

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

Parameters:
newEraNames - the new era strings.
Status:
Stable ICU 3.8.

getMonths

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

Returns:
the month strings.
Status:
Stable 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.
Status:
Stable ICU 3.4.

setMonths

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

Parameters:
newMonths - the new month strings.
Status:
Stable 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.
Status:
Stable ICU 3.8.

getShortMonths

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

Returns:
the short month strings.
Status:
Stable ICU 2.0.

setShortMonths

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

Parameters:
newShortMonths - the new short month strings.
Status:
Stable 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.
Status:
Stable 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.
Status:
Stable ICU 3.4.

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.
Status:
Stable ICU 3.8.

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.
Status:
Stable 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.
Status:
Stable 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.
Status:
Stable ICU 2.0.

getQuarters

public String[] getQuarters(int context,
                            int width)
Gets quarter strings. For example: "1st Quarter", "2nd Quarter", etc.

Parameters:
context - The quarter context, FORMAT or STANDALONE.
width - The width or the returned quarter string, either WIDE or ABBREVIATED. There are no NARROW quarters.
Returns:
the quarter strings.
Status:
Stable ICU 3.6.

setQuarters

public void setQuarters(String[] newQuarters,
                        int context,
                        int width)
Sets quarter strings. For example: "1st Quarter", "2nd Quarter", etc.

Parameters:
newQuarters - the new quarter strings.
context - The formatting context, FORMAT or STANDALONE.
width - The width of the quarter string, either WIDE or ABBREVIATED. There are no NARROW quarters.
Status:
Stable ICU 3.8.

getAmPmStrings

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

Returns:
the weekday strings.
Status:
Stable ICU 2.0.

setAmPmStrings

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

Parameters:
newAmpms - the new ampm strings.
Status:
Stable ICU 2.0.

getZoneStrings

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

Returns:
the timezone strings.
Status:
Stable ICU 2.0.

setZoneStrings

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

Parameters:
newZoneStrings - the new timezone strings.
Status:
Stable ICU 2.0.

getLocalPatternChars

public String getLocalPatternChars()
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.

Returns:
the localized date-time pattern characters.
Status:
Stable 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.
Status:
Stable ICU 2.0.

clone

public Object clone()
Overrides Cloneable

Overrides:
clone in class Object
Status:
Stable ICU 2.0.

hashCode

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

Overrides:
hashCode in class Object
Status:
Stable ICU 2.0.

equals

public boolean equals(Object obj)
Override equals

Overrides:
equals in class Object
Status:
Stable ICU 2.0.

initializeData

protected void initializeData(ULocale desiredLocale,
                              String type)
Initialize format symbols for the locale and calendar type

Parameters:
desiredLocale - The locale whose symbols are desired.
type - The calendar type whose date format symbols are desired.
Status:
Stable ICU 3.0.

initializeData

protected void initializeData(ULocale desiredLocale,
                              com.ibm.icu.impl.CalendarData calData)
Deprecated. This API is ICU internal only.

Initialize format symbols for the locale and calendar type

Parameters:
desiredLocale - The locale whose symbols are desired.
calData - The calendar resource data
Status:
Internal. This API is ICU internal only.

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Class calendarClass,
                                                 Locale locale)
                                          throws MissingResourceException
Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:
MissingResourceException

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Class calendarClass,
                                                 ULocale locale)
                                          throws MissingResourceException
Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:
MissingResourceException

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Calendar cal,
                                                 Locale locale)
                                          throws MissingResourceException
Deprecated. ICU 4.0

Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:
MissingResourceException
See Also:
getDateFormatBundle(java.lang.Class, java.util.Locale)

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Calendar cal,
                                                 ULocale locale)
                                          throws MissingResourceException
Deprecated. ICU 4.0

Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:
MissingResourceException
See Also:
getDateFormatBundle(java.lang.Class, java.util.Locale)

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 ULocale.VALID_LOCALE or ULocale.ACTUAL_LOCALE.
Returns:
the information specified by type, or null if this object was not constructed from locale data.
See Also:
ULocale, ULocale.VALID_LOCALE, ULocale.ACTUAL_LOCALE
Status:
Draft ICU 2.8 (retain).


Copyright (c) 2009 IBM Corporation and others.