java.text
Class DateFormatSymbols
java.lang.Object
|
+--java.text.DateFormatSymbols
All Implemented Interfaces:
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.
Author:- Per Bothner <bothner@cygnus.com>
DateFormatSymbols
public DateFormatSymbols() This method loads the format symbol information for the default
locale.
DateFormatSymbols
public DateFormatSymbols(java.util.Locale locale) This method initializes a new instance of DateFormatSymbols
by loading the date format information for the specified locale.
Parameters:
clone
public Object clone() Returns a new copy of this object.
equals
public boolean equals(java.lang.Object obj) This method tests a specified object for equality against this object.
This will be true if and only if the specified object:
- Is not
null.
- Is an instance of
DateFormatSymbols.
- Contains identical formatting symbols to this object.
Parameters:
Returns:
true if the specified object is equal to this one,
false otherwise.
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):
- 0 - era (G)
- 1 - year (y)
- 2 - month (M)
- 4 - hour out of 12, from 1-12 (h)
- 5 - hour out of 24, from 0-23 (H)
- 6 - minute (m)
- 7 - second (s)
- 8 - millisecond (S)
- 9 - date of week (E)
- 10 - date of year (D)
- 11 - day of week in month, eg. "4th Thur in Nov" (F)
- 12 - week in year (w)
- 13 - week in month (W)
- 14 - am/pm (a)
- 15 - hour out of 24, from 1-24 (k)
- 16 - hour out of 12, from 0-11 (K)
- 17 - time zone (z)
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:
- 0 - The non-localized time zone id string.
- 1 - The long name of the time zone (standard time).
- 2 - The short name of the time zone (standard time).
- 3 - The long name of the time zone (daylight savings time).
- 4 - the short name of the time zone (daylight savings time).
Returns:
- The list of time zone display strings.
hashCode
public int hashCode() This method returns a hash value for this object.
Returns:
- A hash value for this object.
setAmPmStrings
public void setAmPmStrings(java.lang.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:
setEras
public void setEras(java.lang.String[] value) 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:
setLocalPatternChars
public void setLocalPatternChars(java.lang.String value) 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):
- 0 - era (G)
- 1 - year (y)
- 2 - month (M)
- 4 - hour out of 12, from 1-12 (h)
- 5 - hour out of 24, from 0-23 (H)
- 6 - minute (m)
- 7 - second (s)
- 8 - millisecond (S)
- 9 - date of week (E)
- 10 - date of year (D)
- 11 - day of week in month, eg. "4th Thur in Nov" (F)
- 12 - week in year (w)
- 13 - week in month (W)
- 14 - am/pm (a)
- 15 - hour out of 24, from 1-24 (k)
- 16 - hour out of 12, from 0-11 (K)
- 17 - time zone (z)
Parameters:
setMonths
public void setMonths(java.lang.String[] value) 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:
setShortMonths
public void setShortMonths(java.lang.String[] value) 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:
setShortWeekdays
public void setShortWeekdays(java.lang.String[] value) 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:
setWeekdays
public void setWeekdays(java.lang.String[] value) 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:
setZoneStrings
public void setZoneStrings(java.lang.String[][] value) 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:
- 0 - The non-localized time zone id string.
- 1 - The long name of the time zone (standard time).
- 2 - The short name of the time zone (standard time).
- 3 - The long name of the time zone (daylight savings time).
- 4 - the short name of the time zone (daylight savings time).
Parameters:
Returns:
- The list of time zone display strings.