com.ibm.icu.text

Class DateFormatSymbols

java.lang.Object

com.ibm.icu.text.DateFormatSymbols

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ChineseDateFormatSymbols

public class DateFormatSymbols
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

[icu enhancement] ICU's replacement for java.text.DateFormatSymbols. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.

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

Fields

Modifier and Type	Field and Description
static int	ABBREVIATED [icu] Constant for width.
static int	DT_CONTEXT_COUNT Deprecated. This API is ICU internal only.
static int	DT_WIDTH_COUNT Deprecated. This API is ICU internal only.
static int	FORMAT [icu] Constant for context.
static int	NARROW [icu] Constant for width.
static int	NUMERIC Deprecated. This API is ICU internal only.
static int	SHORT [icu] Constant for width; only supported for weekdays.
static int	STANDALONE [icu] Constant for context.
static int	WIDE [icu] Constant for width.

Constructor Summary

Constructors

Constructor and Description
DateFormatSymbols() Constructs a DateFormatSymbols object by loading format data from resources for the default FORMAT locale.
DateFormatSymbols(Calendar cal, java.util.Locale locale) Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.
DateFormatSymbols(Calendar cal, ULocale locale) Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.
DateFormatSymbols(java.lang.Class<? extends Calendar> calendarClass, java.util.Locale locale) Variant of DateFormatSymbols(Calendar, Locale) that takes the Calendar class instead of a Calendar instance.
DateFormatSymbols(java.lang.Class<? extends Calendar> calendarClass, ULocale locale) Variant of DateFormatSymbols(Calendar, ULocale) that takes the Calendar class instead of a Calendar instance.
DateFormatSymbols(java.util.Locale locale) Constructs a DateFormatSymbols object by loading format data from resources for the given locale.
DateFormatSymbols(java.util.ResourceBundle bundle, java.util.Locale locale) Fetches a custom calendar's DateFormatSymbols out of the given resource bundle.
DateFormatSymbols(java.util.ResourceBundle bundle, ULocale locale) Fetches a custom calendar's DateFormatSymbols out of the given resource bundle.
DateFormatSymbols(ULocale locale) [icu] Constructs a DateFormatSymbols object by loading format data from resources for the given ulocale.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Overrides clone.
boolean	equals(java.lang.Object obj) Overrides equals.
java.lang.String[]	getAmPmStrings() Returns am/pm strings.
static java.util.Locale[]	getAvailableLocales() Returns an array of all locales for which the getInstance methods of this class can return localized instances.
static ULocale[]	getAvailableULocales() [icu] Returns an array of all locales for which the getInstance methods of this class can return localized instances.
static java.util.ResourceBundle	getDateFormatBundle(Calendar cal, java.util.Locale locale) Deprecated. ICU 4.0
static java.util.ResourceBundle	getDateFormatBundle(Calendar cal, ULocale locale) Deprecated. ICU 4.0
static java.util.ResourceBundle	getDateFormatBundle(java.lang.Class<? extends Calendar> calendarClass, java.util.Locale locale) Deprecated. ICU 4.0
static java.util.ResourceBundle	getDateFormatBundle(java.lang.Class<? extends Calendar> calendarClass, ULocale locale) Deprecated. ICU 4.0
java.lang.String[]	getEraNames() [icu] Returns era name strings.
java.lang.String[]	getEras() Returns era strings.
static DateFormatSymbols	getInstance() Returns a DateFormatSymbols instance for the default locale.
static DateFormatSymbols	getInstance(java.util.Locale locale) Returns a DateFormatSymbols instance for the given locale.
static DateFormatSymbols	getInstance(ULocale locale) [icu] Returns a DateFormatSymbols instance for the given locale.
java.lang.String	getLeapMonthPattern(int context, int width) Deprecated. This API is ICU internal only.
ULocale	getLocale(ULocale.Type type) Returns the locale that was used to create this object, or null.
java.lang.String	getLocalPatternChars() Returns localized date-time pattern characters.
java.lang.String[]	getMonths() Returns month strings.
java.lang.String[]	getMonths(int context, int width) Returns month strings.
java.lang.String[]	getQuarters(int context, int width) [icu] Returns quarter strings.
java.lang.String[]	getShortMonths() Returns short month strings.
java.lang.String[]	getShortWeekdays() Returns abbreviated weekday strings; for example: "Sun", "Mon", etc.
java.lang.String	getTimeSeparatorString() Deprecated. This API is ICU internal only.
java.lang.String[]	getWeekdays() Returns wide weekday strings.
java.lang.String[]	getWeekdays(int context, int width) Returns weekday strings.
java.lang.String[]	getYearNames(int context, int width) Returns cyclic year name strings if the calendar has them, for example: "jia-zi", "yi-chou", etc.
java.lang.String[]	getZodiacNames(int context, int width) Returns calendar zodiac name strings if the calendar has them, for example: "Rat", "Ox", "Tiger", etc.
java.lang.String[][]	getZoneStrings() Returns time zone strings.
int	hashCode() Override hashCode.
protected void	initializeData(ULocale desiredLocale, com.ibm.icu.impl.ICUResourceBundle b, java.lang.String calendarType) Deprecated. This API is ICU internal only.
protected void	initializeData(ULocale desiredLocale, java.lang.String type) Initializes format symbols for the locale and calendar type
void	setAmPmStrings(java.lang.String[] newAmpms) Sets am/pm strings.
void	setEraNames(java.lang.String[] newEraNames) [icu] Sets era name strings.
void	setEras(java.lang.String[] newEras) Sets era strings.
void	setLeapMonthPattern(java.lang.String leapMonthPattern, int context, int width) Deprecated. This API is ICU internal only.
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	setQuarters(java.lang.String[] newQuarters, int context, int width) [icu] Sets quarter strings.
void	setShortMonths(java.lang.String[] newShortMonths) Sets short month strings.
void	setShortWeekdays(java.lang.String[] newAbbrevWeekdays) Sets abbreviated weekday strings; for example: "Sun", "Mon", etc.
void	setTimeSeparatorString(java.lang.String newTimeSeparator) Deprecated. This API is ICU internal only.
void	setWeekdays(java.lang.String[] newWeekdays) Sets wide weekday strings.
void	setWeekdays(java.lang.String[] newWeekdays, int context, int width) Sets weekday strings.
void	setYearNames(java.lang.String[] yearNames, int context, int width) Sets cyclic year name strings, for example: "jia-zi", "yi-chou", etc.
void	setZodiacNames(java.lang.String[] zodiacNames, int context, int width) Sets calendar zodiac name strings, for example: "Rat", "Ox", "Tiger", etc.
void	setZoneStrings(java.lang.String[][] newZoneStrings) Sets time zone strings.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT

public static final int FORMAT

[icu] Constant for context.

See Also:

Constant Field Values

Status:

Stable ICU 3.6.

STANDALONE

public static final int STANDALONE

[icu] Constant for context.

See Also:

Constant Field Values

Status:

Stable ICU 3.6.

NUMERIC

@Deprecated
public static final int NUMERIC

Deprecated. This API is ICU internal only.

[icu] Constant for context. NUMERIC context is only supported for leapMonthPatterns.

See Also:

Constant Field Values

Status:

Internal. This API is ICU internal only.

DT_CONTEXT_COUNT

@Deprecated
public static final int DT_CONTEXT_COUNT

Deprecated. This API is ICU internal only.

[icu] Constant for context.

See Also:

Constant Field Values

Status:

Internal. This API is ICU internal only.

ABBREVIATED

public static final int ABBREVIATED

[icu] Constant for width.

See Also:

Constant Field Values

Status:

Stable ICU 3.6.

WIDE

public static final int WIDE

[icu] Constant for width.

See Also:

Constant Field Values

Status:

Stable ICU 3.6.

NARROW

public static final int NARROW

[icu] Constant for width.

See Also:

Constant Field Values

Status:

Stable ICU 3.6.

SHORT

public static final int SHORT

[icu] Constant for width; only supported for weekdays.

See Also:

Constant Field Values

Status:

Stable ICU 51.

DT_WIDTH_COUNT

@Deprecated
public static final int DT_WIDTH_COUNT

Deprecated. This API is ICU internal only.

[icu] Constant for width.

See Also:

Constant Field Values

Status:

Internal. This API is ICU internal only.

Constructor Detail

DateFormatSymbols

public DateFormatSymbols()

Constructs a DateFormatSymbols object by loading format data from resources for the default FORMAT locale.

Throws:

java.util.MissingResourceException - if the resources for the default locale cannot be found or cannot be loaded.

See Also:

ULocale.Category.FORMAT

Status:

Stable ICU 2.0.

DateFormatSymbols

public DateFormatSymbols(java.util.Locale locale)

Constructs 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)

[icu] Constructs 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:

Stable ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(Calendar cal,
                         java.util.Locale locale)

Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.

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)

Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.

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:

Stable ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(java.lang.Class<? extends Calendar> calendarClass,
                         java.util.Locale locale)

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

See Also:

DateFormatSymbols(Calendar, Locale)

Status:

Stable ICU 2.2.

DateFormatSymbols

public DateFormatSymbols(java.lang.Class<? extends Calendar> calendarClass,
                         ULocale locale)

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

See Also:

DateFormatSymbols(Calendar, Locale)

Status:

Stable ICU 3.2.

DateFormatSymbols

public DateFormatSymbols(java.util.ResourceBundle bundle,
                         java.util.Locale locale)

Fetches 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.Locale)

Status:

Stable ICU 2.0.

DateFormatSymbols

public DateFormatSymbols(java.util.ResourceBundle bundle,
                         ULocale locale)

Fetches 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.Locale)

Status:

Stable ICU 3.2.

Method Detail

getInstance

public static DateFormatSymbols getInstance()

Returns a DateFormatSymbols instance for the default locale.

[icu] Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:

A DateFormatSymbols instance.

Status:

Stable ICU 3.8.

getInstance

public static DateFormatSymbols getInstance(java.util.Locale locale)

Returns a DateFormatSymbols instance for the given locale.

[icu] Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Parameters:

locale - the locale.

Returns:

A DateFormatSymbols instance.

Status:

Stable ICU 3.8.

getInstance

public static DateFormatSymbols getInstance(ULocale locale)

[icu] Returns a DateFormatSymbols instance for the given locale.

[icu] Note: Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Parameters:

locale - the locale.

Returns:

A DateFormatSymbols instance.

Status:

Stable ICU 3.8.

getAvailableLocales

public static java.util.Locale[] getAvailableLocales()

Returns an array of all locales for which the getInstance methods of this class can return localized instances.

[icu] Note: Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of Locales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:

An array of Locales for which localized DateFormatSymbols instances are available.

Status:

Stable ICU 3.8.

getAvailableULocales

public static ULocale[] getAvailableULocales()

[icu] Returns an array of all locales for which the getInstance methods of this class can return localized instances.

[icu] Note: Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of ULocales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.

Returns:

An array of ULocales for which localized DateFormatSymbols instances are available.

Status:

Draft ICU 3.8 (retain).

getEras

public java.lang.String[] getEras()

Returns 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()

[icu] Returns era name strings. For example: "Anno Domini" and "Before Christ".

Returns:

the era strings.

Status:

Stable ICU 3.4.

setEraNames

public void setEraNames(java.lang.String[] newEraNames)

[icu] Sets era name strings. For example: "Anno Domini" and "Before Christ".

Parameters:

newEraNames - the new era strings.

Status:

Stable ICU 3.8.

getMonths

public java.lang.String[] getMonths()

Returns 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)

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

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

Stable ICU 3.8.

getShortMonths

public java.lang.String[] getShortMonths()

Returns 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()

Returns wide 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)

Returns 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, SHORT, or NARROW

Returns:

the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

Status:

Stable 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, SHORT, or NARROW.

Status:

Stable ICU 3.8.

setWeekdays

public void setWeekdays(java.lang.String[] newWeekdays)

Sets wide 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()

Returns abbreviated weekday strings; for example: "Sun", "Mon", etc. (Note: the method name is misleading; it does not get the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)

Returns:

the abbreviated 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[] newAbbrevWeekdays)

Sets abbreviated weekday strings; for example: "Sun", "Mon", etc. (Note: the method name is misleading; it does not set the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)

Parameters:

newAbbrevWeekdays - the new abbreviated weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.

Status:

Stable ICU 2.0.

getQuarters

public java.lang.String[] getQuarters(int context,
                                      int width)

[icu] Returns quarter strings. For example: "1st Quarter", "2nd Quarter", etc.

Parameters:

context - The quarter context, FORMAT or STANDALONE.

width - The width or the returned quarter string, either WIDE or ABBREVIATED. There are no NARROW quarters.

Returns:

the quarter strings.

Status:

Stable ICU 3.6.

setQuarters

public void setQuarters(java.lang.String[] newQuarters,
                        int context,
                        int width)

[icu] Sets quarter strings. For example: "1st Quarter", "2nd Quarter", etc.

Parameters:

newQuarters - the new quarter strings.

context - The formatting context, FORMAT or STANDALONE.

width - The width of the quarter string, either WIDE or ABBREVIATED. There are no NARROW quarters.

Status:

Stable ICU 3.8.

getYearNames

public java.lang.String[] getYearNames(int context,
                                       int width)

Returns cyclic year name strings if the calendar has them, for example: "jia-zi", "yi-chou", etc.

Parameters:

context - The usage context: FORMAT, STANDALONE.

width - The requested name width: WIDE, ABBREVIATED, SHORT, NARROW.

Returns:

The year name strings, or null if they are not available for this calendar.

Status:

Stable ICU 54.

setYearNames

public void setYearNames(java.lang.String[] yearNames,
                         int context,
                         int width)

Sets cyclic year name strings, for example: "jia-zi", "yi-chou", etc.

Parameters:

yearNames - The new cyclic year name strings.

context - The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).

width - The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).

Status:

Stable ICU 54.

getZodiacNames

public java.lang.String[] getZodiacNames(int context,
                                         int width)

Returns calendar zodiac name strings if the calendar has them, for example: "Rat", "Ox", "Tiger", etc.

Parameters:

context - The usage context: FORMAT, STANDALONE.

width - The requested name width: WIDE, ABBREVIATED, SHORT, NARROW.

Returns:

The zodiac name strings, or null if they are not available for this calendar.

Status:

Stable ICU 54.

setZodiacNames

public void setZodiacNames(java.lang.String[] zodiacNames,
                           int context,
                           int width)

Sets calendar zodiac name strings, for example: "Rat", "Ox", "Tiger", etc.

Parameters:

zodiacNames - The new zodiac name strings.

context - The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).

width - The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).

Status:

Stable ICU 54.

getLeapMonthPattern

@Deprecated
public java.lang.String getLeapMonthPattern(int context,
                                                        int width)

Deprecated. This API is ICU internal only.

Returns the appropriate leapMonthPattern if the calendar has them, for example: "{0}bis"

Parameters:

context - The usage context: FORMAT, STANDALONE, NUMERIC.

width - The requested pattern width: WIDE, ABBREVIATED, SHORT, NARROW.

Returns:

The leapMonthPattern, or null if not available for this calendar.

Status:

Internal. This API is ICU internal only.

setLeapMonthPattern

@Deprecated
public void setLeapMonthPattern(java.lang.String leapMonthPattern,
                                            int context,
                                            int width)

Deprecated. This API is ICU internal only.

Sets a leapMonthPattern, for example: "{0}bis"

Parameters:

leapMonthPattern - The new leapMonthPattern.

context - The usage context: FORMAT, STANDALONE, NUMERIC.

width - The name width: WIDE, ABBREVIATED, NARROW.

Status:

Internal. This API is ICU internal only.

getAmPmStrings

public java.lang.String[] getAmPmStrings()

Returns am/pm strings. For example: "AM" and "PM".

Returns:

the weekday strings.

Status:

Stable ICU 2.0.

setAmPmStrings

public void setAmPmStrings(java.lang.String[] newAmpms)

Sets am/pm strings. For example: "AM" and "PM".

Parameters:

newAmpms - the new ampm strings.

Status:

Stable ICU 2.0.

getTimeSeparatorString

@Deprecated
public java.lang.String getTimeSeparatorString()

Deprecated. This API is ICU internal only.

Returns the time separator string. For example: ":".

Returns:

the time separator string.

Status:

Internal. This API is ICU internal only.

setTimeSeparatorString

@Deprecated
public void setTimeSeparatorString(java.lang.String newTimeSeparator)

Deprecated. This API is ICU internal only.

Sets the time separator string. For example: ":".

Parameters:

newTimeSeparator - the new time separator string.

Status:

Internal. This API is ICU internal only.

getZoneStrings

public java.lang.String[][] getZoneStrings()

Returns time zone strings.

The array returned by this API is a two dimensional String array and each row contains at least following strings:

• ZoneStrings[n][0] - System time zone ID
• ZoneStrings[n][1] - Long standard time display name
• ZoneStrings[n][2] - Short standard time display name
• ZoneStrings[n][3] - Long daylight saving time display name
• ZoneStrings[n][4] - Short daylight saving time display name

When a localized display name is not available, the corresponding array element will be null.

Note: ICU implements the time zone display name formatting algorithm specified by UTS#35 Unicode Locale Data Markup Language(LDML). The algorithm supports historic display name changes and various different types of names not available in DateFormatSymbols.getZoneStrings(). For accessing the full set of time zone string data used by ICU implementation, you should use TimeZoneNames APIs instead.

Returns:

the time zone strings.

Status:

Stable ICU 2.0.

setZoneStrings

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

Sets time zone strings.

Note: SimpleDateFormat no longer uses the zone strings stored in a DateFormatSymbols. Therefore, the time zone strings set by this method have no effects in an instance of SimpleDateFormat for formatting time zones. If you want to customize time zone display names formatted by SimpleDateFormat, you should customize TimeZoneFormat and set the instance by SimpleDateFormat.setTimeZoneFormat(TimeZoneFormat) instead.

Parameters:

newZoneStrings - the new time zone strings.

Status:

Stable ICU 2.0.

getLocalPatternChars

public java.lang.String getLocalPatternChars()

Returns localized date-time pattern characters. For example: 'u', 't', etc.

Note: ICU no longer provides localized date-time pattern characters for a locale starting ICU 3.8. This method returns the non-localized date-time pattern characters unless user defined localized data is set by setLocalPatternChars.

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

Overrides:

clone in class java.lang.Object

Status:

Stable ICU 2.0.

hashCode

public int hashCode()

Override hashCode. Generates a hash code for the DateFormatSymbols object.

Overrides:

hashCode in class java.lang.Object

Status:

Stable ICU 2.0.

equals

public boolean equals(java.lang.Object obj)

Overrides equals.

Overrides:

equals in class java.lang.Object

Status:

Stable ICU 2.0.

initializeData

protected void initializeData(ULocale desiredLocale,
                              java.lang.String type)

Initializes format symbols for the locale and calendar type

Parameters:

desiredLocale - The locale whose symbols are desired.

type - The calendar type whose date format symbols are desired.

Status:

Stable ICU 3.0.

initializeData

@Deprecated
protected void initializeData(ULocale desiredLocale,
                                          com.ibm.icu.impl.ICUResourceBundle b,
                                          java.lang.String calendarType)

Deprecated. This API is ICU internal only.

Initializes format symbols for the locale and calendar type

Parameters:

desiredLocale - The locale whose symbols are desired.

b - Resource bundle provided externally

calendarType - The calendar type being used

Status:

Internal. This API is ICU internal only.

getDateFormatBundle

@Deprecated
public static java.util.ResourceBundle getDateFormatBundle(java.lang.Class<? extends Calendar> calendarClass,
                                                                       java.util.Locale locale)
                                                                throws java.util.MissingResourceException

Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:

java.util.MissingResourceException

getDateFormatBundle

@Deprecated
public static java.util.ResourceBundle getDateFormatBundle(java.lang.Class<? extends Calendar> calendarClass,
                                                                       ULocale locale)
                                                                throws java.util.MissingResourceException

Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:

java.util.MissingResourceException

getDateFormatBundle

@Deprecated
public static java.util.ResourceBundle getDateFormatBundle(Calendar cal,
                                                                       java.util.Locale locale)
                                                                throws java.util.MissingResourceException

Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:

java.util.MissingResourceException

See Also:

getDateFormatBundle(java.lang.Class, java.util.Locale)

getDateFormatBundle

@Deprecated
public static java.util.ResourceBundle getDateFormatBundle(Calendar cal,
                                                                       ULocale locale)
                                                                throws java.util.MissingResourceException

Deprecated. ICU 4.0

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

Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

Throws:

java.util.MissingResourceException

See Also:

getDateFormatBundle(java.lang.Class, java.util.Locale)

getLocale

public final ULocale getLocale(ULocale.Type type)

Returns 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).