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

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)
          Deprecated. This is a draft API and might change in a future release of ICU.
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)
          Deprecated. This is a draft API and might change in a future release of ICU.
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)
          Deprecated. This is a draft API and might change in a future release of ICU.
DateFormatSymbols(ULocale locale)
          Deprecated. This is a draft API and might change in a future release of ICU.
 
Method Summary
 Object clone()
          Overrides Cloneable
 boolean equals(Object obj)
          Override equals
 String[] getAmPmStrings()
          Gets ampm strings.
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)
          Deprecated. This is a draft API and might change in a future release of ICU.
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)
          Deprecated. This is a draft API and might change in a future release of ICU.
 String[] getEras()
          Gets era strings.
 ULocale getLocale(ULocale.Type type)
          Deprecated. This is a draft API and might change in a future release of ICU.
 String getLocalPatternChars()
          Gets localized date-time pattern characters.
 String[] getMonths()
          Gets month strings.
 String[] getShortMonths()
          Gets short month strings.
 String[] getShortWeekdays()
          Gets short weekday strings.
 String[] getWeekdays()
          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 is a draft API and might change in a future release of ICU.
protected  void initializeData(ULocale desiredLocale, String type)
          Deprecated. This is a draft API and might change in a future release of ICU.
 void setAmPmStrings(String[] newAmpms)
          Sets ampm 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 setShortMonths(String[] newShortMonths)
          Sets short month strings.
 void setShortWeekdays(String[] newShortWeekdays)
          Sets short weekday strings.
 void setWeekdays(String[] newWeekdays)
          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
 

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.

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.

DateFormatSymbols

public DateFormatSymbols(ULocale locale)
Deprecated. This is a draft API and might change in a future release of ICU.

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.

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)

DateFormatSymbols

public DateFormatSymbols(Calendar cal,
                         ULocale locale)
Deprecated. This is a draft API and might change in a future release of ICU.

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)

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)

DateFormatSymbols

public DateFormatSymbols(Class calendarClass,
                         ULocale locale)
Deprecated. This is a draft API and might change in a future release of ICU.

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

See Also:
DateFormatSymbols(Calendar, 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(java.util.ResourceBundle, com.ibm.icu.util.ULocale)

DateFormatSymbols

public DateFormatSymbols(ResourceBundle bundle,
                         ULocale locale)
Deprecated. This is a draft API and might change in a future release of ICU.

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)
Method Detail

getEras

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

Returns:
the era strings.

setEras

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

Parameters:
newEras - the new era strings.

getMonths

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

Returns:
the month strings.

setMonths

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

Parameters:
newMonths - the new month strings.

getShortMonths

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

Returns:
the short month strings.

setShortMonths

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

Parameters:
newShortMonths - the new short month strings.

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.

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.

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.

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.

getAmPmStrings

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

Returns:
the weekday strings.

setAmPmStrings

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

Parameters:
newAmpms - the new ampm strings.

getZoneStrings

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

Returns:
the timezone strings.

setZoneStrings

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

Parameters:
newZoneStrings - the new timezone strings.

getLocalPatternChars

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

Returns:
the localized date-time pattern characters.

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.

clone

public Object clone()
Overrides Cloneable

Overrides:
clone in class Object

hashCode

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

Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Override equals

Overrides:
equals in class Object

initializeData

protected void initializeData(ULocale desiredLocale,
                              String type)
Deprecated. This is a draft API and might change in a future release of ICU.

Parameters:
desiredLocale -
type -

initializeData

protected void initializeData(ULocale desiredLocale,
                              com.ibm.icu.impl.CalendarData calData)
Deprecated. This is a draft API and might change in a future release of ICU.

Parameters:
desiredLocale -
calData -

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

Throws:
MissingResourceException

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Class calendarClass,
                                                 ULocale locale)
                                          throws MissingResourceException
Deprecated. This is a draft API and might change in a future release of ICU.

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:
MissingResourceException

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.

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

getDateFormatBundle

public static ResourceBundle getDateFormatBundle(Calendar cal,
                                                 ULocale locale)
                                          throws MissingResourceException
Deprecated. This is a draft API and might change in a future release of ICU.

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

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

getLocale

public final ULocale getLocale(ULocale.Type type)
Deprecated. This is a draft API and might change in a future release of ICU.

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


Copyright (c) 2004 IBM Corporation and others.