Class DateFormatSymbols

java.lang.Object
com.ibm.icu.text.DateFormatSymbols
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
ChineseDateFormatSymbols

public class DateFormatSymbols extends Object implements Serializable, 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. 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, new DateFormatSymbols(aLocale)).
 

DateFormatSymbols objects are clonable. 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:
  • Field Details

    • FORMAT

      public static final int FORMAT
      Constant for context.
      See Also:
    • STANDALONE

      public static final int STANDALONE
      Constant for context.
      See Also:
    • NUMERIC

      @Deprecated public static final int NUMERIC
      Deprecated.
      This API is ICU internal only.
      Constant for context. NUMERIC context is only supported for leapMonthPatterns.
      See Also:
    • DT_CONTEXT_COUNT

      @Deprecated public static final int DT_CONTEXT_COUNT
      Deprecated.
      This API is ICU internal only.
      Constant for context.
      See Also:
    • ABBREVIATED

      public static final int ABBREVIATED
      Constant for width.
      See Also:
    • WIDE

      public static final int WIDE
      Constant for width.
      See Also:
    • NARROW

      public static final int NARROW
      Constant for width.
      See Also:
    • SHORT

      public static final int SHORT
      Constant for width; only supported for weekdays.
      See Also:
    • DT_WIDTH_COUNT

      @Deprecated public static final int DT_WIDTH_COUNT
      Deprecated.
      This API is ICU internal only.
      Constant for width.
      See Also:
    • DT_LEAP_MONTH_PATTERN_FORMAT_WIDE

      static final int DT_LEAP_MONTH_PATTERN_FORMAT_WIDE
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_FORMAT_ABBREV

      static final int DT_LEAP_MONTH_PATTERN_FORMAT_ABBREV
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_FORMAT_NARROW

      static final int DT_LEAP_MONTH_PATTERN_FORMAT_NARROW
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_STANDALONE_WIDE

      static final int DT_LEAP_MONTH_PATTERN_STANDALONE_WIDE
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_STANDALONE_ABBREV

      static final int DT_LEAP_MONTH_PATTERN_STANDALONE_ABBREV
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_STANDALONE_NARROW

      static final int DT_LEAP_MONTH_PATTERN_STANDALONE_NARROW
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_LEAP_MONTH_PATTERN_NUMERIC

      static final int DT_LEAP_MONTH_PATTERN_NUMERIC
      Somewhat temporary constant for leap month pattern type, adequate for Chinese calendar.
      See Also:
    • DT_MONTH_PATTERN_COUNT

      static final int DT_MONTH_PATTERN_COUNT
      Somewhat temporary constant for month pattern count, adequate for Chinese calendar.
      See Also:
    • DEFAULT_TIME_SEPARATOR

      static final String DEFAULT_TIME_SEPARATOR
      This default time separator is used for formatting when the locale doesn't specify any time separator, and always recognized when parsing.
      See Also:
    • ALTERNATE_TIME_SEPARATOR

      static final String ALTERNATE_TIME_SEPARATOR
      This alternate time separator is always recognized when parsing.
      See Also:
    • eras

      String[] eras
      Era strings. For example: "AD" and "BC". An array of 2 strings, indexed by Calendar.BC and Calendar.AD.
    • eraNames

      String[] eraNames
      Era name strings. For example: "Anno Domini" and "Before Christ". An array of 2 strings, indexed by Calendar.BC and Calendar.AD.
    • narrowEras

      String[] narrowEras
      Narrow era names. For example: "A" and "B". An array of 2 strings, indexed by Calendar.BC and Calendar.AD.
    • months

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

      String[] shortMonths
      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.
    • narrowMonths

      String[] narrowMonths
      Narrow month strings. For example: "J", "F", etc. An array of 13 strings (some calendars have 13 months), indexed by Calendar.JANUARY, Calendar.FEBRUARY, etc.
    • standaloneMonths

      String[] standaloneMonths
      Standalone month strings. For example: "January", "February", etc. An array of 13 strings (some calendars have 13 months), indexed by Calendar.JANUARY, Calendar.FEBRUARY, etc.
    • standaloneShortMonths

      String[] standaloneShortMonths
      Standalone 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.
    • standaloneNarrowMonths

      String[] standaloneNarrowMonths
      Standalone narrow month strings. For example: "J", "F", etc. An array of 13 strings (some calendars have 13 months), indexed by Calendar.JANUARY, Calendar.FEBRUARY, etc.
    • weekdays

      String[] weekdays
      Format wide 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.
    • shortWeekdays

      String[] shortWeekdays
      CLDR-style format abbreviated (not 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.
    • shorterWeekdays

      String[] shorterWeekdays
      CLDR-style format short weekday strings, for example: "Su", "Mo", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element shorterWeekdays[0] is ignored.
    • narrowWeekdays

      String[] narrowWeekdays
      CLDR-style format narrow weekday strings, for example: "S", "M", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element narrowWeekdays[0] is ignored.
    • standaloneWeekdays

      String[] standaloneWeekdays
      Standalone wide weekday strings. For example: "Sunday", "Monday", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element standaloneWeekdays[0] is ignored.
    • standaloneShortWeekdays

      String[] standaloneShortWeekdays
      CLDR-style standalone abbreviated (not short) weekday strings, for example: "Sun", "Mon", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element standaloneShortWeekdays[0] is ignored.
    • standaloneShorterWeekdays

      String[] standaloneShorterWeekdays
      CLDR-style standalone short weekday strings, for example: "Sun", "Mon", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element standaloneShorterWeekdays[0] is ignored.
    • standaloneNarrowWeekdays

      String[] standaloneNarrowWeekdays
      Standalone narrow weekday strings. For example: "S", "M", etc. An array of 8 strings, indexed by Calendar.SUNDAY, Calendar.MONDAY, etc. The element standaloneNarrowWeekdays[0] is ignored.
    • ampms

      String[] ampms
      AM and PM strings. For example: "AM" and "PM". An array of 2 strings, indexed by Calendar.AM and Calendar.PM.
    • ampmsNarrow

      String[] ampmsNarrow
      narrow AM and PM strings. For example: "a" and "p". An array of 2 strings, indexed by Calendar.AM and Calendar.PM.
    • timeSeparator

      private String timeSeparator
      Time separator string. For example: ":".
    • shortQuarters

      String[] shortQuarters
      Abbreviated quarter names. For example: "Q1", "Q2", "Q3", "Q4". An array of 4 strings indexed by the month divided by 3.
    • narrowQuarters

      String[] narrowQuarters
      Narrow quarter names. For example: "1", "2", "3", "4". An array of 4 strings indexed by the month divided by 3.
    • quarters

      String[] quarters
      Full quarter names. For example: "1st Quarter", "2nd Quarter", "3rd Quarter", "4th Quarter". An array of 4 strings, indexed by the month divided by 3.
    • standaloneShortQuarters

      String[] standaloneShortQuarters
      Standalone abbreviated quarter names. For example: "Q1", "Q2", "Q3", "Q4". An array of 4 strings indexed by the month divided by 3.
    • standaloneNarrowQuarters

      String[] standaloneNarrowQuarters
      Standalone narrow quarter names. For example: "1", "2", "3", "4". An array of 4 strings indexed by the month divided by 3.
    • standaloneQuarters

      String[] standaloneQuarters
      Standalone full quarter names. For example: "1st Quarter", "2nd Quarter", "3rd Quarter", "4th Quarter". An array of 4 strings, indexed by the month divided by 3.
    • leapMonthPatterns

      String[] leapMonthPatterns
      All leap month patterns, for example "{0}bis". An array of DT_MONTH_PATTERN_COUNT strings, indexed by the DT_LEAP_MONTH_PATTERN_XXX value.
    • shortYearNames

      String[] shortYearNames
      Cyclic year names, for example: "jia-zi", "yi-chou", ... "gui-hai". An array of (normally) 60 strings, corresponding to cyclic years 1-60 (in Calendar YEAR field). Currently we only have data for format/abbreviated. For the others, just get from format/abbreviated, ignore set.
    • shortZodiacNames

      String[] shortZodiacNames
      Cyclic zodiac names, for example: "Rat", "Ox", "Tiger", etc. An array of (normally) 12 strings. Currently we only have data for format/abbreviated. For the others, just get from format/abbreviated, ignore set.
    • zoneStrings

      private String[][] zoneStrings
      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 and up to 7. 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 savings time
      • zoneStrings[i][4] - short name of zone in daylight savings time
      • zoneStrings[i][5] - location name of zone
      • zoneStrings[i][6] - long generic name of zone
      • zoneStrings[i][7] - short generic of zone
      The zone ID is not localized; it corresponds to the ID value associated with a system time zone object. All other entries are localized names. If a zone does not implement daylight savings time, the daylight savings time names are ignored. Note:CLDR 1.5 introduced metazone and its historical mappings. This simple two-dimensional array is no longer sufficient to represent localized names and its historic changes. Since ICU 3.8.1, localized zone names extracted from ICU locale data is stored in a ZoneStringFormat instance. But we still need to support the old way of customizing localized zone names, so we keep this field for the purpose.
      See Also:
    • patternChars

      static final String patternChars
      Unlocalized date-time pattern characters. For example: 'y', 'd', etc. All locales use the same unlocalized pattern characters.
      See Also:
    • localPatternChars

      String localPatternChars
      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.
    • abbreviatedDayPeriods

      String[] abbreviatedDayPeriods
      Localized names for abbreviated (== short) day periods. An array of strings, in the order of DayPeriod constants.
    • wideDayPeriods

      String[] wideDayPeriods
      Localized names for wide day periods. An array of strings, in the order of DayPeriod constants.
    • narrowDayPeriods

      String[] narrowDayPeriods
      Localized names for narrow day periods. An array of strings, in the order of DayPeriod constants.
    • standaloneAbbreviatedDayPeriods

      String[] standaloneAbbreviatedDayPeriods
      Localized names for standalone abbreviated (== short) day periods. An array of strings, in the order of DayPeriod constants.
    • standaloneWideDayPeriods

      String[] standaloneWideDayPeriods
      Localized names for standalone wide day periods. An array of strings, in the order of DayPeriod constants.
    • standaloneNarrowDayPeriods

      String[] standaloneNarrowDayPeriods
      Localized names for standalone narrow day periods. An array of strings, in the order of DayPeriod constants.
    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • CALENDAR_CLASSES

      private static final String[][] CALENDAR_CLASSES
    • contextUsageTypeMap

      private static final Map<String,DateFormatSymbols.CapitalizationContextUsage> contextUsageTypeMap
      Map from resource key to CapitalizationContextUsage value
    • capitalization

      Capitalization transforms. For each usage type, the first array element indicates whether to titlecase for uiListOrMenu context, the second indicates whether to titlecase for stand-alone context.
    • millisPerHour

      static final int millisPerHour
      Useful constant for defining timezone offsets.
      See Also:
    • DFSCACHE

      private static CacheBase<String,DateFormatSymbols,ULocale> DFSCACHE
    • LEAP_MONTH_PATTERNS_PATHS

      private static final String[] LEAP_MONTH_PATTERNS_PATHS
      Resource bundle paths for each leap month pattern
    • DAY_PERIOD_KEYS

      private static final String[] DAY_PERIOD_KEYS
      Keys for dayPeriods
    • requestedLocale

      private ULocale requestedLocale
    • validLocale

      private ULocale validLocale
      The most specific locale containing any resource data, or null.
      See Also:
    • actualLocale

      private ULocale actualLocale
      The locale containing data used to construct this object, or null.
      See Also:
  • Constructor Details

    • DateFormatSymbols

      public DateFormatSymbols()
      Constructs a DateFormatSymbols object by loading format data from resources for the default FORMAT locale.
      Throws:
      MissingResourceException - if the resources for the default locale cannot be found or cannot be loaded.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(Locale locale)
      Constructs a DateFormatSymbols object by loading format data from resources for the given locale.
      Throws:
      MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.
    • DateFormatSymbols

      public DateFormatSymbols(ULocale locale)
      Constructs a DateFormatSymbols object by loading format data from resources for the given ulocale.
      Throws:
      MissingResourceException - if the resources for the specified locale cannot be found or cannot be loaded.
    • DateFormatSymbols

      private DateFormatSymbols(ULocale desiredLocale, ICUResourceBundle b, String calendarType)
      Private, for cache.getInstance().
    • DateFormatSymbols

      public DateFormatSymbols(Calendar cal, Locale locale)
      Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.
      Parameters:
      cal - The calendar system whose date format symbols are desired.
      locale - The locale whose symbols are desired.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(Calendar cal, ULocale locale)
      Returns the DateFormatSymbols object that should be used to format a calendar system's dates in the given locale.
      Parameters:
      cal - The calendar system whose date format symbols are desired.
      locale - The ulocale whose symbols are desired.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(Class<? extends Calendar> calendarClass, Locale locale)
      Variant of DateFormatSymbols(Calendar, Locale) that takes the Calendar class instead of a Calendar instance.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(Class<? extends Calendar> calendarClass, ULocale locale)
      Variant of DateFormatSymbols(Calendar, ULocale) that takes the Calendar class instead of a Calendar instance.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(ResourceBundle bundle, Locale locale)
      Fetches a custom calendar's DateFormatSymbols out of the given resource bundle. Symbols that are not overridden are inherited from the default DateFormatSymbols for the locale.
      See Also:
    • DateFormatSymbols

      public DateFormatSymbols(ResourceBundle bundle, ULocale locale)
      Fetches a custom calendar's DateFormatSymbols out of the given resource bundle. Symbols that are not overridden are inherited from the default DateFormatSymbols for the locale.
      See Also:
  • Method Details

    • getInstance

      public static DateFormatSymbols getInstance()
      Returns a DateFormatSymbols instance for the default locale. Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.
      Returns:
      A DateFormatSymbols instance.
    • getInstance

      public static DateFormatSymbols getInstance(Locale locale)
      Returns a DateFormatSymbols instance for the given locale. Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.
      Parameters:
      locale - the locale.
      Returns:
      A DateFormatSymbols instance.
    • getInstance

      public static DateFormatSymbols getInstance(ULocale locale)
      Returns a DateFormatSymbols instance for the given locale. Unlike java.text.DateFormatSymbols#getInstance, this method simply returns new com.ibm.icu.text.DateFormatSymbols(locale). ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.
      Parameters:
      locale - the locale.
      Returns:
      A DateFormatSymbols instance.
    • getAvailableLocales

      public static Locale[] getAvailableLocales()
      Returns an array of all locales for which the getInstance methods of this class can return localized instances. Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of Locales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.
      Returns:
      An array of Locales for which localized DateFormatSymbols instances are available.
    • getAvailableULocales

      public static ULocale[] getAvailableULocales()
      Returns an array of all locales for which the getInstance methods of this class can return localized instances. Unlike java.text.DateFormatSymbols#getAvailableLocales, this method simply returns the array of ULocales available in this class. ICU does not support DateFormatSymbolsProvider introduced in Java 6 or its equivalent implementation for now.
      Returns:
      An array of ULocales for which localized DateFormatSymbols instances are available.
    • getEras

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

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

      public String[] getEraNames()
      Returns full era name strings. For example: "Anno Domini" and "Before Christ".
      Returns:
      the era strings.
    • setEraNames

      public void setEraNames(String[] newEraNames)
      Sets full era name strings. For example: "Anno Domini" and "Before Christ".
      Parameters:
      newEraNames - the new era strings.
    • getNarrowEras

      public String[] getNarrowEras()
      Returns narrow era name strings. For example: "A" and "B".
      Returns:
      the narrow era strings.
    • setNarrowEras

      public void setNarrowEras(String[] newNarrowEras)
      Sets narrow era name strings. For example: "A" and "B".
      Parameters:
      newNarrowEras - the new narrow era strings.
    • getMonths

      public String[] getMonths()
      Returns month strings. For example: "January", "February", etc.
      Returns:
      the month strings.
    • getMonths

      public String[] getMonths(int context, int width)
      Returns month strings. For example: "January", "February", etc.
      Parameters:
      context - The month context, FORMAT or STANDALONE.
      width - The width or the returned month string, either WIDE, ABBREVIATED, or NARROW.
      Returns:
      the month strings.
    • setMonths

      public void setMonths(String[] newMonths)
      Sets month strings. For example: "January", "February", etc.
      Parameters:
      newMonths - the new month strings.
    • setMonths

      public void setMonths(String[] newMonths, int context, int width)
      Sets month strings. For example: "January", "February", etc.
      Parameters:
      newMonths - the new month strings.
      context - The formatting context, FORMAT or STANDALONE.
      width - The width of the month string, either WIDE, ABBREVIATED, or NARROW.
    • getShortMonths

      public String[] getShortMonths()
      Returns short month strings. For example: "Jan", "Feb", etc.
      Returns:
      the short month strings.
    • setShortMonths

      public void setShortMonths(String[] newShortMonths)
      Sets short month strings. For example: "Jan", "Feb", etc.
      Parameters:
      newShortMonths - the new short month strings.
    • getWeekdays

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

      public String[] getWeekdays(int context, int width)
      Returns weekday strings. For example: "Sunday", "Monday", etc.
      Parameters:
      context - Formatting context, either FORMAT or STANDALONE.
      width - Width of strings to be returned, either WIDE, ABBREVIATED, SHORT, or NARROW
      Returns:
      the weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.
    • setWeekdays

      public void setWeekdays(String[] newWeekdays, int context, int width)
      Sets weekday strings. For example: "Sunday", "Monday", etc.
      Parameters:
      newWeekdays - The new weekday strings.
      context - The formatting context, FORMAT or STANDALONE.
      width - The width of the strings, either WIDE, ABBREVIATED, SHORT, or NARROW.
    • setWeekdays

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

      public String[] getShortWeekdays()
      Returns abbreviated weekday strings; for example: "Sun", "Mon", etc. (Note: the method name is misleading; it does not get the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)
      Returns:
      the abbreviated weekday strings. Use Calendar.SUNDAY, Calendar.MONDAY, etc. to index the result array.
    • setShortWeekdays

      public void setShortWeekdays(String[] newAbbrevWeekdays)
      Sets abbreviated weekday strings; for example: "Sun", "Mon", etc. (Note: the method name is misleading; it does not set the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)
      Parameters:
      newAbbrevWeekdays - the new abbreviated weekday strings. The array should be indexed by Calendar.SUNDAY, Calendar.MONDAY, etc.
    • getQuarters

      public String[] getQuarters(int context, int width)
      Returns quarter strings. For example: "1st Quarter", "2nd Quarter", etc.
      Parameters:
      context - The quarter context, FORMAT or STANDALONE.
      width - The width or the returned quarter string, WIDE, NARROW, or ABBREVIATED.
      Returns:
      the quarter strings.
    • setQuarters

      public void setQuarters(String[] newQuarters, int context, int width)
      Sets quarter strings. For example: "1st Quarter", "2nd Quarter", etc.
      Parameters:
      newQuarters - the new quarter strings.
      context - The formatting context, FORMAT or STANDALONE.
      width - The width of the quarter string, WIDE, NARROW, or ABBREVIATED.
    • getYearNames

      public String[] getYearNames(int context, int width)
      Returns cyclic year name strings if the calendar has them, for example: "jia-zi", "yi-chou", etc.
      Parameters:
      context - The usage context: FORMAT, STANDALONE.
      width - The requested name width: WIDE, ABBREVIATED, SHORT, NARROW.
      Returns:
      The year name strings, or null if they are not available for this calendar.
    • setYearNames

      public void setYearNames(String[] yearNames, int context, int width)
      Sets cyclic year name strings, for example: "jia-zi", "yi-chou", etc.
      Parameters:
      yearNames - The new cyclic year name strings.
      context - The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
      width - The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
    • getZodiacNames

      public String[] getZodiacNames(int context, int width)
      Returns calendar zodiac name strings if the calendar has them, for example: "Rat", "Ox", "Tiger", etc.
      Parameters:
      context - The usage context: FORMAT, STANDALONE.
      width - The requested name width: WIDE, ABBREVIATED, SHORT, NARROW.
      Returns:
      The zodiac name strings, or null if they are not available for this calendar.
    • setZodiacNames

      public void setZodiacNames(String[] zodiacNames, int context, int width)
      Sets calendar zodiac name strings, for example: "Rat", "Ox", "Tiger", etc.
      Parameters:
      zodiacNames - The new zodiac name strings.
      context - The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
      width - The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
    • getLeapMonthPattern

      @Deprecated public String getLeapMonthPattern(int context, int width)
      Deprecated.
      This API is ICU internal only.
      Returns the appropriate leapMonthPattern if the calendar has them, for example: "{0}bis"
      Parameters:
      context - The usage context: FORMAT, STANDALONE, NUMERIC.
      width - The requested pattern width: WIDE, ABBREVIATED, SHORT, NARROW.
      Returns:
      The leapMonthPattern, or null if not available for this calendar.
    • setLeapMonthPattern

      @Deprecated public void setLeapMonthPattern(String leapMonthPattern, int context, int width)
      Deprecated.
      This API is ICU internal only.
      Sets a leapMonthPattern, for example: "{0}bis"
      Parameters:
      leapMonthPattern - The new leapMonthPattern.
      context - The usage context: FORMAT, STANDALONE, NUMERIC.
      width - The name width: WIDE, ABBREVIATED, NARROW.
    • getAmPmStrings

      public String[] getAmPmStrings()
      Returns am/pm strings. For example: "AM" and "PM".
      Returns:
      the weekday strings.
    • setAmPmStrings

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

      @Deprecated public String getTimeSeparatorString()
      Deprecated.
      This API is ICU internal only.
      Returns the time separator string. For example: ":".
      Returns:
      the time separator string.
    • setTimeSeparatorString

      @Deprecated public void setTimeSeparatorString(String newTimeSeparator)
      Deprecated.
      This API is ICU internal only.
      Sets the time separator string. For example: ":".
      Parameters:
      newTimeSeparator - the new time separator string.
    • getZoneStrings

      public String[][] getZoneStrings()
      Returns time zone strings.

      The array returned by this API is a two dimensional String array and each row contains at least following strings:

      • ZoneStrings[n][0] - System time zone ID
      • ZoneStrings[n][1] - Long standard time display name
      • ZoneStrings[n][2] - Short standard time display name
      • ZoneStrings[n][3] - Long daylight saving time display name
      • ZoneStrings[n][4] - Short daylight saving time display name
      When a localized display name is not available, the corresponding array element will be null.

      Note: ICU implements the time zone display name formatting algorithm specified by UTS#35 Unicode Locale Data Markup Language(LDML). The algorithm supports historic display name changes and various different types of names not available in DateFormatSymbols.getZoneStrings(). For accessing the full set of time zone string data used by ICU implementation, you should use TimeZoneNames APIs instead.

      Returns:
      the time zone strings.
    • setZoneStrings

      public void setZoneStrings(String[][] newZoneStrings)
      Sets time zone strings.

      Note: SimpleDateFormat no longer uses the zone strings stored in a DateFormatSymbols. Therefore, the time zone strings set by this method have no effects in an instance of SimpleDateFormat for formatting time zones. If you want to customize time zone display names formatted by SimpleDateFormat, you should customize TimeZoneFormat and set the instance by SimpleDateFormat.setTimeZoneFormat(TimeZoneFormat) instead.

      Parameters:
      newZoneStrings - the new time zone strings.
    • getLocalPatternChars

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

      Note: ICU no longer provides localized date-time pattern characters for a locale starting ICU 3.8. This method returns the non-localized date-time pattern characters unless user defined localized data is set by setLocalPatternChars.

      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 clone.
      Overrides:
      clone in class Object
    • hashCode

      public int hashCode()
      Override hashCode. Generates a hash code for the DateFormatSymbols object.
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides equals.
      Overrides:
      equals in class Object
    • initializeData

      protected void initializeData(ULocale desiredLocale, String type)
      Initializes format symbols for the locale and calendar type
      Parameters:
      desiredLocale - The locale whose symbols are desired.
      type - The calendar type whose date format symbols are desired.
    • initializeData

      void initializeData(DateFormatSymbols dfs)
      Initializes format symbols using another instance. TODO Clean up initialization methods for subclasses
    • initializeData

      @Deprecated protected void initializeData(ULocale desiredLocale, ICUResourceBundle b, String calendarType)
      Deprecated.
      This API is ICU internal only.
      Initializes format symbols for the locale and calendar type
      Parameters:
      desiredLocale - The locale whose symbols are desired.
      b - Resource bundle provided externally
      calendarType - The calendar type being used
    • arrayOfArrayEquals

      private static final boolean arrayOfArrayEquals(Object[][] aa1, Object[][] aa2)
    • loadDayPeriodStrings

      private String[] loadDayPeriodStrings(Map<String,String> resourceMap, String[] copyFrom)
      Loads localized names for day periods in the requested format.
      Parameters:
      resourceMap - Contains the dayPeriod resource to load
      copyFrom - If non-null, any values in the result that would otherwise be null are copied from this array
    • duplicate

      private final String[] duplicate(String[] srcArray)
    • duplicate

      private final String[][] duplicate(String[][] srcArray)
    • getDateFormatBundle

      @Deprecated public static ResourceBundle getDateFormatBundle(Class<? extends Calendar> calendarClass, Locale locale) throws MissingResourceException
      Deprecated.
      ICU 4.0
      Finds the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.

      The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

      Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

      Throws:
      MissingResourceException
    • getDateFormatBundle

      @Deprecated public static ResourceBundle getDateFormatBundle(Class<? extends Calendar> calendarClass, ULocale locale) throws MissingResourceException
      Deprecated.
      ICU 4.0
      Finds the ResourceBundle containing the date format information for a specified calendar subclass in a given locale.

      The resource bundle name is based on the calendar's fully-specified class name, with ".resources" inserted at the end of the package name (just before the class name) and "Symbols" appended to the end. For example, the bundle corresponding to "com.ibm.icu.util.HebrewCalendar" is "com.ibm.icu.impl.data.HebrewCalendarSymbols".

      Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

      Throws:
      MissingResourceException
    • getDateFormatBundle

      @Deprecated public static ResourceBundle getDateFormatBundle(Calendar cal, Locale locale) throws MissingResourceException
      Deprecated.
      ICU 4.0
      Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

      Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

      Throws:
      MissingResourceException
      See Also:
    • getDateFormatBundle

      @Deprecated public static ResourceBundle getDateFormatBundle(Calendar cal, ULocale locale) throws MissingResourceException
      Deprecated.
      ICU 4.0
      Variant of getDateFormatBundle(java.lang.Class, java.util.Locale) that takes a Calendar instance instead of a Calendar class.

      Note:Because of the structural changes in the ICU locale bundle, this API no longer works as described. This method always returns null.

      Throws:
      MissingResourceException
      See Also:
    • getLocale

      public final ULocale getLocale(ULocale.Type type)
      Returns the locale that was used to create this object, or null. This may may differ from the locale requested at the time of this object's creation. For example, if an object is created for locale en_US_CALIFORNIA, the actual data may be drawn from en (the actual locale), and en_US may be the most specific locale that exists (the valid locale).

      Note: This method will be implemented in ICU 3.0; ICU 2.8 contains a partial preview implementation. The actual locale is returned correctly, but the valid locale is not, in most cases.

      Parameters:
      type - type of information requested, either ULocale.VALID_LOCALE or ULocale.ACTUAL_LOCALE.
      Returns:
      the information specified by type, or null if this object was not constructed from locale data.
      See Also:
    • setLocale

      final void setLocale(ULocale valid, ULocale actual)
      Sets information about the locales that were used to create this object. If the object was not constructed from locale data, both arguments should be set to null. Otherwise, neither should be null. The actual locale must be at the same level or less specific than the valid locale. This method is intended for use by factories or other entities that create objects of this class.
      Parameters:
      valid - the most specific locale containing any resource data, or null
      actual - the locale containing data used to construct this object, or null
      See Also:
    • readObject

      private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException
      3.8 or older version did not have localized GMT format patterns.
      Throws:
      IOException
      ClassNotFoundException