com.ibm.icu.text
Class DateFormatSymbols

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

public class DateFormatSymbols
extends java.lang.Object
implements java.io.Serializable, java.lang.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
          Constant for context.
static int DT_WIDTH_COUNT
          Constant for width.
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, java.util.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(java.lang.Class calendarClass, java.util.Locale locale)
          Variant of DateFormatSymbols(Calendar, Locale) that takes the Calendar class instead of a Calandar instance.
DateFormatSymbols(java.lang.Class calendarClass, ULocale locale)
          Variant of DateFormatSymbols(Calendar, ULocale) that takes the Calendar class instead of a Calandar instance.
DateFormatSymbols(java.util.Locale locale)
          Construct a DateFormatSymbols object by loading format data from resources for the given locale.
DateFormatSymbols(java.util.ResourceBundle bundle, java.util.Locale locale)
          Fetch a custom calendar's DateFormatSymbols out of the given resource bundle.
DateFormatSymbols(java.util.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
 java.lang.Object clone()
          Overrides Cloneable
 boolean equals(java.lang.Object obj)
          Override equals
 java.lang.String[] getAmPmStrings()
          Gets ampm strings.
static java.util.ResourceBundle getDateFormatBundle(Calendar cal, java.util.Locale locale)
          Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.
static java.util.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.
static java.util.ResourceBundle getDateFormatBundle(java.lang.Class calendarClass, java.util.Locale locale)
          Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
static java.util.ResourceBundle getDateFormatBundle(java.lang.Class calendarClass, ULocale locale)
          Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
 java.lang.String[] getEraNames()
          Gets era name strings.
 java.lang.String[] getEras()
          Gets era strings.
 ULocale getLocale(ULocale.Type type)
          Return the locale that was used to create this object, or null.
 java.lang.String getLocalPatternChars()
          Gets localized date-time pattern characters.
 java.lang.String[] getMonths()
          Gets month strings.
 java.lang.String[] getMonths(int context, int width)
          Gets month strings.
 java.lang.String[] getShortMonths()
          Gets short month strings.
 java.lang.String[] getShortWeekdays()
          Gets short weekday strings.
 java.lang.String[] getWeekdays()
          Gets weekday strings.
 java.lang.String[] getWeekdays(int context, int width)
          Gets weekday strings.
 java.lang.String[][] getZoneStrings()
          Gets timezone strings.
 int hashCode()
          Override hashCode.
protected  void initializeData(ULocale desiredLocale, com.ibm.icu.impl.CalendarData calData)
           
protected  void initializeData(ULocale desiredLocale, java.lang.String type)
           
 void setAmPmStrings(java.lang.String[] newAmpms)
          Sets ampm strings.
 void setEraNames(java.lang.String[] newEraNames)
          Sets era name strings.
 void setEras(java.lang.String[] newEras)
          Sets era strings.
 void setLocalPatternChars(java.lang.String newLocalPatternChars)
          Sets localized date-time pattern characters.
 void setMonths(java.lang.String[] newMonths)
          Sets month strings.
 void setMonths(java.lang.String[] newMonths, int context, int width)
          Sets month strings.
 void setShortMonths(java.lang.String[] newShortMonths)
          Sets short month strings.
 void setShortWeekdays(java.lang.String[] newShortWeekdays)
          Sets short weekday strings.
 void setWeekdays(java.lang.String[] newWeekdays)
          Sets weekday strings.
 void setWeekdays(java.lang.String[] newWeekdays, int context, int width)
          Sets weekday strings.
 void setZoneStrings(java.lang.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:
Draft ICU 3.6.

STANDALONE

public static final int STANDALONE
Constant for context.

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

DT_CONTEXT_COUNT

public static final int DT_CONTEXT_COUNT
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:
Draft ICU 3.6.

WIDE

public static final int WIDE
Constant for width.

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

NARROW

public static final int NARROW
Constant for width.

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

DT_WIDTH_COUNT

public static final int DT_WIDTH_COUNT
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:
java.util.MissingResourceException - if the resources for the default locale cannot be found or cannot be loaded.
Status:
Stable ICU 2.0.

DateFormatSymbols

public DateFormatSymbols(java.util.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.
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:
java.util.MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.
Status:
Draft ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(Calendar cal,
                         java.util.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:
Draft ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(java.lang.Class calendarClass,
                         java.util.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(java.lang.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:
Draft ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(java.util.ResourceBundle bundle,
                         java.util.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.ResourceBundle, com.ibm.icu.util.ULocale)
Status:
Stable ICU 2.0.

DateFormatSymbols

public DateFormatSymbols(java.util.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.ResourceBundle, com.ibm.icu.util.ULocale)
Status:
Draft ICU 3.2.
Method Detail

getEras

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

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

setEras

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

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

getEraNames

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

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

setEraNames

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

Parameters:
newEraNames - the new era strings.
Status:
Internal. This API is ICU internal only.

getMonths

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

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

getMonths

public java.lang.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:
Draft ICU 3.4.

setMonths

public void setMonths(java.lang.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(java.lang.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:
Internal. This API is ICU internal only.

getShortMonths

public java.lang.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(java.lang.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 java.lang.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 java.lang.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:
Draft ICU 3.4.

setWeekdays

public void setWeekdays(java.lang.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:
Internal. This API is ICU internal only.

setWeekdays

public void setWeekdays(java.lang.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 java.lang.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(java.lang.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.

getAmPmStrings

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

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

setAmPmStrings

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

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

getZoneStrings

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

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

setZoneStrings

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

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

getLocalPatternChars

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

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

setLocalPatternChars

public void setLocalPatternChars(java.lang.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 java.lang.Object clone()
Overrides Cloneable

Status:
Stable ICU 2.0.

hashCode

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

Status:
Stable ICU 2.0.

equals

public boolean equals(java.lang.Object obj)
Override equals

Status:
Stable ICU 2.0.

initializeData

protected void initializeData(ULocale desiredLocale,
                              java.lang.String type)
Parameters:
desiredLocale -
type -
Status:
Draft ICU 3.0.

initializeData

protected void initializeData(ULocale desiredLocale,
                              com.ibm.icu.impl.CalendarData calData)
Parameters:
desiredLocale -
calData -
Status:
Draft ICU 3.0.

getDateFormatBundle

public static java.util.ResourceBundle getDateFormatBundle(java.lang.Class calendarClass,
                                                           java.util.Locale locale)
                                                    throws java.util.MissingResourceException
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".

Throws:
java.util.MissingResourceException
Status:
Stable ICU 2.0.

getDateFormatBundle

public static java.util.ResourceBundle getDateFormatBundle(java.lang.Class calendarClass,
                                                           ULocale locale)
                                                    throws java.util.MissingResourceException
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".

Throws:
java.util.MissingResourceException
Status:
Draft ICU 3.2.

getDateFormatBundle

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

Throws:
java.util.MissingResourceException
See Also:
getDateFormatBundle(java.lang.Class, java.util.Locale)
Status:
Stable ICU 2.2.

getDateFormatBundle

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

Throws:
java.util.MissingResourceException
See Also:
getDateFormatBundle(java.lang.Class, java.util.Locale)
Status:
Draft ICU 3.2.

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) 2006 IBM Corporation and others.