java.lang.Object | |
↳ | java.text.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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a DateFormatSymbols object by loading format data from
resources for the default locale.
| |||||||||||
Construct a DateFormatSymbols object by loading format data from
resources for the given locale.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Overrides Cloneable
| |||||||||||
Override equals
| |||||||||||
Gets ampm strings.
| |||||||||||
Returns an array of all locales for which the
getInstance methods of this class can return
localized instances. | |||||||||||
Gets era strings.
| |||||||||||
Gets the
DateFormatSymbols instance for the default
locale. | |||||||||||
Gets the
DateFormatSymbols instance for the specified
locale. | |||||||||||
Gets localized date-time pattern characters.
| |||||||||||
Gets month strings.
| |||||||||||
Gets short month strings.
| |||||||||||
Gets short weekday strings.
| |||||||||||
Gets weekday strings.
| |||||||||||
Gets time zone strings.
| |||||||||||
Override hashCode.
| |||||||||||
Sets ampm strings.
| |||||||||||
Sets era strings.
| |||||||||||
Sets localized date-time pattern characters.
| |||||||||||
Sets month strings.
| |||||||||||
Sets short month strings.
| |||||||||||
Sets short weekday strings.
| |||||||||||
Sets weekday strings.
| |||||||||||
Sets time zone strings.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Construct a DateFormatSymbols object by loading format data from
resources for the default locale. This constructor can only
construct instances for the locales supported by the Java
runtime environment, not for those supported by installed
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. |
---|
Construct a DateFormatSymbols object by loading format data from
resources for the given locale. This constructor can only
construct instances for the locales supported by the Java
runtime environment, not for those supported by installed
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. |
---|
Override equals
obj | the reference object with which to compare. |
---|
true
if this object is the same as the obj
argument; false
otherwise.Gets ampm strings. For example: "AM" and "PM".
Returns an array of all locales for which the
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.Gets the 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.Gets the 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 null |
---|
Gets localized date-time pattern characters. For example: 'u', 't', etc.
Gets month strings. For example: "January", "February", etc.
Gets short month strings. For example: "Jan", "Feb", etc.
Gets short weekday strings. For example: "Sun", "Mon", etc.
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.
Gets weekday strings. For example: "Sunday", "Monday", etc.
Calendar.SUNDAY
,
Calendar.MONDAY
, etc. to index the result array.
Gets time zone strings. Use of this method is discouraged; use
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.
Override hashCode. Generates a hash code for the DateFormatSymbols object.
Sets ampm strings. For example: "AM" and "PM".
newAmpms | the new ampm strings. |
---|
Sets era strings. For example: "AD" and "BC".
newEras | the new era strings. |
---|
Sets localized date-time pattern characters. For example: 'u', 't', etc.
newLocalPatternChars | the new localized date-time pattern characters. |
---|
Sets month strings. For example: "January", "February", etc.
newMonths | the new month strings. |
---|
Sets short month strings. For example: "Jan", "Feb", etc.
newShortMonths | the new short month strings. |
---|
Sets short weekday strings. For example: "Sun", "Mon", etc.
newShortWeekdays | the new short weekday strings. The array should
be indexed by Calendar.SUNDAY ,
Calendar.MONDAY , etc.
|
---|
Sets weekday strings. For example: "Sunday", "Monday", etc.
newWeekdays | the new weekday strings. The array should
be indexed by Calendar.SUNDAY ,
Calendar.MONDAY , etc.
|
---|
Sets time zone strings. The argument must be 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.newZoneStrings | the new time zone strings. |
---|
IllegalArgumentException | if the length of any row in
newZoneStrings is less than 5 |
---|---|
NullPointerException | if newZoneStrings is null |