|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.icu.text.DateFormatSymbols
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.
DateFormat
,
SimpleDateFormat
,
SimpleTimeZone
,
Serialized FormConstructor 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 |
public DateFormatSymbols()
MissingResourceException
- if the resources for the default locale cannot be
found or cannot be loaded.public DateFormatSymbols(Locale locale)
MissingResourceException
- if the resources for the specified locale cannot be
found or cannot be loaded.public DateFormatSymbols(ULocale locale)
MissingResourceException
- if the resources for the specified locale cannot be
found or cannot be loaded.public DateFormatSymbols(Calendar cal, Locale locale)
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:
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.
cal
- The calendar system whose date format symbols are desired.locale
- The locale whose symbols are desired.DateFormatSymbols(java.util.Locale)
public DateFormatSymbols(Calendar cal, ULocale locale)
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:
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.
cal
- The calendar system whose date format symbols are desired.locale
- The ulocale whose symbols are desired.DateFormatSymbols(java.util.Locale)
public DateFormatSymbols(Class calendarClass, Locale locale)
DateFormatSymbols(Calendar, Locale)
public DateFormatSymbols(Class calendarClass, ULocale locale)
DateFormatSymbols(Calendar, Locale)
public DateFormatSymbols(ResourceBundle bundle, Locale locale)
DateFormatSymbols(java.util.ResourceBundle, com.ibm.icu.util.ULocale)
public DateFormatSymbols(ResourceBundle bundle, ULocale locale)
DateFormatSymbols(java.util.ResourceBundle, com.ibm.icu.util.ULocale)
Method Detail |
public String[] getEras()
public void setEras(String[] newEras)
newEras
- the new era strings.public String[] getMonths()
public void setMonths(String[] newMonths)
newMonths
- the new month strings.public String[] getShortMonths()
public void setShortMonths(String[] newShortMonths)
newShortMonths
- the new short month strings.public String[] getWeekdays()
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.public void setWeekdays(String[] newWeekdays)
newWeekdays
- the new weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.public String[] getShortWeekdays()
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.public void setShortWeekdays(String[] newShortWeekdays)
newShortWeekdays
- the new short weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.public String[] getAmPmStrings()
public void setAmPmStrings(String[] newAmpms)
newAmpms
- the new ampm strings.public String[][] getZoneStrings()
public void setZoneStrings(String[][] newZoneStrings)
newZoneStrings
- the new timezone strings.public String getLocalPatternChars()
public void setLocalPatternChars(String newLocalPatternChars)
newLocalPatternChars
- the new localized date-time
pattern characters.public Object clone()
public int hashCode()
public boolean equals(Object obj)
protected void initializeData(ULocale desiredLocale, String type)
desiredLocale
- type
- protected void initializeData(ULocale desiredLocale, com.ibm.icu.impl.CalendarData calData)
desiredLocale
- calData
- public static ResourceBundle getDateFormatBundle(Class calendarClass, Locale locale) throws MissingResourceException
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".
MissingResourceException
public static ResourceBundle getDateFormatBundle(Class calendarClass, ULocale locale) throws MissingResourceException
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".
MissingResourceException
public static ResourceBundle getDateFormatBundle(Calendar cal, Locale locale) throws MissingResourceException
MissingResourceException
getDateFormatBundle(java.lang.Class, java.util.Locale)
public static ResourceBundle getDateFormatBundle(Calendar cal, ULocale locale) throws MissingResourceException
MissingResourceException
getDateFormatBundle(java.lang.Class, java.util.Locale)
public final ULocale getLocale(ULocale.Type type)
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.
type
- type of information requested, either ULocale.VALID_LOCALE
or ULocale.ACTUAL_LOCALE
.
ULocale
,
ULocale.VALID_LOCALE
,
ULocale.ACTUAL_LOCALE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |