- java.lang.Object
-
- java.text.DateFormatSymbols
-
- All Implemented Interfaces:
Serializable,Cloneable
public class DateFormatSymbols extends Object implements Serializable, Cloneable
DateFormatSymbolsis 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.SimpleDateFormatusesDateFormatSymbolsto encapsulate this information.Typically you shouldn't use
DateFormatSymbolsdirectly. Rather, you are encouraged to create a date-time formatter with theDateFormatclass's factory methods:getTimeInstance,getDateInstance, orgetDateTimeInstance. These methods automatically create aDateFormatSymbolsfor the formatter so that you don't have to. After the formatter is created, you may modify its format pattern using thesetPatternmethod. For more information about creating formatters usingDateFormat's factory methods, seeDateFormat.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, DateFormatSymbols.getInstance(aLocale)).
If the locale contains "rg" (region override) Unicode extension, the symbols are overridden for the designated region.
DateFormatSymbolsobjects are cloneable. When you obtain aDateFormatSymbolsobject, 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
DateFormatSymbolssubclasses may be added to supportSimpleDateFormatfor date-time formatting for additional locales.- Since:
- 1.1
- See Also:
DateFormat,SimpleDateFormat,SimpleTimeZone, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DateFormatSymbols()Construct a DateFormatSymbols object by loading format data from resources for the defaultFORMATlocale.DateFormatSymbols(Locale locale)Construct a DateFormatSymbols object by loading format data from resources for the given locale.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Overrides Cloneablebooleanequals(Object obj)Override equalsString[]getAmPmStrings()Gets ampm strings.static Locale[]getAvailableLocales()Returns an array of all locales for which thegetInstancemethods of this class can return localized instances.String[]getEras()Gets era strings.static DateFormatSymbolsgetInstance()Gets theDateFormatSymbolsinstance for the default locale.static DateFormatSymbolsgetInstance(Locale locale)Gets theDateFormatSymbolsinstance for the specified locale.StringgetLocalPatternChars()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 time zone strings.inthashCode()Override hashCode.voidsetAmPmStrings(String[] newAmpms)Sets ampm strings.voidsetEras(String[] newEras)Sets era strings.voidsetLocalPatternChars(String newLocalPatternChars)Sets localized date-time pattern characters.voidsetMonths(String[] newMonths)Sets month strings.voidsetShortMonths(String[] newShortMonths)Sets short month strings.voidsetShortWeekdays(String[] newShortWeekdays)Sets short weekday strings.voidsetWeekdays(String[] newWeekdays)Sets weekday strings.voidsetZoneStrings(String[][] newZoneStrings)Sets time zone strings.
-
-
-
Constructor Detail
-
DateFormatSymbols
public DateFormatSymbols()
Construct a DateFormatSymbols object by loading format data from resources for the defaultFORMATlocale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installedDateFormatSymbolsProviderimplementations. For full locale coverage, use thegetInstancemethod.This is equivalent to calling
DateFormatSymbols(Locale.getDefault(Locale.Category.FORMAT)).- Throws:
MissingResourceException- if the resources for the default locale cannot be found or cannot be loaded.- See Also:
getInstance(),Locale.getDefault(java.util.Locale.Category),Locale.Category.FORMAT
-
DateFormatSymbols
public DateFormatSymbols(Locale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given locale. This constructor can only construct instances for the locales supported by the Java runtime environment, not for those supported by installedDateFormatSymbolsProviderimplementations. For full locale coverage, use thegetInstancemethod.- Parameters:
locale- the desired locale- Throws:
MissingResourceException- if the resources for the specified locale cannot be found or cannot be loaded.- See Also:
getInstance(Locale)
-
-
Method Detail
-
getAvailableLocales
public static Locale[] getAvailableLocales()
Returns an array of all locales for which thegetInstancemethods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installedDateFormatSymbolsProviderimplementations. It must contain at least aLocaleinstance equal toLocale.US.- Returns:
- An array of locales for which localized
DateFormatSymbolsinstances are available. - Since:
- 1.6
-
getInstance
public static final DateFormatSymbols getInstance()
Gets theDateFormatSymbolsinstance for the default locale. This method provides access toDateFormatSymbolsinstances for locales supported by the Java runtime itself as well as for those supported by installedDateFormatSymbolsProviderimplementations.This is equivalent to calling
getInstance(Locale.getDefault(Locale.Category.FORMAT)).- Returns:
- a
DateFormatSymbolsinstance. - Since:
- 1.6
- See Also:
Locale.getDefault(java.util.Locale.Category),Locale.Category.FORMAT
-
getInstance
public static final DateFormatSymbols getInstance(Locale locale)
Gets theDateFormatSymbolsinstance for the specified locale. This method provides access toDateFormatSymbolsinstances for locales supported by the Java runtime itself as well as for those supported by installedDateFormatSymbolsProviderimplementations.- Parameters:
locale- the given locale.- Returns:
- a
DateFormatSymbolsinstance. - Throws:
NullPointerException- iflocaleis null- Since:
- 1.6
-
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. An array with either 12 or 13 elements will be returned depending on whether or notCalendar.UNDECIMBERis supported. UseCalendar.JANUARY,Calendar.FEBRUARY, etc. to index the result array.If the language requires different forms for formatting and stand-alone usages, this method returns month names in the formatting form. For example, the preferred month name for January in the Czech language is ledna in the formatting form, while it is leden in the stand-alone form. This method returns
"ledna"in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.- Implementation Requirements:
- This method returns 13 elements since
Calendar.UNDECIMBERis supported. - Returns:
- the month strings.
-
setMonths
public void setMonths(String[] newMonths)
Sets month strings. For example: "January", "February", etc.- Parameters:
newMonths- the new month strings. The array should be indexed byCalendar.JANUARY,Calendar.FEBRUARY, etc.
-
getShortMonths
public String[] getShortMonths()
Gets short month strings. For example: "Jan", "Feb", etc. An array with either 12 or 13 elements will be returned depending on whether or notCalendar.UNDECIMBERis supported. UseCalendar.JANUARY,Calendar.FEBRUARY, etc. to index the result array.If the language requires different forms for formatting and stand-alone usages, this method returns short month names in the formatting form. For example, the preferred abbreviation for January in the Catalan language is de gen. in the formatting form, while it is gen. in the stand-alone form. This method returns
"de gen."in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.- Implementation Requirements:
- This method returns 13 elements since
Calendar.UNDECIMBERis supported. - 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. The array should be indexed byCalendar.JANUARY,Calendar.FEBRUARY, etc.
-
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 byCalendar.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 byCalendar.SUNDAY,Calendar.MONDAY, etc.
-
getAmPmStrings
public String[] getAmPmStrings()
Gets ampm strings. For example: "AM" and "PM".- Returns:
- the ampm 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 time zone strings. Use of this method is discouraged; useTimeZone.getDisplayName()instead.The value returned is a two-dimensional array of strings of size n by m, where m is at least 5. Each of the n rows is an entry containing the localized names for a single
TimeZone. Each such row contains (withiranging from 0..n-1):zoneStrings[i][0]- time zone IDzoneStrings[i][1]- long name of zone in standard timezoneStrings[i][2]- short name of zone in standard timezoneStrings[i][3]- long name of zone in daylight saving timezoneStrings[i][4]- short name of zone in daylight saving time
TimeZoneclass that are not custom IDs. All other entries are localized names. If a zone does not implement daylight saving time, the daylight saving time names should not be used.If
setZoneStringshas been called on thisDateFormatSymbolsinstance, then the strings provided by that call are returned. Otherwise, the returned array contains names provided by the Java runtime and by installedTimeZoneNameProviderimplementations.- Returns:
- the time zone strings.
- See Also:
setZoneStrings(String[][])
-
setZoneStrings
public void setZoneStrings(String[][] newZoneStrings)
Sets time zone strings. The argument must be a two-dimensional array of strings of size n by m, where m is at least 5. Each of the n rows is an entry containing the localized names for a singleTimeZone. Each such row contains (withiranging from 0..n-1):zoneStrings[i][0]- time zone IDzoneStrings[i][1]- long name of zone in standard timezoneStrings[i][2]- short name of zone in standard timezoneStrings[i][3]- long name of zone in daylight saving timezoneStrings[i][4]- short name of zone in daylight saving time
TimeZoneclass that are not custom IDs. All other entries are localized names.- Parameters:
newZoneStrings- the new time zone strings.- Throws:
IllegalArgumentException- if the length of any row innewZoneStringsis less than 5NullPointerException- ifnewZoneStringsis null- See Also:
getZoneStrings()
-
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
-
hashCode
public int hashCode()
Override hashCode. Generates a hash code for the DateFormatSymbols object.- Overrides:
hashCodein classObject- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
equals
public boolean equals(Object obj)
Override equals- Overrides:
equalsin classObject- Parameters:
obj- the reference object with which to compare.- Returns:
trueif this object is the same as the obj argument;falseotherwise.- See Also:
Object.hashCode(),HashMap
-
-