Class DateFormatSymbols

java.lang.Object
java.text.DateFormatSymbols
All Implemented Interfaces:
Serializable,Cloneable
public classDateFormatSymbolsextendsObjectimplementsSerializable,Cloneable
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 usesDateFormatSymbols to encapsulate this information.

Typically you shouldn't useDateFormatSymbols directly. Rather, you are encouraged to create a date-time formatter with theDateFormat class's factory methods:getTimeInstance,getDateInstance, orgetDateTimeInstance. These methods automatically create aDateFormatSymbols for the formatter so that you don't have to. After the formatter is created, you may modify its format pattern using thesetPattern method. For more information about creating formatters usingDateFormat's factory methods, seeDateFormat.

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));

If the locale contains "rg" (region override)Unicode extension, the symbols are overridden for the designated region.

DateFormatSymbols objects are cloneable. When you obtain aDateFormatSymbols 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.

NewDateFormatSymbols subclasses may be added to supportSimpleDateFormat for date-time formatting for additional locales.

Since:
1.1
See Also:

  • Constructor Details

  • Method Details

    • getAvailableLocales

      public static Locale[] getAvailableLocales()
      Returns an array of all locales for which thegetInstance methods of this class can return localized instances. The returned array represents the union of locales supported by the Java runtime and by installedDateFormatSymbolsProvider implementations. At a minimum, the returned array must contain aLocale instance equal toLocale.ROOT and aLocale instance equal toLocale.US.
      Returns:
      An array of locales for which localizedDateFormatSymbols instances are available.
      Since:
      1.6

    • getInstance

      public static final DateFormatSymbols getInstance()
      Gets theDateFormatSymbols instance for the default locale. This method provides access toDateFormatSymbols instances for locales supported by the Java runtime itself as well as for those supported by installedDateFormatSymbolsProvider implementations.

      This is equivalent to callinggetInstance(Locale.getDefault(Locale.Category.FORMAT)).

      Returns:
      aDateFormatSymbols instance.
      Since:
      1.6
      See Also:

    • getInstance

      public static final DateFormatSymbols getInstance(Locale locale)
      Gets theDateFormatSymbols instance for the specified locale. This method provides access toDateFormatSymbols instances for locales supported by the Java runtime itself as well as for those supported by installedDateFormatSymbolsProvider implementations.
      Parameters:
      locale - the given locale.
      Returns:
      aDateFormatSymbols instance.
      Throws:
      NullPointerException - iflocale is null
      Since:
      1.6

    • getEras

      public String[] getEras()
      Gets era strings. For example: "AD" and "BC".
      Returns:
      the era strings.

    • setEras

      public void setEras(String[] newEras)
      Sets era strings. For example: "AD" and "BC".
      Parameters:
      newEras - the new era strings.

    • getMonths

      public String[] getMonths()
      Gets month strings. For example: "January", "February", etc. An array with either 12 or 13 elements will be returned depending on whether or notCalendar.UNDECIMBER is supported. UseCalendar.JANUARY,Calendar.FEBRUARY, etc. to index the result array.

      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 isledna in the formatting form, while it isleden in the stand-alone form. This method returns"ledna" in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.

      Implementation Requirements:
      This method returns 13 elements sinceCalendar.UNDECIMBER is supported.
      Returns:
      the month strings.
      External Specifications

    • setMonths

      public void setMonths(String[] newMonths)
      Sets month strings. For example: "January", "February", etc.
      Parameters:
      newMonths - the new month strings. The array should be indexed byCalendar.JANUARY,Calendar.FEBRUARY, etc.

    • getShortMonths

      public String[] getShortMonths()
      Gets short month strings. For example: "Jan", "Feb", etc. An array with either 12 or 13 elements will be returned depending on whether or notCalendar.UNDECIMBER is supported. UseCalendar.JANUARY,Calendar.FEBRUARY, etc. to index the result array.

      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 isde gen. in the formatting form, while it isgen. in the stand-alone form. This method returns"de gen." in this case. Refer to the Calendar Elements in the Unicode Locale Data Markup Language (LDML) specification for more details.

      Implementation Requirements:
      This method returns 13 elements sinceCalendar.UNDECIMBER is supported.
      Returns:
      the short month strings.
      External Specifications

    • setShortMonths

      public void setShortMonths(String[] newShortMonths)
      Sets short month strings. For example: "Jan", "Feb", etc.
      Parameters:
      newShortMonths - the new short month strings. The array should be indexed byCalendar.JANUARY,Calendar.FEBRUARY, etc.

    • getWeekdays

      public String[] getWeekdays()
      Gets weekday strings. For example: "Sunday", "Monday", etc.
      Returns:
      the weekday strings. UseCalendar.SUNDAY,Calendar.MONDAY, etc. to index the result array.

    • setWeekdays

      public void setWeekdays(String[] newWeekdays)
      Sets weekday strings. For example: "Sunday", "Monday", etc.
      Parameters:
      newWeekdays - the new weekday strings. The array should be indexed byCalendar.SUNDAY,Calendar.MONDAY, etc.

    • getShortWeekdays

      public String[] getShortWeekdays()
      Gets short weekday strings. For example: "Sun", "Mon", etc.
      Returns:
      the short weekday strings. UseCalendar.SUNDAY,Calendar.MONDAY, etc. to index the result array.

    • setShortWeekdays

      public void setShortWeekdays(String[] newShortWeekdays)
      Sets short weekday strings. For example: "Sun", "Mon", etc.
      Parameters:
      newShortWeekdays - the new short weekday strings. The array should be indexed byCalendar.SUNDAY,Calendar.MONDAY, etc.

    • getAmPmStrings

      public String[] getAmPmStrings()
      Gets ampm strings. For example: "AM" and "PM".
      Returns:
      the ampm strings.

    • setAmPmStrings

      public void setAmPmStrings(String[] newAmpms)
      Sets ampm strings. For example: "AM" and "PM".
      Parameters:
      newAmpms - the new ampm strings.

    • getZoneStrings

      public String[][] getZoneStrings()
      Gets time zone strings. Use of this method is discouraged; useTimeZone.getDisplayName() instead.

      The value returned is a two-dimensional array of strings of sizen bym, wherem is at least 5. Each of then rows is an entry containing the localized names for a singleTimeZone. Each such row contains (withi 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 isnot localized; it's one of the valid IDs of theTimeZone class that are notcustom 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.

      IfsetZoneStrings has been called on thisDateFormatSymbols instance, then the strings provided by that call are returned. Otherwise, the returned array contains names provided by the Java runtime and by installedTimeZoneNameProvider implementations.

      Returns:
      the time zone strings.
      See Also:

    • setZoneStrings

      public void setZoneStrings(String[][] newZoneStrings)
      Sets time zone strings. The argument must be a two-dimensional array of strings of sizen bym, wherem is at least 5. Each of then rows is an entry containing the localized names for a singleTimeZone. Each such row contains (withi 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 isnot localized; it's one of the valid IDs of theTimeZone class that are notcustom IDs. All other entries are localized names.
      Parameters:
      newZoneStrings - the new time zone strings.
      Throws:
      IllegalArgumentException - if the length of any row innewZoneStrings is less than 5
      NullPointerException - ifnewZoneStrings is null
      See Also:

    • getLocalPatternChars

      public String getLocalPatternChars()
      Gets localized date-time pattern characters. For example: 'u', 't', etc.
      Returns:
      the localized date-time pattern characters.

    • setLocalPatternChars

      public void setLocalPatternChars(String newLocalPatternChars)
      Sets localized date-time pattern characters. For example: 'u', 't', etc.
      Parameters:
      newLocalPatternChars - the new localized date-time pattern characters.

    • clone

      public Object clone()
      Overrides Cloneable
      Overrides:
      clone in class Object
      Returns:
      a clone of this instance.
      See Also:

    • hashCode

      public int hashCode()
      Returns the hash code for thisDateFormatSymbols.
      Overrides:
      hashCode in class Object
      Implementation Requirements:
      Non-transient instance fields of this class are used to calculate a hash code value which adheres to the contract defined inObjects.hashCode(java.lang.Object).
      Returns:
      the hash code for thisDateFormatSymbols
      See Also:

    • equals

      public boolean equals(Object obj)
      Compares the specified object with thisDateFormatSymbols for equality. Returns true if the object is also aDateFormatSymbols and the twoDateFormatSymbols objects represent the same date-time formatting data.
      Overrides:
      equals in class Object
      Implementation Requirements:
      This method performs an equality check with a notion of class identity based ongetClass(), rather thaninstanceof. Therefore, in the equals methods in subclasses, no instance of this class should compare as equal to an instance of a subclass.
      Parameters:
      obj - object to be compared for equality
      Returns:
      true if the specified object is equal to thisDateFormatSymbols
      See Also: