SimpleDateFormat

Kotlin |Java

open class SimpleDateFormat : DateFormat

kotlin.Any
↳	java.text.Format
	↳	android.icu.text.UFormat
		↳	android.icu.text.DateFormat
			↳	android.icu.text.SimpleDateFormat

[icu enhancement] ICU's replacement for java.text.SimpleDateFormat. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.

SimpleDateFormat is a concrete class for formatting and parsing dates in a locale-sensitive manner. It allows for formatting (date -> text), parsing (text -> date), and normalization.

Clients are encouraged to create a date-time formatter using DateFormat.getDateInstance(), DateFormat.getDateInstance(), or DateFormat.getDateTimeInstance() rather than explicitly constructing an instance of SimpleDateFormat. This way, the client is guaranteed to get an appropriate formatting pattern for whatever locale the program is running in. If the client needs more control, they should consider using DateFormat.getInstanceForSkeleton(). However, if the client needs something more unusual than the default patterns in the locales, he can construct a SimpleDateFormat directly and give it an appropriate pattern (or use one of the factory methods on DateFormat and modify the pattern after the fact with toPattern() and applyPattern(). For more information on using these methods, see DateFormat.

Date and Time Patterns:

Date and time formats are specified by date and time pattern strings. The full syntax for date and time patterns can be found at https://unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns.

Within date and time pattern strings, all unquoted ASCII letters [A-Za-z] are reserved as pattern letters representing calendar fields. Some of the most commonly used pattern letters are:

Sym.

No.

Example

Description

1..3

Era - Replaced with the Era string for the current date. One to three letters for the abbreviated form, four letters for the long (wide) form, five for the narrow form.

1..n

1996

Year. Normally the length specifies the padding, but for two letters it also specifies the maximum length. Example:

Year	y	yy	yyy	yyyy	yyyyy
AD 1	1	01	001	0001	00001
AD 12	12	12	012	0012	00012
AD 123	123	23	123	0123	00123
AD 1234	1234	34	1234	1234	01234
AD 12345	12345	45	12345	12345	12345

1..2

Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four for the full (wide) name (five for the narrow name is not yet supported).

2nd quarter

1..2

Month - Use one or two for the numerical month, three for the abbreviation, four for the full (wide) name, or five for the narrow name. With two ("MM"), the month number is zero-padded if necessary (e.g. "08").

Sep

September

1..2

Date - Day of the month. Use "d" to show the minimum number of digits, or "dd" to always show two digits (zero-padding if necessary, e.g. "08").

1..3

Tue

Day of week - Use one through three letters for the short day, four for the full (wide) name, five for the narrow name, or six for the short name.

Tuesday

AM or PM

1..2

Hour [1-12]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern generation, it should match the 12-hour-cycle format preferred by the locale (h or K); it should not match a 24-hour-cycle format (H or k). Use hh for zero padding.

1..2

Hour [0-23]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern generation, it should match the 24-hour-cycle format preferred by the locale (H or k); it should not match a 12-hour-cycle format (h or K). Use HH for zero padding.

1..2

Minute. Use "m" to show the minimum number of digits, or "mm" to always show two digits (zero-padding if necessary, e.g. "08")..

1..2

Second. Use "s" to show the minimum number of digits, or "ss" to always show two digits (zero-padding if necessary, e.g. "08").

1..3

PDT

Time zone. The short specific non-location format. Where that is unavailable, falls back to the short localized GMT format ("O").

Pacific Daylight Time

The long specific non-location format. Where that is unavailable, falls back to the long localized GMT format ("OOOO").

Time zone. The short generic non-location format. Where that is unavailable, falls back to the generic location format ("VVVV"), then the short localized GMT format as the final fallback.

Pacific Time

The long generic non-location format. Where that is unavailable, falls back to generic location format ("VVVV").

Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like ':', '.', ' ', '#' and '@' will appear in the resulting time text even they are not embraced within single quotes.

A pattern containing any invalid pattern letter will result in a thrown exception during formatting or parsing.

Examples Using the US Locale:

Format Pattern                         Result
  --------------                         -------
  "yyyy.MM.dd G 'at' HH:mm:ss vvvv" ->>  1996.07.10 AD at 15:08:56 Pacific Time
  "EEE, MMM d, ''yy"                ->>  Wed, July 10, '96
  "h:mm a"                          ->>  12:08 PM
  "hh 'o''clock' a, zzzz"           ->>  12 o'clock PM, Pacific Daylight Time
  "K:mm a, vvv"                     ->>  0:00 PM, PT
  "yyyyy.MMMMM.dd GGG hh:mm aaa"    ->>  01996.July.10 AD 12:08 PM

Code Sample:

SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, "PST");
  pdt.setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2*60*60*1000);
  pdt.setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2*60*60*1000);
  <br>// Format the current time.
  SimpleDateFormat formatter
      = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz");
  Date currentTime_1 = new Date();
  String dateString = formatter.format(currentTime_1);
  <br>// Parse the previous string back into a Date.
  ParsePosition pos = new ParsePosition(0);
  Date currentTime_2 = formatter.parse(dateString, pos);

In the example, the time value currentTime_2 obtained from parsing will be equal to currentTime_1. However, they may not be equal if the am/pm marker 'a' is left out from the format pattern while the "hour in am/pm" pattern symbol is used. This information loss can happen when formatting the time in PM.

When parsing a date string using the abbreviated year pattern ("yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, as defined by android.icu.lang.UCharacter#isDigit(int), will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isn't all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.

If the year pattern does not have exactly two 'y' characters, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.

When numeric fields abut one another directly, with no intervening delimiter characters, they constitute a run of abutting numeric fields. Such runs are parsed specially. For example, the format "HHmmss" parses the input text "123456" to 12:34:56, parses the input text "12345" to 1:23:45, and fails to parse "1234". In other words, the leftmost field of the run is flexible, while the others keep a fixed width. If the parse fails anywhere in the run, then the leftmost field is shortened by one character, and the entire run is parsed again. This is repeated until either the parse succeeds or the leftmost field is one character in length. If the parse still fails at that point, the parse of the run fails.

For time zones that have no names, use strings GMT+hours:minutes or GMT-hours:minutes.

The calendar defines what is the first day of the week, the first week of the year, whether hours are zero based or not (0 vs 12 or 24), and the time zone. There is one common decimal format to handle all the numbers; the digit count is handled programmatically according to the pattern.

Synchronization

Date formats are not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.

Summary

Inherited constants

From class DateFormat

`String`	`ABBR_GENERIC_TZ` [icu] Constant for generic non-location format, abbreviated if possible, such as PT; used in combinations date + time + zone, or time + zone.
`String`	`ABBR_MONTH` [icu] Constant for date skeleton with abbreviated month.
`String`	`ABBR_MONTH_DAY` [icu] Constant for date skeleton with abbreviated month and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`ABBR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`ABBR_QUARTER` [icu] Constant for date skeleton with abbreviated quarter.
`String`	`ABBR_SPECIFIC_TZ` [icu] Constant for specific non-location format, abbreviated if possible, such as PDT; used in combinations date + time + zone, or time + zone.
`String`	`ABBR_UTC_TZ` [icu] Constant for localized GMT/UTC format, such as GMT+8:00 or HPG-8:00; used in combinations date + time + zone, or time + zone.
`String`	`ABBR_WEEKDAY` [icu] Constant for date skeleton with abbreviated weekday.
`Int`	`AM_PM_FIELD` FieldPosition selector for 'a' field alignment, corresponding to the `Calendar.AM_PM` field.
`Int`	`AM_PM_MIDNIGHT_NOON_FIELD` [icu] FieldPosition selector for 'b' field alignment. No related Calendar field. This displays the fixed day period (am/pm/midnight/noon).
`Int`	`DATE_FIELD` FieldPosition selector for 'd' field alignment, corresponding to the `Calendar.DATE` field.
`String`	`DAY` [icu] Constant for date skeleton with day.
`Int`	`DAY_OF_WEEK_FIELD` FieldPosition selector for 'E' field alignment, corresponding to the `Calendar.DAY_OF_WEEK` field.
`Int`	`DAY_OF_WEEK_IN_MONTH_FIELD` FieldPosition selector for 'F' field alignment, corresponding to the `Calendar.DAY_OF_WEEK_IN_MONTH` field.
`Int`	`DAY_OF_YEAR_FIELD` FieldPosition selector for 'D' field alignment, corresponding to the `Calendar.DAY_OF_YEAR` field.
`Int`	`DEFAULT` Constant for default style pattern. Its value is MEDIUM.
`Int`	`DOW_LOCAL_FIELD` [icu] FieldPosition selector for 'e' field alignment, corresponding to the `Calendar.DOW_LOCAL` field.
`Int`	`ERA_FIELD` FieldPosition selector for 'G' field alignment, corresponding to the `Calendar.ERA` field.
`Int`	`EXTENDED_YEAR_FIELD` [icu] FieldPosition selector for 'u' field alignment, corresponding to the `Calendar.EXTENDED_YEAR` field.
`Int`	`FLEXIBLE_DAY_PERIOD_FIELD` [icu] FieldPosition selector for 'B' field alignment. No related Calendar field. This displays the flexible day period.
`Int`	`FRACTIONAL_SECOND_FIELD` [icu] FieldPosition selector for 'S' field alignment, corresponding to the `Calendar.MILLISECOND` field. Note: Time formats that use 'S' can display a maximum of three significant digits for fractional seconds, corresponding to millisecond resolution and a fractional seconds sub-pattern of SSS. If the sub-pattern is S or SS, the fractional seconds value will be truncated (not rounded) to the number of display places specified. If the fractional seconds sub-pattern is longer than SSS, the additional display places will be filled with zeros.
`Int`	`FULL` Constant for full style pattern.
`String`	`GENERIC_TZ` [icu] Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone.
`String`	`HOUR` [icu] Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24).
`Int`	`HOUR0_FIELD` FieldPosition selector for 'K' field alignment, corresponding to the `Calendar.HOUR` field. HOUR0_FIELD is used for the zero-based 12-hour clock. For example, 11:30 PM + 1 hour results in 00:30 AM.
`Int`	`HOUR1_FIELD` FieldPosition selector for 'h' field alignment, corresponding to the `Calendar.HOUR` field. HOUR1_FIELD is used for the one-based 12-hour clock. For example, 11:30 PM + 1 hour results in 12:30 AM.
`String`	`HOUR24` [icu] Constant for date skeleton with hour in 24-hour presentation.
`String`	`HOUR24_MINUTE` [icu] Constant for date skeleton with hour and minute in 24-hour presentation. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`HOUR24_MINUTE_SECOND` [icu] Constant for date skeleton with hour, minute, and second in 24-hour presentation. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`HOUR_MINUTE` [icu] Constant for date skeleton with hour and minute, with the locale's preferred hour format (12 or 24). Used in combinations date + time, date + time + zone, or time + zone.
`String`	`HOUR_MINUTE_SECOND` [icu] Constant for date skeleton with hour, minute, and second, with the locale's preferred hour format (12 or 24). Used in combinations date + time, date + time + zone, or time + zone.
`Int`	`HOUR_OF_DAY0_FIELD` FieldPosition selector for 'H' field alignment, corresponding to the `Calendar.HOUR_OF_DAY` field. HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock. For example, 23:59 + 01:00 results in 00:59.
`Int`	`HOUR_OF_DAY1_FIELD` FieldPosition selector for 'k' field alignment, corresponding to the `Calendar.HOUR_OF_DAY` field. HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock. For example, 23:59 + 01:00 results in 24:59.
`Int`	`JULIAN_DAY_FIELD` [icu] FieldPosition selector for 'g' field alignment, corresponding to the `Calendar.JULIAN_DAY` field.
`String`	`LOCATION_TZ` [icu] Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone.
`Int`	`LONG` Constant for long style pattern.
`Int`	`MEDIUM` Constant for medium style pattern.
`Int`	`MILLISECONDS_IN_DAY_FIELD` [icu] FieldPosition selector for 'A' field alignment, corresponding to the `Calendar.MILLISECONDS_IN_DAY` field.
`Int`	`MILLISECOND_FIELD` Alias for FRACTIONAL_SECOND_FIELD.
`String`	`MINUTE` [icu] Constant for date skeleton with minute.
`Int`	`MINUTE_FIELD` FieldPosition selector for 'm' field alignment, corresponding to the `Calendar.MINUTE` field.
`String`	`MINUTE_SECOND` [icu] Constant for date skeleton with minute and second. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`MONTH` [icu] Constant for date skeleton with month.
`String`	`MONTH_DAY` [icu] Constant for date skeleton with long month and day. Used in combinations date + time, date + time + zone, or time + zone.
`Int`	`MONTH_FIELD` FieldPosition selector for 'M' field alignment, corresponding to the `Calendar.MONTH` field.
`String`	`MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`Int`	`NONE` [icu] Constant for empty style pattern.
`String`	`NUM_MONTH` [icu] Constant for date skeleton with numeric month.
`String`	`NUM_MONTH_DAY` [icu] Constant for date skeleton with numeric month and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`NUM_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`QUARTER` [icu] Constant for date skeleton with quarter.
`Int`	`QUARTER_FIELD` [icu] FieldPosition selector for 'Q' field alignment, corresponding to the `Calendar.MONTH` field. This displays the quarter.
`Int`	`RELATIVE` [icu] Constant for relative style mask.
`Int`	`RELATIVE_DEFAULT` [icu] Constant for relative default style pattern.
`Int`	`RELATIVE_FULL` [icu] Constant for relative full style pattern.
`Int`	`RELATIVE_LONG` [icu] Constant for relative style pattern.
`Int`	`RELATIVE_MEDIUM` [icu] Constant for relative style pattern.
`Int`	`RELATIVE_SHORT` [icu] Constant for relative style pattern.
`String`	`SECOND` [icu] Constant for date skeleton with second.
`Int`	`SECOND_FIELD` FieldPosition selector for 's' field alignment, corresponding to the `Calendar.SECOND` field.
`Int`	`SHORT` Constant for short style pattern.
`String`	`SPECIFIC_TZ` [icu] Constant for specific non-location format, such as Pacific Daylight Time; used in combinations date + time + zone, or time + zone.
`Int`	`STANDALONE_DAY_FIELD` [icu] FieldPosition selector for 'c' field alignment, corresponding to the `Calendar.DAY_OF_WEEK` field. This displays the stand alone day name, if available.
`Int`	`STANDALONE_MONTH_FIELD` [icu] FieldPosition selector for 'L' field alignment, corresponding to the `Calendar.MONTH` field. This displays the stand alone month name, if available.
`Int`	`STANDALONE_QUARTER_FIELD` [icu] FieldPosition selector for 'q' field alignment, corresponding to the `Calendar.MONTH` field. This displays the stand alone quarter, if available.
`Int`	`TIMEZONE_FIELD` FieldPosition selector for 'z' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields.
`Int`	`TIMEZONE_GENERIC_FIELD` [icu] FieldPosition selector for 'v' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields. This displays the generic zone name, if available.
`Int`	`TIMEZONE_ISO_FIELD` [icu] FieldPosition selector for 'X' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields. This displays the ISO 8601 local time offset format or UTC indicator ("Z").
`Int`	`TIMEZONE_ISO_LOCAL_FIELD` [icu] FieldPosition selector for 'x' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields. This displays the ISO 8601 local time offset format.
`Int`	`TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD` [icu] FieldPosition selector for 'O' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields. This displays the localized GMT format.
`Int`	`TIMEZONE_RFC_FIELD` [icu] FieldPosition selector for 'Z' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields.
`Int`	`TIMEZONE_SPECIAL_FIELD` [icu] FieldPosition selector for 'V' field alignment, corresponding to the `Calendar.ZONE_OFFSET` and `Calendar.DST_OFFSET` fields. This displays the fallback timezone name when VVVV is specified, and the short standard or daylight timezone name ignoring commonlyUsed when a single V is specified.
`String`	`WEEKDAY` [icu] Constant for date skeleton with weekday.
`Int`	`WEEK_OF_MONTH_FIELD` FieldPosition selector for 'W' field alignment, corresponding to the `Calendar.WEEK_OF_MONTH` field.
`Int`	`WEEK_OF_YEAR_FIELD` FieldPosition selector for 'w' field alignment, corresponding to the `Calendar.WEEK_OF_YEAR` field.
`String`	`YEAR` [icu] Constant for date skeleton with year.
`String`	`YEAR_ABBR_MONTH` [icu] Constant for date skeleton with year and abbreviated month.
`String`	`YEAR_ABBR_MONTH_DAY` [icu] Constant for date skeleton with year, abbreviated month, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`YEAR_ABBR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`YEAR_ABBR_QUARTER` [icu] Constant for date skeleton with year and abbreviated quarter.
`Int`	`YEAR_FIELD` FieldPosition selector for 'y' field alignment, corresponding to the `Calendar.YEAR` field.
`String`	`YEAR_MONTH` [icu] Constant for date skeleton with year and month.
`String`	`YEAR_MONTH_DAY` [icu] Constant for date skeleton with year, month, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`YEAR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`Int`	`YEAR_NAME_FIELD` [icu] FieldPosition selector for 'U' field alignment, corresponding to the `Calendar.YEAR` field. This displays the cyclic year name, if available.
`String`	`YEAR_NUM_MONTH` [icu] Constant for date skeleton with year and numeric month.
`String`	`YEAR_NUM_MONTH_DAY` [icu] Constant for date skeleton with year, numeric month, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`YEAR_NUM_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.
`String`	`YEAR_QUARTER` [icu] Constant for date skeleton with year and quarter.
`Int`	`YEAR_WOY_FIELD` [icu] FieldPosition selector for 'Y' field alignment, corresponding to the `Calendar.YEAR_WOY` field.

Public constructors
`SimpleDateFormat()` Constructs a SimpleDateFormat using the default pattern for the default `FORMAT` locale.
`SimpleDateFormat(pattern: String!)` Constructs a SimpleDateFormat using the given pattern in the default `FORMAT` locale.
`SimpleDateFormat(pattern: String!, formatData: DateFormatSymbols!)` Constructs a SimpleDateFormat using the given pattern and locale-specific symbol data.
`SimpleDateFormat(pattern: String!, loc: ULocale!)` Constructs a SimpleDateFormat using the given pattern and locale.
`SimpleDateFormat(pattern: String!, override: String!, loc: ULocale!)` Constructs a SimpleDateFormat using the given pattern , override and locale.
`SimpleDateFormat(pattern: String!, loc: Locale!)` Constructs a SimpleDateFormat using the given pattern and locale.

Public methods
open Unit	`applyLocalizedPattern(pat: String!)` Apply the given localized pattern string to this date format.
open Unit	`applyPattern(pat: String!)` Apply the given unlocalized pattern string to this date format.
open Any	`clone()` Overrides Cloneable
open Boolean	`equals(other: Any?)` Override equals.
open StringBuffer!	`format(cal: Calendar!, toAppendTo: StringBuffer!, pos: FieldPosition!)` Formats a date or time, which is the standard millis since January 1, 1970, 00:00:00 GMT.
open AttributedCharacterIterator!	`formatToCharacterIterator(obj: Any!)` Format the object to an attributed string, and return the corresponding iterator Overrides superclass method.
open Date!	`get2DigitYearStart()` Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.
open DateFormatSymbols!	`getDateFormatSymbols()` Gets the date/time formatting data.
open NumberFormat!	`getNumberFormat(field: Char)` give the NumberFormat used for the field like 'y'(year) and 'M'(year)
open TimeZoneFormat!	`getTimeZoneFormat()` [icu] Gets the time zone formatter which this date/time formatter uses to format and parse a time zone.
open Int	`hashCode()` Override hashCode.
open Unit	`parse(text: String!, cal: Calendar!, parsePos: ParsePosition!)` Overrides DateFormat
open Unit	`set2DigitYearStart(startDate: Date!)` Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.
open Unit	`setContext(context: DisplayContext!)` [icu] Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.
open Unit	`setDateFormatSymbols(newFormatSymbols: DateFormatSymbols!)` Allows you to set the date/time formatting data.
open Unit	`setNumberFormat(newNumberFormat: NumberFormat!)` Overrides superclass method and This method also clears per field NumberFormat instances previously set by `setNumberFormat(java.lang.String,android.icu.text.NumberFormat)`
open Unit	`setNumberFormat(fields: String!, overrideNF: NumberFormat!)` allow the user to set the NumberFormat for several fields It can be a single field like: "y"(year) or "M"(month) It can be several field combined together: "yMd"(year, month and date) Note: 1 symbol field is enough for multiple symbol fields (so "y" will override "yy", "yyy") If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field)
open Unit	`setTimeZoneFormat(tzfmt: TimeZoneFormat!)` [icu] Allows you to set the time zone formatter.
open String!	`toLocalizedPattern()` Return a localized pattern string describing this date format.
open String!	`toPattern()` Return a pattern string describing this date format.

Protected methods
open DateFormatSymbols!	`getSymbols()` Method for subclasses to access the DateFormatSymbols.
open Int	`matchQuarterString(text: String!, start: Int, field: Int, data: Array<String!>!, cal: Calendar!)` Attempt to match the text at a given position against an array of quarter strings.
open Int	`matchString(text: String!, start: Int, field: Int, data: Array<String!>!, cal: Calendar!)` Attempt to match the text at a given position against an array of strings.
open DateFormat.Field!	`patternCharToDateFormatField(ch: Char)` Returns a DateFormat.
open String!	`subFormat(ch: Char, count: Int, beginOffset: Int, pos: FieldPosition!, fmtData: DateFormatSymbols!, cal: Calendar!)` Formats a single field, given its pattern character.
open Int	`subParse(text: String!, start: Int, ch: Char, count: Int, obeyCount: Boolean, allowNegative: Boolean, ambiguousYear: BooleanArray!, cal: Calendar!)` Protected method that converts one field of the input string into a numeric field value in `cal`.
open String!	`zeroPaddingNumber(value: Long, minDigits: Int, maxDigits: Int)` Formats a number with the specified minimum and maximum number of digits.

Inherited functions

From class DateFormat

`StringBuffer!`	`format(obj: Any!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!)` Formats a time object into a time string. Examples of time objects are a time value expressed in milliseconds and a Date object.
`String!`	`format(date: Date!)` Formats a Date into a date/time string.
`StringBuffer!`	`format(date: Date!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!)` Formats a Date into a date/time string.
`Array<Locale!>!`	`getAvailableLocales()` Returns the set of locales for which DateFormats are installed.
`Boolean`	`getBooleanAttribute(key: DateFormat.BooleanAttribute!)` Returns the current value for the specified BooleanAttribute for this instance if attribute is missing false is returned.
`Calendar!`	`getCalendar()` Returns the calendar associated with this date/time formatter.
`DisplayContext!`	`getContext(type: DisplayContext.Type!)` [icu] Get the formatter's DisplayContext value for the specified DisplayContext.Type, such as CAPITALIZATION.
`DateFormat!`	`getDateInstance()` Returns the date formatter with the default formatting style for the default `FORMAT` locale.
`DateFormat!`	`getDateInstance(cal: Calendar!, dateStyle: Int)` Creates a `DateFormat` object for the default locale that can be used to format dates in the calendar system specified by `cal`.
`DateFormat!`	`getDateInstance(cal: Calendar!, dateStyle: Int, locale: ULocale!)` Creates a `DateFormat` object that can be used to format dates in the calendar system specified by `cal`.
`DateFormat!`	`getDateInstance(cal: Calendar!, dateStyle: Int, locale: Locale!)` Creates a `DateFormat` object that can be used to format dates in the calendar system specified by `cal`.
`DateFormat!`	`getDateInstance(style: Int)` Returns the date formatter with the given formatting style for the default `FORMAT` locale.
`DateFormat!`	`getDateInstance(style: Int, locale: ULocale!)` Returns the date formatter with the given formatting style for the given locale.
`DateFormat!`	`getDateInstance(style: Int, aLocale: Locale!)` Returns the date formatter with the given formatting style for the given locale.
`DateFormat!`	`getDateTimeInstance()` Returns the date/time formatter with the default formatting style for the default `FORMAT` locale.
`DateFormat!`	`getDateTimeInstance(cal: Calendar!, dateStyle: Int, timeStyle: Int)` Creates a `DateFormat` object for the default locale that can be used to format dates and times in the calendar system specified by `cal`.
`DateFormat!`	`getDateTimeInstance(cal: Calendar!, dateStyle: Int, timeStyle: Int, locale: ULocale!)` Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`.
`DateFormat!`	`getDateTimeInstance(cal: Calendar!, dateStyle: Int, timeStyle: Int, locale: Locale!)` Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`.
`DateFormat!`	`getDateTimeInstance(dateStyle: Int, timeStyle: Int)` Returns the date/time formatter with the given date and time formatting styles for the default `FORMAT` locale.
`DateFormat!`	`getDateTimeInstance(dateStyle: Int, timeStyle: Int, locale: ULocale!)` Returns the date/time formatter with the given formatting styles for the given locale.
`DateFormat!`	`getDateTimeInstance(dateStyle: Int, timeStyle: Int, aLocale: Locale!)` Returns the date/time formatter with the given formatting styles for the given locale.
`DateFormat!`	`getInstance()` Returns a default date/time formatter that uses the SHORT style for both the date and the time.
`DateFormat!`	`getInstance(cal: Calendar!)` Returns a default date/time formatter that uses the SHORT style for both the date and the time.
`DateFormat!`	`getInstance(cal: Calendar!, locale: ULocale!)` Returns a date/time formatter that uses the SHORT style for both the date and the time.
`DateFormat!`	`getInstance(cal: Calendar!, locale: Locale!)` Returns a date/time formatter that uses the SHORT style for both the date and the time.
`DateFormat!`	`getInstanceForSkeleton(cal: Calendar!, skeleton: String!, locale: ULocale!)` [icu] Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`.
`DateFormat!`	`getInstanceForSkeleton(cal: Calendar!, skeleton: String!, locale: Locale!)` [icu] Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`.
`DateFormat!`	`getInstanceForSkeleton(skeleton: String!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the default locale.
`DateFormat!`	`getInstanceForSkeleton(skeleton: String!, locale: ULocale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
`DateFormat!`	`getInstanceForSkeleton(skeleton: String!, locale: Locale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
`NumberFormat!`	`getNumberFormat()` Returns the number formatter which this date/time formatter uses to format and parse a time.
`DateFormat!`	`getPatternInstance(cal: Calendar!, skeleton: String!, locale: ULocale!)` [icu] Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`. The getInstanceForSkeleton methods are preferred over the getPatternInstance methods.
`DateFormat!`	`getPatternInstance(cal: Calendar!, skeleton: String!, locale: Locale!)` [icu] Creates a `DateFormat` object that can be used to format dates and times in the calendar system specified by `cal`. The getInstanceForSkeleton methods are preferred over the getPatternInstance methods.
`DateFormat!`	`getPatternInstance(skeleton: String!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the default locale. The getInstanceForSkeleton methods are preferred over the getPatternInstance methods.
`DateFormat!`	`getPatternInstance(skeleton: String!, locale: ULocale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale. The getInstanceForSkeleton methods are preferred over the getPatternInstance methods.
`DateFormat!`	`getPatternInstance(skeleton: String!, locale: Locale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale. The getInstanceForSkeleton methods are preferred over the getPatternInstance methods.
`DateFormat!`	`getTimeInstance()` Gets the time formatter with the default formatting style for the default `FORMAT` locale.
`DateFormat!`	`getTimeInstance(cal: Calendar!, timeStyle: Int)` Creates a `DateFormat` object that can be used to format times in the calendar system specified by `cal`.
`DateFormat!`	`getTimeInstance(cal: Calendar!, timeStyle: Int, locale: ULocale!)` Creates a `DateFormat` object that can be used to format times in the calendar system specified by `cal`.
`DateFormat!`	`getTimeInstance(cal: Calendar!, timeStyle: Int, locale: Locale!)` Creates a `DateFormat` object that can be used to format times in the calendar system specified by `cal`.
`DateFormat!`	`getTimeInstance(style: Int)` Returns the time formatter with the given formatting style for the default `FORMAT` locale.
`DateFormat!`	`getTimeInstance(style: Int, locale: ULocale!)` Returns the time formatter with the given formatting style for the given locale.
`DateFormat!`	`getTimeInstance(style: Int, aLocale: Locale!)` Returns the time formatter with the given formatting style for the given locale.
`TimeZone!`	`getTimeZone()` Returns the time zone.
`Boolean`	`isCalendarLenient()` Returns whether date/time parsing in the encapsulated Calendar object is lenient.
`Boolean`	`isLenient()` Returns whether both date/time parsing in the encapsulated Calendar object and DateFormat whitespace & numeric processing is lenient.
`Date!`	`parse(text: String!)` Parses a date/time string. For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046). Parsing begins at the beginning of the string and proceeds as far as possible. Assuming no parse errors were encountered, this function doesn't return any information about how much of the string was consumed by the parsing. If you need that information, use a version of parse() that takes a ParsePosition. By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false). Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of the Calendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the parse method that takes a Calendar with the Calendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.
`Date!`	`parse(text: String!, pos: ParsePosition!)` Parses a date/time string according to the given parse position. For example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date that is equivalent to Date(837039928046). By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false). Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the ERA field of the Calendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using the parse method that takes a Calendar with the Calendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.
`Any!`	`parseObject(source: String!, pos: ParsePosition!)` Parses a date/time string into an Object. This convenience method simply calls parse(String, ParsePosition).
`DateFormat!`	`setBooleanAttribute(key: DateFormat.BooleanAttribute!, value: Boolean)` Sets a boolean attribute for this instance. Aspects of DateFormat leniency are controlled by boolean attributes.
`Unit`	`setCalendar(newCalendar: Calendar!)` Sets the calendar to be used by this date format. Initially, the default calendar for the specified or default locale is used.
`Unit`	`setCalendarLenient(lenient: Boolean)` Specifies whether date/time parsing in the encapsulated Calendar object should be lenient. With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. Without lenient parsing, inputs must match this object's format more closely.
`Unit`	`setLenient(lenient: Boolean)` Specifies whether date/time parsing is to be lenient. With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. Without lenient parsing, inputs must match this object's format more closely. Note: ICU 53 introduced finer grained control of leniency (and added new control points) making the preferred method a combination of setCalendarLenient() & setBooleanAttribute() calls. This method supports prior functionality but may not support all future leniency control & behavior of DateFormat. For control of pre 53 leniency, Calendar and DateFormat whitespace & numeric tolerance, this method is safe to use. However, mixing leniency control via this method and modification of the newer attributes via setBooleanAttribute() may produce undesirable results.
`Unit`	`setTimeZone(zone: TimeZone!)` Sets the time zone for the calendar of this DateFormat object.

Inherited properties

From class DateFormat

Calendar!

calendar

The calendar that DateFormat uses to produce the time field values needed to implement date and time formatting. Subclasses should initialize this to a calendar appropriate for the locale associated with this DateFormat.

NumberFormat!

numberFormat

The number formatter that DateFormat uses to format numbers in dates and times. Subclasses should initialize this to a number format appropriate for the locale associated with this DateFormat.

Parameters
`pattern`	String!: The pattern to be used
`override`	String!: The override string. A numbering system override string can take one of the following forms: 1). If just a numbering system name is specified, it applies to all numeric fields in the date format pattern. 2). To specify an alternate numbering system on a field by field basis, use the field letters from the pattern followed by an = sign, followed by the numbering system name. For example, to specify that just the year be formatted using Hebrew digits, use the override "y=hebr". Multiple overrides can be specified in a single string by separating them with a semi-colon. For example, the override string "m=thai;y=deva" would format using Thai digits for the month and Devanagari digits for the year.
`loc`	ULocale!: The locale to be used

Parameters
`cal`	Calendar!: the calendar whose date-time value is to be formatted into a date-time string
`toAppendTo`	StringBuffer!: where the new date-time text is to be appended
`fieldPosition`	keeps track of the position of the field within the returned string. On input: an alignment field, if desired. On output: the offsets of the alignment field. For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition is DateFormat.YEAR_FIELD, the begin index and end index of fieldPosition will be set to 0 and 4, respectively. Notice that if the same time field appears more than once in a pattern, the fieldPosition will be set for the first occurrence of that time field. For instance, formatting a Date to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat.TIMEZONE_FIELD, the begin index and end index of fieldPosition will be set to 5 and 8, respectively, for the first occurrence of the timezone pattern character 'z'.
`pos`	FieldPosition!: the formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.

Exceptions
`java.lang.NullPointerException`	if obj is null.
`java.lang.IllegalArgumentException`	when the Format cannot format the given object.

Parameters
`text`	String!: The date/time string to be parsed
`cal`	Calendar!: The calendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. In general, this should be initialized before calling this method - either cleared or set to the current date, depending on desired behavior. If this parse fails, the calendar may still have been modified. When the calendar type is different from the internal calendar held by this DateFormat instance, calendar field values will be parsed based on the internal calendar initialized with the time and the time zone taken from this calendar, then the parse result (time in milliseconds and time zone) will be set back to this calendar.
`pos`	On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.

Parameters
`fields`	String!: the fields to override
`overrideNF`	NumberFormat!: the NumbeferFormat used

Parameters
`text`	String!: the time text being parsed.
`start`	Int: where to start parsing.
`field`	Int: the date field being parsed.
`data`	Array<String!>!: the string array to parsed.

Parameters
`ch`	Char: the pattern character
`count`	Int: the number of times ch is repeated in the pattern
`beginOffset`	Int: the offset of the output string at the start of this field; used to set pos when appropriate
`pos`	FieldPosition!: receives the position of a field, when appropriate
`fmtData`	DateFormatSymbols!: the symbols for this formatter

Parameters
`text`	String!: the time text to be parsed.
`start`	Int: where to start parsing.
`ch`	Char: the pattern character for the date field text to be parsed.
`count`	Int: the count of a pattern character.
`obeyCount`	Boolean: if true, then the next field directly abuts this one, and we should use the count to know when to stop parsing.
`ambiguousYear`	BooleanArray!: return parameter; upon return, if ambiguousYear[0] is true, then a two-digit year was parsed and may need to be readjusted.
`cal`	Calendar!:

SimpleDateFormat

Synchronization

Summary

Public constructors