DateFormatSymbols JDK 1.6)

Description

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.

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.

See also: DateFormat SimpleDateFormat SimpleTimeZone

Methods

Hide/Show inherited methods

public Object clone ()

Overrides Cloneable

public boolean equals (Object obj)

Override equals

public String getAmPmStrings ()

Gets ampm strings.

publicstatic Locale getAvailableLocales ()

Returns an array of all locales for which the getInstance methods of this class can return localized instances.

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.
Returns: An array of locales for which localized DateFormatSymbols instances are available.
Since: 1.6

public String getEras ()

Gets era strings.

publicfinalstatic DateFormatSymbols getInstance ()

Gets the DateFormatSymbols instance for the default locale.

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.
Returns: a DateFormatSymbols instance.
Since: 1.6

publicfinalstatic DateFormatSymbols getInstance (Locale locale)

Gets the DateFormatSymbols instance for the specified locale.

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.
Returns: a DateFormatSymbols instance.
Parameters:
- locale - the given locale.
Throws:
- NullPointerException - if locale is null
Since: 1.6

public String getLocalPatternChars ()

Gets localized date-time pattern characters.

public String getMonths ()

Gets month strings.

public String getShortMonths ()

Gets short month strings.

public String getShortWeekdays ()

Gets short weekday strings.

Gets short weekday strings. For example: "Sun", "Mon", etc.
Returns: the short weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

public String getWeekdays ()

Gets weekday strings.

Gets weekday strings. For example: "Sunday", "Monday", etc.
Returns: the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.

pack-privatefinal int getZoneIndex (String ID)

Package private: used by SimpleDateFormat Gets the index for the given time zone ID to obtain the time zone strings for formatting.

public String getZoneStrings ()

Gets time zone strings.

pack-privatefinal String getZoneStringsWrapper ()

Wrapper method to the getZoneStrings(), which is called from inside the java.text package and not to mutate the returned arrays, so that it does not need to create a defensive copy.

public int hashCode ()

Override hashCode.

public void setAmPmStrings (String newAmpms)

Sets ampm strings.

public void setEras (String newEras)

Sets era strings.

public void setLocalPatternChars (String newLocalPatternChars)

Sets localized date-time pattern characters.

public void setMonths (String newMonths)

Sets month strings.

public void setShortMonths (String newShortMonths)

Sets short month strings.

public void setShortWeekdays (String newShortWeekdays)

Sets short weekday strings.

Sets short weekday strings. For example: "Sun", "Mon", etc.
Parameters:
- newShortWeekdays - the new short weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.

public void setWeekdays (String newWeekdays)

Sets weekday strings.

Sets weekday strings. For example: "Sunday", "Monday", etc.
Parameters:
- newWeekdays - the new weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.

public void setZoneStrings (String newZoneStrings)

Sets time zone strings.

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 ID

zoneStrings[i][1] - long name of zone in standard
time

zoneStrings[i][2] - short name of zone in
standard time

zoneStrings[i][3] - long name of zone in daylight
saving time

zoneStrings[i][4] - short name of zone in daylight
saving time

The zone ID is not localized; it's one of the valid IDs of
the TimeZone class that are not
custom IDs.
All other entries are localized names.
Parameters:
- newZoneStrings - the new time zone strings.
Throws:
- IllegalArgumentException - if the length of any row in newZoneStrings is less than 5
- NullPointerException - if newZoneStrings is null
See Also: DateFormatSymbols.getZoneStrings(),

Fields

Hide/Show inherited fields

pack-private String ampms

AM and PM strings.

AM and PM strings. For example: "AM" and "PM". An array of
2 strings, indexed by Calendar.AM and
Calendar.PM.
Serial:

pack-private String eras

Era strings.

Era strings. For example: "AD" and "BC". An array of 2 strings,
indexed by Calendar.BC and Calendar.AD.
Serial:

pack-privatetransient boolean isZoneStringsSet

Indicates that zoneStrings is set externally with setZoneStrings() method.

pack-private Locale locale

The locale which is used for initializing this DateFormatSymbols object.

pack-private String localPatternChars

Localized date-time pattern characters.

Localized date-time pattern characters. For example, a locale may
wish to use 'u' rather than 'y' to represent years in its date format
pattern strings.
This string must be exactly 18 characters long, with the index of
the characters described by DateFormat.ERA_FIELD,
DateFormat.YEAR_FIELD, etc. Thus, if the string were
"Xz...", then localized patterns would use 'X' for era and 'z' for year.
Serial:

pack-privatefinalstatic int millisPerHour = "3600000"

Useful constant for defining time zone offsets.

pack-private String months

Month strings.

Month strings. For example: "January", "February", etc. An array
of 13 strings (some calendars have 13 months), indexed by
Calendar.JANUARY, Calendar.FEBRUARY, etc.
Serial:

pack-privatefinalstatic String patternChars = "GyMdkHmsSEDFwWahKzZ"

Unlocalized date-time pattern characters.

pack-privatefinalstatic long serialVersionUID = "-5987973545549424702"

pack-private String shortMonths

Short month strings.

Short month strings. For example: "Jan", "Feb", etc. An array of
13 strings (some calendars have 13 months), indexed by
Calendar.JANUARY, Calendar.FEBRUARY, etc.
Serial:

pack-private String shortWeekdays

Short weekday strings.

Short weekday strings. For example: "Sun", "Mon", etc. An array
of 8 strings, indexed by Calendar.SUNDAY,
Calendar.MONDAY, etc.
The element shortWeekdays[0] is ignored.
Serial:

pack-private String weekdays

Weekday strings.

Weekday strings. For example: "Sunday", "Monday", etc. An array
of 8 strings, indexed by Calendar.SUNDAY,
Calendar.MONDAY, etc.
The element weekdays[0] is ignored.
Serial:

pack-private String zoneStrings

Localized names of time zones in this locale.

Localized names of time zones in this locale. This 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 ID

zoneStrings[i][1] - long name of zone in standard
time

zoneStrings[i][2] - short name of zone in
standard time

zoneStrings[i][3] - long name of zone in daylight
saving time

zoneStrings[i][4] - short name of zone in daylight
saving time

The zone ID is not localized; it's one of the valid IDs of
the TimeZone class that are not
custom IDs.
All other entries are localized names.
Serial:
See Also: TimeZone,