|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.text.DateFormatSymbols
public class DateFormatSymbols
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, DateFormatSymbols.getInstance(aLocale)).
DateFormatSymbols
objects are cloneable. 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.
DateFormat
,
SimpleDateFormat
,
SimpleTimeZone
,
Serialized FormConstructor Summary | |
---|---|
DateFormatSymbols()
Construct a DateFormatSymbols object by loading format data from resources for the default locale. |
|
DateFormatSymbols(Locale locale)
Construct a DateFormatSymbols object by loading format data from resources for the given locale. |
Method Summary | |
---|---|
Object |
clone()
Overrides Cloneable |
boolean |
equals(Object obj)
Override equals |
String[] |
getAmPmStrings()
Gets ampm strings. |
static Locale[] |
getAvailableLocales()
Returns an array of all locales for which the getInstance methods of this class can return
localized instances. |
String[] |
getEras()
Gets era strings. |
static DateFormatSymbols |
getInstance()
Gets the DateFormatSymbols instance for the default
locale. |
static DateFormatSymbols |
getInstance(Locale locale)
Gets the DateFormatSymbols instance for the specified
locale. |
String |
getLocalPatternChars()
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. |
int |
hashCode()
Override hashCode. |
void |
setAmPmStrings(String[] newAmpms)
Sets ampm strings. |
void |
setEras(String[] newEras)
Sets era strings. |
void |
setLocalPatternChars(String newLocalPatternChars)
Sets localized date-time pattern characters. |
void |
setMonths(String[] newMonths)
Sets month strings. |
void |
setShortMonths(String[] newShortMonths)
Sets short month strings. |
void |
setShortWeekdays(String[] newShortWeekdays)
Sets short weekday strings. |
void |
setWeekdays(String[] newWeekdays)
Sets weekday strings. |
void |
setZoneStrings(String[][] newZoneStrings)
Sets time zone strings. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DateFormatSymbols()
DateFormatSymbolsProvider
implementations. For full locale coverage, use the
getInstance
method.
MissingResourceException
- if the resources for the default locale cannot be
found or cannot be loaded.getInstance()
public DateFormatSymbols(Locale locale)
DateFormatSymbolsProvider
implementations. For full locale coverage, use the
getInstance
method.
MissingResourceException
- if the resources for the specified locale cannot be
found or cannot be loaded.getInstance(Locale)
Method Detail |
---|
public static Locale[] getAvailableLocales()
getInstance
methods of this class can return
localized instances.
The returned array represents the union of locales supported by the
Java runtime and by installed
DateFormatSymbolsProvider
implementations. It must contain at least a Locale
instance equal to Locale.US
.
DateFormatSymbols
instances are available.public static final DateFormatSymbols getInstance()
DateFormatSymbols
instance for the default
locale. This method provides access to DateFormatSymbols
instances for locales supported by the Java runtime itself as well
as for those supported by installed
DateFormatSymbolsProvider
implementations.
DateFormatSymbols
instance.public static final DateFormatSymbols getInstance(Locale locale)
DateFormatSymbols
instance for the specified
locale. This method provides access to DateFormatSymbols
instances for locales supported by the Java runtime itself as well
as for those supported by installed
DateFormatSymbolsProvider
implementations.
locale
- the given locale.
DateFormatSymbols
instance.
NullPointerException
- if locale
is nullpublic String[] getEras()
public void setEras(String[] newEras)
newEras
- the new era strings.public String[] getMonths()
public void setMonths(String[] newMonths)
newMonths
- the new month strings.public String[] getShortMonths()
public void setShortMonths(String[] newShortMonths)
newShortMonths
- the new short month strings.public String[] getWeekdays()
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.public void setWeekdays(String[] newWeekdays)
newWeekdays
- the new weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.public String[] getShortWeekdays()
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.public void setShortWeekdays(String[] newShortWeekdays)
newShortWeekdays
- the new short weekday strings. The array should
be indexed by Calendar.SUNDAY
,
Calendar.MONDAY
, etc.public String[] getAmPmStrings()
public void setAmPmStrings(String[] newAmpms)
newAmpms
- the new ampm strings.public String[][] getZoneStrings()
TimeZone.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 (with i
ranging 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 timeTimeZone
class 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 setZoneStrings
has been called
on this DateFormatSymbols
instance, then the strings
provided by that call are returned. Otherwise, the returned array
contains names provided by the Java runtime and by installed
TimeZoneNameProvider
implementations.
setZoneStrings(String[][])
public void setZoneStrings(String[][] newZoneStrings)
TimeZone
.
Each such row contains (with i
ranging 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 timeTimeZone
class that are not
custom IDs.
All other entries are localized names.
newZoneStrings
- the new time zone strings.
IllegalArgumentException
- if the length of any row in
newZoneStrings
is less than 5
NullPointerException
- if newZoneStrings
is nullgetZoneStrings()
public String getLocalPatternChars()
public void setLocalPatternChars(String newLocalPatternChars)
newLocalPatternChars
- the new localized date-time
pattern characters.public Object clone()
clone
in class Object
Cloneable
public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
Hashtable
public boolean equals(Object obj)
equals
in class Object
obj
- the reference object with which to compare.
true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
Hashtable
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.