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.
* SimpleDateFormat uses
* 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 {@link 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 DateFormat
* @see SimpleDateFormat
* @see java.util.SimpleTimeZone
* @author Chen-Lieh Huang
*/
public class DateFormatSymbols implements Serializable, Cloneable {
/**
* Construct a DateFormatSymbols object by loading format data from
* resources for the default {@link java.util.Locale.Category#FORMAT FORMAT}
* locale. This constructor can only
* construct instances for the locales supported by the Java
* runtime environment, not for those supported by installed
* {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}
* implementations. For full locale coverage, use the
* {@link #getInstance(Locale) getInstance} method.
*
This is equivalent to calling
* {@link #DateFormatSymbols(Locale)
* DateFormatSymbols(Locale.getDefault(Locale.Category.FORMAT))}.
* @see #getInstance()
* @see java.util.Locale#getDefault(java.util.Locale.Category)
* @see java.util.Locale.Category#FORMAT
* @exception java.util.MissingResourceException
* if the resources for the default locale cannot be
* found or cannot be loaded.
*/
public DateFormatSymbols()
{
initializeData(Locale.getDefault(Locale.Category.FORMAT));
}
/**
* 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
* {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}
* implementations. For full locale coverage, use the
* {@link #getInstance(Locale) getInstance} method.
*
* @param locale the desired locale
* @see #getInstance(Locale)
* @exception java.util.MissingResourceException
* if the resources for the specified locale cannot be
* found or cannot be loaded.
*/
public DateFormatSymbols(Locale locale)
{
initializeData(locale);
}
/**
* Constructs an uninitialized DateFormatSymbols.
*/
private DateFormatSymbols(boolean flag) {
}
/**
* Era strings. For example: "AD" and "BC". An array of 2 strings,
* indexed by Calendar.BC and Calendar.AD.
* @serial
*/
String eras[] = null;
/**
* 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
*/
String months[] = null;
/**
* 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
*/
String shortMonths[] = null;
/**
* 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
*/
String weekdays[] = null;
/**
* 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
*/
String shortWeekdays[] = null;
/**
* AM and PM strings. For example: "AM" and "PM". An array of
* 2 strings, indexed by Calendar.AM and
* Calendar.PM.
* @serial
*/
String ampms[] = null;
/**
* 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 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 timeDateFormat.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
*/
String localPatternChars = null;
/**
* The locale which is used for initializing this DateFormatSymbols object.
*
* @since 1.6
* @serial
*/
Locale locale = null;
/* use serialVersionUID from JDK 1.1.4 for interoperability */
static final long serialVersionUID = -5987973545549424702L;
/**
* 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
* {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}
* implementations. It must contain at least a Locale
* instance equal to {@link java.util.Locale#US Locale.US}.
*
* @return An array of locales for which localized
* DateFormatSymbols instances are available.
* @since 1.6
*/
public static Locale[] getAvailableLocales() {
LocaleServiceProviderPool pool=
LocaleServiceProviderPool.getPool(DateFormatSymbolsProvider.class);
return pool.getAvailableLocales();
}
/**
* 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
* {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}
* implementations.
* This is equivalent to calling {@link #getInstance(Locale)
* getInstance(Locale.getDefault(Locale.Category.FORMAT))}.
* @see java.util.Locale#getDefault(java.util.Locale.Category)
* @see java.util.Locale.Category#FORMAT
* @return a DateFormatSymbols instance.
* @since 1.6
*/
public static final DateFormatSymbols getInstance() {
return getInstance(Locale.getDefault(Locale.Category.FORMAT));
}
/**
* 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
* {@link java.text.spi.DateFormatSymbolsProvider DateFormatSymbolsProvider}
* implementations.
* @param locale the given locale.
* @return a DateFormatSymbols instance.
* @exception NullPointerException if locale is null
* @since 1.6
*/
public static final DateFormatSymbols getInstance(Locale locale) {
DateFormatSymbols dfs = getProviderInstance(locale);
if (dfs != null) {
return dfs;
}
throw new RuntimeException("DateFormatSymbols instance creation failed.");
}
/**
* Returns a DateFormatSymbols provided by a provider or found in
* the cache. Note that this method returns a cached instance,
* not its clone. Therefore, the instance should never be given to
* an application.
*/
static final DateFormatSymbols getInstanceRef(Locale locale) {
DateFormatSymbols dfs = getProviderInstance(locale);
if (dfs != null) {
return dfs;
}
throw new RuntimeException("DateFormatSymbols instance creation failed.");
}
private static DateFormatSymbols getProviderInstance(Locale locale) {
LocaleProviderAdapter adapter = LocaleProviderAdapter.getAdapter(DateFormatSymbolsProvider.class, locale);
DateFormatSymbolsProvider provider = adapter.getDateFormatSymbolsProvider();
DateFormatSymbols dfsyms = provider.getInstance(locale);
if (dfsyms == null) {
provider = LocaleProviderAdapter.forJRE().getDateFormatSymbolsProvider();
dfsyms = provider.getInstance(locale);
}
return dfsyms;
}
/**
* Gets era strings. For example: "AD" and "BC".
* @return the era strings.
*/
public String[] getEras() {
return Arrays.copyOf(eras, eras.length);
}
/**
* Sets era strings. For example: "AD" and "BC".
* @param newEras the new era strings.
*/
public void setEras(String[] newEras) {
eras = Arrays.copyOf(newEras, newEras.length);
cachedHashCode = 0;
}
/**
* Gets month strings. For example: "January", "February", etc.
*
*
If the language requires different forms for formatting and * stand-alone usages, this method returns month names in the * formatting form. For example, the preferred month name for * January in the Czech language is ledna in the * formatting form, while it is leden in the stand-alone * form. This method returns {@code "ledna"} in this case. Refer * to the * Calendar Elements in the Unicode Locale Data Markup Language * (LDML) specification for more details. * * @return the month strings. */ public String[] getMonths() { return Arrays.copyOf(months, months.length); } /** * Sets month strings. For example: "January", "February", etc. * @param newMonths the new month strings. */ public void setMonths(String[] newMonths) { months = Arrays.copyOf(newMonths, newMonths.length); cachedHashCode = 0; } /** * Gets short month strings. For example: "Jan", "Feb", etc. * *
If the language requires different forms for formatting and
* stand-alone usages, This method returns short month names in
* the formatting form. For example, the preferred abbreviation
* for January in the Catalan language is de gen. in the
* formatting form, while it is gen. in the stand-alone
* form. This method returns {@code "de gen."} in this case. Refer
* to the
* Calendar Elements in the Unicode Locale Data Markup Language
* (LDML) specification for more details.
*
* @return the short month strings.
*/
public String[] getShortMonths() {
return Arrays.copyOf(shortMonths, shortMonths.length);
}
/**
* Sets short month strings. For example: "Jan", "Feb", etc.
* @param newShortMonths the new short month strings.
*/
public void setShortMonths(String[] newShortMonths) {
shortMonths = Arrays.copyOf(newShortMonths, newShortMonths.length);
cachedHashCode = 0;
}
/**
* Gets weekday strings. For example: "Sunday", "Monday", etc.
* @return the weekday strings. Use Calendar.SUNDAY,
* Calendar.MONDAY, etc. to index the result array.
*/
public String[] getWeekdays() {
return Arrays.copyOf(weekdays, weekdays.length);
}
/**
* Sets weekday strings. For example: "Sunday", "Monday", etc.
* @param newWeekdays the new weekday strings. The array should
* be indexed by Calendar.SUNDAY,
* Calendar.MONDAY, etc.
*/
public void setWeekdays(String[] newWeekdays) {
weekdays = Arrays.copyOf(newWeekdays, newWeekdays.length);
cachedHashCode = 0;
}
/**
* Gets short weekday strings. For example: "Sun", "Mon", etc.
* @return the short weekday strings. Use Calendar.SUNDAY,
* Calendar.MONDAY, etc. to index the result array.
*/
public String[] getShortWeekdays() {
return Arrays.copyOf(shortWeekdays, shortWeekdays.length);
}
/**
* Sets short weekday strings. For example: "Sun", "Mon", etc.
* @param newShortWeekdays the new short weekday strings. The array should
* be indexed by Calendar.SUNDAY,
* Calendar.MONDAY, etc.
*/
public void setShortWeekdays(String[] newShortWeekdays) {
shortWeekdays = Arrays.copyOf(newShortWeekdays, newShortWeekdays.length);
cachedHashCode = 0;
}
/**
* Gets ampm strings. For example: "AM" and "PM".
* @return the ampm strings.
*/
public String[] getAmPmStrings() {
return Arrays.copyOf(ampms, ampms.length);
}
/**
* Sets ampm strings. For example: "AM" and "PM".
* @param newAmpms the new ampm strings.
*/
public void setAmPmStrings(String[] newAmpms) {
ampms = Arrays.copyOf(newAmpms, newAmpms.length);
cachedHashCode = 0;
}
/**
* Gets time zone strings. Use of this method is discouraged; use
* {@link java.util.TimeZone#getDisplayName() 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 time
* If {@link #setZoneStrings(String[][]) 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
* {@link java.util.spi.TimeZoneNameProvider TimeZoneNameProvider}
* implementations.
*
* @return the time zone strings.
* @see #setZoneStrings(String[][])
*/
public String[][] getZoneStrings() {
return getZoneStringsImpl(true);
}
/**
* 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 timenewZoneStrings is less than 5
* @exception NullPointerException if newZoneStrings is null
* @see #getZoneStrings()
*/
public void setZoneStrings(String[][] newZoneStrings) {
String[][] aCopy = new String[newZoneStrings.length][];
for (int i = 0; i < newZoneStrings.length; ++i) {
int len = newZoneStrings[i].length;
if (len < 5) {
throw new IllegalArgumentException();
}
aCopy[i] = Arrays.copyOf(newZoneStrings[i], len);
}
zoneStrings = aCopy;
isZoneStringsSet = true;
cachedHashCode = 0;
}
/**
* Gets localized date-time pattern characters. For example: 'u', 't', etc.
* @return the localized date-time pattern characters.
*/
public String getLocalPatternChars() {
return localPatternChars;
}
/**
* Sets localized date-time pattern characters. For example: 'u', 't', etc.
* @param newLocalPatternChars the new localized date-time
* pattern characters.
*/
public void setLocalPatternChars(String newLocalPatternChars) {
// Call toString() to throw an NPE in case the argument is null
localPatternChars = newLocalPatternChars.toString();
cachedHashCode = 0;
}
/**
* Overrides Cloneable
*/
public Object clone()
{
try
{
DateFormatSymbols other = (DateFormatSymbols)super.clone();
copyMembers(this, other);
return other;
} catch (CloneNotSupportedException e) {
throw new InternalError(e);
}
}
/**
* Override hashCode.
* Generates a hash code for the DateFormatSymbols object.
*/
@Override
public int hashCode() {
int hashCode = cachedHashCode;
if (hashCode == 0) {
hashCode = 5;
hashCode = 11 * hashCode + Arrays.hashCode(eras);
hashCode = 11 * hashCode + Arrays.hashCode(months);
hashCode = 11 * hashCode + Arrays.hashCode(shortMonths);
hashCode = 11 * hashCode + Arrays.hashCode(weekdays);
hashCode = 11 * hashCode + Arrays.hashCode(shortWeekdays);
hashCode = 11 * hashCode + Arrays.hashCode(ampms);
hashCode = 11 * hashCode + Arrays.deepHashCode(getZoneStringsWrapper());
hashCode = 11 * hashCode + Objects.hashCode(localPatternChars);
cachedHashCode = hashCode;
}
return hashCode;
}
/**
* Override equals
*/
public boolean equals(Object obj)
{
if (this == obj) return true;
if (obj == null || getClass() != obj.getClass()) return false;
DateFormatSymbols that = (DateFormatSymbols) obj;
return (Arrays.equals(eras, that.eras)
&& Arrays.equals(months, that.months)
&& Arrays.equals(shortMonths, that.shortMonths)
&& Arrays.equals(weekdays, that.weekdays)
&& Arrays.equals(shortWeekdays, that.shortWeekdays)
&& Arrays.equals(ampms, that.ampms)
&& Arrays.deepEquals(getZoneStringsWrapper(), that.getZoneStringsWrapper())
&& ((localPatternChars != null
&& localPatternChars.equals(that.localPatternChars))
|| (localPatternChars == null
&& that.localPatternChars == null)));
}
// =======================privates===============================
/**
* Useful constant for defining time zone offsets.
*/
static final int millisPerHour = 60*60*1000;
/**
* Cache to hold DateFormatSymbols instances per Locale.
*/
private static final ConcurrentMapzoneStrings field is initialized in order to make
* sure the backward compatibility.
*
* @since 1.6
*/
private void writeObject(ObjectOutputStream stream) throws IOException {
if (zoneStrings == null) {
zoneStrings = TimeZoneNameUtility.getZoneStrings(locale);
}
stream.defaultWriteObject();
}
}