java.text
Class DateFormatSymbols

java.lang.Object
  extended by java.text.DateFormatSymbols
All Implemented Interfaces:
Serializable, Cloneable

public class DateFormatSymbols
extends Object
implements Serializable, Cloneable

This class acts as container for locale specific date/time formatting information such as the days of the week and the months of the year.

See Also:
Serialized Form

Constructor Summary
DateFormatSymbols()
          This method loads the format symbol information for the default locale.
DateFormatSymbols(Locale locale)
          This method initializes a new instance of DateFormatSymbols by loading the date format information for the specified locale.
 
Method Summary
 Object clone()
          Returns a new copy of this object.
 boolean equals(Object obj)
          This method tests a specified object for equality against this object.
 String[] getAmPmStrings()
          This method returns the list of strings used for displaying AM or PM.
 String[] getEras()
          This method returns the list of strings used for displaying eras (e.g., "BC" and "AD").
static DateFormatSymbols getInstance()
          Returns a DateFormatSymbols instance for the default locale obtained from either the runtime itself or one of the installed DateFormatSymbolsProvider instances.
static DateFormatSymbols getInstance(Locale locale)
          Returns a DateFormatSymbols instance for the specified locale obtained from either the runtime itself or one of the installed DateFormatSymbolsProvider instances.
 String getLocalPatternChars()
          This method returns the pattern character information for this object.
 String[] getMonths()
          This method returns the list of strings used for displaying month names (e.g., "January" and "February").
 String[] getShortMonths()
          This method returns the list of strings used for displaying abbreviated month names (e.g., "Jan" and "Feb").
 String[] getShortWeekdays()
          This method returns the list of strings used for displaying abbreviated weekday names (e.g., "Sun" and "Mon").
 String[] getWeekdays()
          This method returns the list of strings used for displaying weekday names (e.g., "Sunday" and "Monday").
 String[][] getZoneStrings()
          This method returns this list of localized timezone display strings.
 int hashCode()
          This method returns a hash value for this object.
 void setAmPmStrings(String[] value)
          This method sets the list of strings used to display AM/PM values to the specified list.
 void setEras(String[] labels)
          This method sets the list of strings used to display time eras to to the specified list.
 void setLocalPatternChars(String chars)
          This method sets the list of characters used to specific date/time formatting strings.
 void setMonths(String[] labels)
          This method sets the list of strings used to display month names.
 void setShortMonths(String[] labels)
          This method sets the list of strings used to display abbreviated month names.
 void setShortWeekdays(String[] labels)
          This method sets the list of strings used to display abbreviated weekday names.
 void setWeekdays(String[] labels)
          This method sets the list of strings used to display weekday names.
 void setZoneStrings(String[][] zones)
          This method sets the list of display strings for time zones.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DateFormatSymbols

public DateFormatSymbols(Locale locale)
                  throws MissingResourceException
This method initializes a new instance of DateFormatSymbols by loading the date format information for the specified locale. This constructor only obtains instances using the runtime's resources; to also include DateFormatSymbolsProvider instances, call getInstance(java.util.Locale) instead.

Parameters:
locale - The locale for which date formatting symbols should be loaded.
Throws:
MissingResourceException - if the resources for the specified locale could not be found or loaded.
See Also:
getInstance(java.util.Locale)

DateFormatSymbols

public DateFormatSymbols()
                  throws MissingResourceException
This method loads the format symbol information for the default locale. This constructor only obtains instances using the runtime's resources; to also include DateFormatSymbolsProvider instances, call getInstance() instead.

Throws:
MissingResourceException - if the resources for the default locale could not be found or loaded.
See Also:
getInstance()
Method Detail

getAmPmStrings

public String[] getAmPmStrings()
This method returns the list of strings used for displaying AM or PM. This is a two element String array indexed by Calendar.AM and Calendar.PM

Returns:
The list of AM/PM display strings.

getEras

public String[] getEras()
This method returns the list of strings used for displaying eras (e.g., "BC" and "AD"). This is a two element String array indexed by Calendar.BC and Calendar.AD.

Returns:
The list of era disply strings.

getLocalPatternChars

public String getLocalPatternChars()
This method returns the pattern character information for this object. This is an 18 character string that contains the characters that are used in creating the date formatting strings in SimpleDateFormat. The following are the character positions in the string and which format character they correspond to (the character in parentheses is the default value in the US English locale):

Returns:
The format patter characters

getMonths

public String[] getMonths()
This method returns the list of strings used for displaying month names (e.g., "January" and "February"). This is a thirteen element string array indexed by Calendar.JANUARY through Calendar.UNDECEMBER. Note that there are thirteen elements because some calendars have thriteen months.

Returns:
The list of month display strings.

getShortMonths

public String[] getShortMonths()
This method returns the list of strings used for displaying abbreviated month names (e.g., "Jan" and "Feb"). This is a thirteen element String array indexed by Calendar.JANUARY through Calendar.UNDECEMBER. Note that there are thirteen elements because some calendars have thirteen months.

Returns:
The list of abbreviated month display strings.

getShortWeekdays

public String[] getShortWeekdays()
This method returns the list of strings used for displaying abbreviated weekday names (e.g., "Sun" and "Mon"). This is an eight element String array indexed by Calendar.SUNDAY through Calendar.SATURDAY. Note that the first element of this array is ignored.

Returns:
This list of abbreviated weekday display strings.

getWeekdays

public String[] getWeekdays()
This method returns the list of strings used for displaying weekday names (e.g., "Sunday" and "Monday"). This is an eight element String array indexed by Calendar.SUNDAY through Calendar.SATURDAY. Note that the first element of this array is ignored.

Returns:
This list of weekday display strings.

getZoneStrings

public String[][] getZoneStrings()
This method returns this list of localized timezone display strings. This is a two dimensional String array where each row in the array contains five values:

If setZoneStrings(String[][]) has been called, then the value passed to this will be returned. Otherwise the returned array contains zone names provided by the runtime environment and any java.util.spi.TimeZoneProvider instances.

Returns:
The list of time zone display strings.
See Also:
setZoneStrings(String[][])

setAmPmStrings

public void setAmPmStrings(String[] value)
This method sets the list of strings used to display AM/PM values to the specified list. This is a two element String array indexed by Calendar.AM and Calendar.PM

Parameters:
value - The new list of AM/PM display strings.

setEras

public void setEras(String[] labels)
This method sets the list of strings used to display time eras to to the specified list. This is a two element String array indexed by Calendar.BC and Calendar.AD.

Parameters:
labels - The new list of era display strings.

setLocalPatternChars

public void setLocalPatternChars(String chars)
This method sets the list of characters used to specific date/time formatting strings. This is an 18 character string that contains the characters that are used in creating the date formatting strings in SimpleDateFormat. The following are the character positions in the string and which format character they correspond to (the character in parentheses is the default value in the US English locale):

Parameters:
chars - The new format pattern characters

setMonths

public void setMonths(String[] labels)
This method sets the list of strings used to display month names. This is a thirteen element string array indexed by Calendar.JANUARY through Calendar.UNDECEMBER. Note that there are thirteen elements because some calendars have thriteen months.

Parameters:
labels - The list of month display strings.

setShortMonths

public void setShortMonths(String[] labels)
This method sets the list of strings used to display abbreviated month names. This is a thirteen element String array indexed by Calendar.JANUARY through Calendar.UNDECEMBER. Note that there are thirteen elements because some calendars have thirteen months.

Parameters:
labels - The new list of abbreviated month display strings.

setShortWeekdays

public void setShortWeekdays(String[] labels)
This method sets the list of strings used to display abbreviated weekday names. This is an eight element String array indexed by Calendar.SUNDAY through Calendar.SATURDAY. Note that the first element of this array is ignored.

Parameters:
labels - This list of abbreviated weekday display strings.

setWeekdays

public void setWeekdays(String[] labels)
This method sets the list of strings used to display weekday names. This is an eight element String array indexed by Calendar.SUNDAY through Calendar.SATURDAY. Note that the first element of this array is ignored.

Parameters:
labels - This list of weekday display strings.

setZoneStrings

public void setZoneStrings(String[][] zones)
This method sets the list of display strings for time zones. This is a two dimensional String array where each row in the array contains five values:


equals

public boolean equals(Object obj)
This method tests a specified object for equality against this object. This will be true if and only if the specified object:

Overrides:
equals in class Object
Parameters:
obj - The Object to test for equality against.
Returns:
true if the specified object is equal to this one, false otherwise.
See Also:
Object.hashCode()

clone

public Object clone()
Returns a new copy of this object.

Overrides:
clone in class Object
Returns:
A copy of this object
See Also:
Cloneable

hashCode

public int hashCode()
This method returns a hash value for this object.

Overrides:
hashCode in class Object
Returns:
A hash value for this object.
See Also:
Object.equals(Object), System.identityHashCode(Object)

getInstance

public static final DateFormatSymbols getInstance()
Returns a DateFormatSymbols instance for the default locale obtained from either the runtime itself or one of the installed DateFormatSymbolsProvider instances. This is equivalent to calling getInstance(Locale.getDefault()).

Returns:
a DateFormatSymbols instance for the default locale.
Since:
1.6

getInstance

public static final DateFormatSymbols getInstance(Locale locale)
Returns a DateFormatSymbols instance for the specified locale obtained from either the runtime itself or one of the installed DateFormatSymbolsProvider instances.

Parameters:
locale - the locale for which an instance should be returned.
Returns:
a DateFormatSymbols instance for the specified locale.
Throws:
NullPointerException - if locale is null.
Since:
1.6