public class DateFormatSymbols extends Object implements Serializable, Cloneable
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
.
Direct use of DateFormatSymbols
is likely to be less efficient
because the implementation cannot make assumptions about user-supplied/user-modifiable data
to the same extent that it can with its own built-in data.
DateFormat
,
SimpleDateFormat
,
Serialized FormConstructor and Description |
---|
DateFormatSymbols()
Constructs a new
DateFormatSymbols instance containing the
symbols for the user's default locale. |
DateFormatSymbols(Locale locale)
Constructs a new
DateFormatSymbols instance containing the
symbols for the specified locale. |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates and returns a copy of this
Object . |
boolean |
equals(Object object)
Compares this object with the specified object and indicates if they are
equal.
|
String[] |
getAmPmStrings()
Returns the array of strings which represent AM and PM.
|
static Locale[] |
getAvailableLocales()
Returns an array of locales for which custom
DateFormatSymbols instances
are available. |
String[] |
getEras()
Returns the array of strings which represent BC and AD.
|
static DateFormatSymbols |
getInstance()
Returns a new
DateFormatSymbols instance for the user's default locale. |
static DateFormatSymbols |
getInstance(Locale locale)
Returns a new
DateFormatSymbols for the given locale. |
String |
getLocalPatternChars()
Returns the pattern characters used by
SimpleDateFormat to
specify date and time fields. |
String[] |
getMonths()
Returns the array of strings containing the full names of the months.
|
String[] |
getShortMonths()
Returns the array of strings containing the abbreviated names of the
months.
|
String[] |
getShortWeekdays()
Returns the array of strings containing the abbreviated names of the days
of the week.
|
String[] |
getWeekdays()
Returns the array of strings containing the full names of the days of the
week.
|
String[][] |
getZoneStrings()
Returns the two-dimensional array of strings containing localized names for time zones.
|
int |
hashCode()
Returns an integer hash code for this object.
|
void |
setAmPmStrings(String[] data)
Sets the array of strings which represent AM and PM.
|
void |
setEras(String[] data)
Sets the array of Strings which represent BC and AD.
|
void |
setLocalPatternChars(String data)
Sets the pattern characters used by
SimpleDateFormat to specify
date and time fields. |
void |
setMonths(String[] data)
Sets the array of strings containing the full names of the months.
|
void |
setShortMonths(String[] data)
Sets the array of strings containing the abbreviated names of the months.
|
void |
setShortWeekdays(String[] data)
Sets the array of strings containing the abbreviated names of the days of
the week.
|
void |
setWeekdays(String[] data)
Sets the array of strings containing the full names of the days of the
week.
|
void |
setZoneStrings(String[][] zoneStrings)
Sets the two-dimensional array of strings containing localized names for time zones.
|
String |
toString()
Returns a string containing a concise, human-readable description of this
object.
|
public DateFormatSymbols()
DateFormatSymbols
instance containing the
symbols for the user's default locale.
See "Be wary of the default locale".public DateFormatSymbols(Locale locale)
DateFormatSymbols
instance containing the
symbols for the specified locale.locale
- the locale.public static final DateFormatSymbols getInstance()
DateFormatSymbols
instance for the user's default locale.
See "Be wary of the default locale".DateFormatSymbols
public static final DateFormatSymbols getInstance(Locale locale)
DateFormatSymbols
for the given locale.locale
- the localeDateFormatSymbols
NullPointerException
- if locale == null
public static Locale[] getAvailableLocales()
DateFormatSymbols
instances
are available.
Note that Android does not support user-supplied locale service providers.
public Object clone()
Object
Object
. The default
implementation returns a so-called "shallow" copy: It creates a new
instance of the same class and then copies the field values (including
object references) from this instance to the new instance. A "deep" copy,
in contrast, would also recursively clone nested objects. A subclass that
needs to implement this kind of cloning should call super.clone()
to create the new instance and then create deep copies of the nested,
mutable objects.public boolean equals(Object object)
equals
in class Object
object
- the object to compare with this object.true
if object
is an instance of
DateFormatSymbols
and has the same symbols as this
object, false
otherwise.hashCode()
public String toString()
Object
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString
method
if you intend implementing your own toString
method.
public String[] getAmPmStrings()
Calendar
constants Calendar.AM
and
Calendar.PM
as indices for the array.public String[] getEras()
Calendar
constants GregorianCalendar.BC
and
GregorianCalendar.AD
as indices for the array.public String getLocalPatternChars()
SimpleDateFormat
to
specify date and time fields.public String[] getMonths()
Calendar
constants Calendar.JANUARY
etc. as
indices for the array.public String[] getShortMonths()
Calendar
constants
Calendar.JANUARY
etc. as indices for the array.public String[] getShortWeekdays()
Calendar
constants
Calendar.SUNDAY
etc. as indices for the array.public String[] getWeekdays()
Calendar
constants
Calendar.SUNDAY
etc. as indices for the array.public String[][] getZoneStrings()
public int hashCode()
Object
Object.equals(java.lang.Object)
returns true
must return
the same hash code value. This means that subclasses of Object
usually override both methods or neither method.
Note that hash values must not change over time unless information used in equals comparisons also changes.
See Writing a correct
hashCode
method
if you intend implementing your own hashCode
method.
hashCode
in class Object
Object.equals(java.lang.Object)
public void setAmPmStrings(String[] data)
Calendar
constants Calendar.AM
and
Calendar.PM
as indices for the array.data
- the array of strings for AM and PM.public void setEras(String[] data)
Calendar
constants GregorianCalendar.BC
and
GregorianCalendar.AD
as indices for the array.data
- the array of strings for BC and AD.public void setLocalPatternChars(String data)
SimpleDateFormat
to specify
date and time fields.data
- the string containing the pattern characters.NullPointerException
- if data
is nullpublic void setMonths(String[] data)
Calendar
constants Calendar.JANUARY
etc. as
indices for the array.data
- the array of strings.public void setShortMonths(String[] data)
Calendar
constants Calendar.JANUARY
etc. as indices for the array.data
- the array of strings.public void setShortWeekdays(String[] data)
Calendar
constants
Calendar.SUNDAY
etc. as indices for the array.data
- the array of strings.public void setWeekdays(String[] data)
Calendar
constants
Calendar.SUNDAY
etc. as indices for the array.data
- the array of strings.public void setZoneStrings(String[][] zoneStrings)
getZoneStrings()
for details.IllegalArgumentException
- if any row has fewer than 5 elements.NullPointerException
- if zoneStrings == null
.