com.ibm.icu.text

Class DateFormatSymbols

Implemented Interfaces:
Cloneable, Serializable
Known Direct 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

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(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(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(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 ResourceBundle
getDateFormatBundle(Class calendarClass, Locale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
static ResourceBundle
getDateFormatBundle(Class calendarClass, ULocale locale)
Find the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.
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.
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.
String[]
getEraNames()
Gets era name strings.
String[]
getEras()
Gets era strings.
String
getLocalPatternChars()
Gets localized date-time pattern characters.
ULocale
getLocale(ULocale.Type type)
Return the locale that was used to create this object, or null.
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.
int
hashCode()
Override hashCode.
protected void
initializeData(ULocale desiredLocale, String type)
protected void
initializeData(ULocale desiredLocale, com.ibm.icu.impl.CalendarData calData)
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
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.

Field Details

ABBREVIATED

public static final int ABBREVIATED
Constant for width.
Field Value:
0

DT_CONTEXT_COUNT

public static final int DT_CONTEXT_COUNT
Constant for context.
Field Value:
2

DT_WIDTH_COUNT

public static final int DT_WIDTH_COUNT
Constant for width.
Field Value:
3

FORMAT

public static final int FORMAT
Constant for context.
Field Value:
0

NARROW

public static final int NARROW
Constant for width.
Field Value:
2

STANDALONE

public static final int STANDALONE
Constant for context.
Field Value:
1

WIDE

public static final int WIDE
Constant for width.
Field Value:
1

Constructor Details

DateFormatSymbols

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

DateFormatSymbols

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

DateFormatSymbols

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

DateFormatSymbols

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

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

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

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:

  • DayNames - An array of strings corresponding to each possible value of the DAY_OF_WEEK field. Even though DAY_OF_WEEK starts with SUNDAY = 1, This array is 0-based; the name for Sunday goes in the first position, at index 0. If this key is not found in the bundle, the day names are inherited from the default DateFormatSymbols for the requested locale.
  • DayAbbreviations - An array of abbreviated day names corresponding to the values in the "DayNames" array. If this key is not found in the resource bundle, the "DayNames" values are used instead. If neither key is found, the day abbreviations are inherited from the default DateFormatSymbols for the locale.
  • MonthNames - An array of strings corresponding to each possible value of the MONTH field. If this key is not found in the bundle, the month names are inherited from the default DateFormatSymbols for the requested locale.
  • MonthAbbreviations - An array of abbreviated day names corresponding to the values in the "MonthNames" array. If this key is not found in the resource bundle, the "MonthNames" values are used instead. If neither key is found, the day abbreviations are inherited from the default DateFormatSymbols for the locale.
  • Eras - An array of strings corresponding to each possible value of the ERA field. If this key is not found in the bundle, the era names are inherited from the default DateFormatSymbols for the requested locale.

Parameters:
cal - The calendar system whose date format symbols are desired.
locale - The locale whose symbols are desired.
See Also:
DateFormatSymbols.DateFormatSymbols(java.util.Locale)

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:

  • DayNames - An array of strings corresponding to each possible value of the DAY_OF_WEEK field. Even though DAY_OF_WEEK starts with SUNDAY = 1, This array is 0-based; the name for Sunday goes in the first position, at index 0. If this key is not found in the bundle, the day names are inherited from the default DateFormatSymbols for the requested locale.
  • DayAbbreviations - An array of abbreviated day names corresponding to the values in the "DayNames" array. If this key is not found in the resource bundle, the "DayNames" values are used instead. If neither key is found, the day abbreviations are inherited from the default DateFormatSymbols for the locale.
  • MonthNames - An array of strings corresponding to each possible value of the MONTH field. If this key is not found in the bundle, the month names are inherited from the default DateFormatSymbols for the requested locale.
  • MonthAbbreviations - An array of abbreviated day names corresponding to the values in the "MonthNames" array. If this key is not found in the resource bundle, the "MonthNames" values are used instead. If neither key is found, the day abbreviations are inherited from the default DateFormatSymbols for the locale.
  • Eras - An array of strings corresponding to each possible value of the ERA field. If this key is not found in the bundle, the era names are inherited from the default DateFormatSymbols for the requested locale.

Parameters:
cal - The calendar system whose date format symbols are desired.
locale - The ulocale whose symbols are desired.
See Also:
DateFormatSymbols.DateFormatSymbols(java.util.Locale)

DateFormatSymbols

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

Method Details

clone

public Object clone()
Overrides Cloneable

equals

public boolean equals(Object obj)
Override equals

getAmPmStrings

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

getDateFormatBundle

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


getDateFormatBundle

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


getDateFormatBundle

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

getDateFormatBundle

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

getEraNames

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

getEras

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

getLocalPatternChars

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

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.

getMonths

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

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.

getShortMonths

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

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.

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.

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.

getZoneStrings

public String[][] getZoneStrings()
Gets timezone strings.
Returns:
the timezone strings.

hashCode

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

initializeData

protected void initializeData(ULocale desiredLocale,
                              String type)
Parameters:
desiredLocale -
type -

initializeData

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

setAmPmStrings

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

setEraNames

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

setEras

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

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.

setMonths

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

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.

setShortMonths

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

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.

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.

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.

setZoneStrings

public void setZoneStrings(String[][] newZoneStrings)
Sets timezone strings.
Parameters:
newZoneStrings - the new timezone strings.

Copyright (c) 2006 IBM Corporation and others.