com.ibm.icu.text
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.
See Also: DateFormat SimpleDateFormat SimpleTimeZone
UNKNOWN: 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(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 | |
---|---|
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. |
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[] | 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, 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, int context, int width)
Sets weekday strings. |
void | setWeekdays(String[] newWeekdays)
Sets weekday strings. |
void | setZoneStrings(String[][] newZoneStrings)
Sets timezone strings. |
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: revisit for ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
Throws: java.util.MissingResourceException if the resources for the default locale cannot be found or cannot be loaded.
UNKNOWN: ICU 2.0
Throws: java.util.MissingResourceException if the resources for the specified locale cannot be found or cannot be loaded.
UNKNOWN: ICU 2.0
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.
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:
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.
DateFormatSymbols
for the locale.
MONTH
field. If this key is not found
in the bundle, the month names are inherited from the
default DateFormatSymbols
for the requested locale.
DateFormatSymbols
for the locale.
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
UNKNOWN: ICU 2.0
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:
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.
DateFormatSymbols
for the locale.
MONTH
field. If this key is not found
in the bundle, the month names are inherited from the
default DateFormatSymbols
for the requested locale.
DateFormatSymbols
for the locale.
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
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
See Also: DateFormatSymbols
UNKNOWN: ICU 2.2
See Also: DateFormatSymbols
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
See Also: DateFormatSymbols
UNKNOWN: ICU 2.0
See Also: DateFormatSymbols
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
Returns: the weekday strings.
UNKNOWN: ICU 2.0
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
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.
See Also: DateFormatSymbols
UNKNOWN: ICU 2.2
See Also: DateFormatSymbols
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
Returns: the era strings.
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
Returns: the era strings.
UNKNOWN: ICU 2.0
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.
Returns: the localized date-time pattern characters.
UNKNOWN: ICU 2.0
Returns: the month strings.
UNKNOWN: ICU 2.0
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.
Returns: the short month strings.
UNKNOWN: ICU 2.0
Returns: the short weekday strings. Use Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.
UNKNOWN: ICU 2.0
Returns: the weekday strings. Use Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.
UNKNOWN: ICU 2.0
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.
Returns: the timezone strings.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
Parameters: desiredLocale type
UNKNOWN: ICU 3.0 This API might change or be removed in a future release.
Parameters: desiredLocale calData
UNKNOWN: ICU 3.0 This API might change or be removed in a future release.
Parameters: newAmpms the new ampm strings.
UNKNOWN: ICU 2.0
Parameters: newEraNames the new era strings.
UNKNOWN: revisit for ICU 3.6
Parameters: newEras the new era strings.
UNKNOWN: ICU 2.0
Parameters: newLocalPatternChars the new localized date-time pattern characters.
UNKNOWN: ICU 2.0
Parameters: newMonths the new month strings.
UNKNOWN: ICU 2.0
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.
Parameters: newShortMonths the new short month strings.
UNKNOWN: ICU 2.0
Parameters: newShortWeekdays the new short weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.
UNKNOWN: ICU 2.0
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.
Parameters: newWeekdays the new weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.
UNKNOWN: ICU 2.0
Parameters: newZoneStrings the new timezone strings.
UNKNOWN: ICU 2.0