All Packages Class Hierarchy This Package Previous Next Index

Class java.text.DateFormatSymbols

java.lang.Object | +----java.text.DateFormatSymbols
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.

See Also:
DateFormat, SimpleDateFormat, SimpleTimeZone

Constructor Index

o DateFormatSymbols()
Construct a DateFormatSymbols object by loading format data from resources for the default locale.
o DateFormatSymbols(Locale)
Construct a DateFormatSymbols object by loading format data from resources for the given locale.

Method Index

o clone()
Overrides Cloneable
o equals(Object)
Override equals
o getAmPmStrings()
Gets ampm strings.
o getEras()
Gets era strings.
o getLocalPatternChars()
Gets localized date-time pattern characters.
o getMonths()
Gets month strings.
o getShortMonths()
Gets short month strings.
o getShortWeekdays()
Gets short weekday strings.
o getWeekdays()
Gets weekday strings.
o getZoneStrings()
Gets timezone strings.
o hashCode()
Override hashCode.
o setAmPmStrings(String[])
Sets ampm strings.
o setEras(String[])
Sets era strings.
o setLocalPatternChars(String)
Sets localized date-time pattern characters.
o setMonths(String[])
Sets month strings.
o setShortMonths(String[])
Sets short month strings.
o setShortWeekdays(String[])
Sets short weekday strings.
o setWeekdays(String[])
Sets weekday strings.
o setZoneStrings(String[][])
Sets timezone strings.

Constructors

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

Methods

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

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

Parameters:
newEras - the new era strings.
o getMonths public String[] getMonths()
Gets month strings. For example: "January", "February", etc.

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

Parameters:
newMonths - the new month strings.
o getShortMonths public String[] getShortMonths()
Gets short month strings. For example: "Jan", "Feb", etc.

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

Parameters:
newShortMonths - the new short month strings.
o getWeekdays public String[] getWeekdays()
Gets weekday strings. For example: "Sunday", "Monday", etc.

Returns:
the weekday strings.
o setWeekdays public void setWeekdays(String newWeekdays[])
Sets weekday strings. For example: "Sunday", "Monday", etc.

Parameters:
newWeekdays - the new weekday strings.
o getShortWeekdays public String[] getShortWeekdays()
Gets short weekday strings. For example: "Sun", "Mon", etc.

Returns:
the short weekday strings.
o setShortWeekdays public void setShortWeekdays(String newShortWeekdays[])
Sets short weekday strings. For example: "Sun", "Mon", etc.

Parameters:
newShortWeekdays - the new short weekday strings.
o getAmPmStrings public String[] getAmPmStrings()
Gets ampm strings. For example: "AM" and "PM".

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

Parameters:
newAmpms - the new ampm strings.
o getZoneStrings public String[][] getZoneStrings()
Gets timezone strings.

Returns:
the timezone strings.
o setZoneStrings public void setZoneStrings(String newZoneStrings[][])
Sets timezone strings.

Parameters:
newZoneStrings - the new timezone strings.
o getLocalPatternChars public String getLocalPatternChars()
Gets localized date-time pattern characters. For example: 'u', 't', etc.

Returns:
the localized date-time pattern characters.
o 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.
o clone public Object clone()
Overrides Cloneable

Overrides:
clone in class Object
o hashCode public int hashCode()
Override hashCode. Generates a hash code for the DateFormatSymbols object.

Overrides:
hashCode in class Object
o equals public boolean equals(Object obj)
Override equals

Overrides:
equals in class Object
All Packages Class Hierarchy This Package Previous Next Index
Submit a bug or feature