DateFormat

Kotlin |Java

abstract class DateFormat : UFormat

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

Known Direct Subclasses

SimpleDateFormat

[icu enhancement] ICU's replacement for java.text.SimpleDateFormat.

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

DateFormat is an abstract class for date/time formatting subclasses which formats and parses dates or time in a language-independent manner. The date/time formatting subclass, such as SimpleDateFormat, allows for formatting (i.e., date -> text), parsing (text -> date), and normalization. The date is represented as a Date object or as the milliseconds since January 1, 1970, 00:00:00 GMT.

DateFormat helps you to format and parse dates for any locale. Your code can be completely independent of the locale conventions for months, days of the week, or even the calendar format: lunar vs. solar. It provides many class methods for obtaining default date/time formatters based on the default for a given locale and a number of formatting styles or arbitrary "skeletons".

The formatting styles include FULL, LONG, MEDIUM, and SHORT. More detail and examples of using these styles are provided in the method descriptions.
The formatting styles only cover a fraction of the necessary usage. You often need to have just certain combinations of fields, like Month and Year, but have it to be formatted appropriate to a given locale. This is done using the (misnamed) getPatternInstance() method, supplying a skeleton. There are a number of constants that have common pre-defined skeletons, such as MINUTE_SECOND for something like "13:45" or YEAR_ABBR_MONTH for something like "Sept 2012".

To format a date for the current Locale, use one of the static factory methods:

myString = DateFormat.getDateInstance().format(myDate);
  myString = DateFormat.getPatternInstance(DateFormat.YEAR_ABBR_MONTH).format(myDate);

If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.

DateFormat df = DateFormat.getDateInstance();
  for (int i = 0; i < a.length; ++i) {
      output.println(df.format(myDate[i]) + "; ");
  }

To format a date for a different Locale, specify it in the call to getDateInstance().

DateFormat df = DateFormat.getDateInstance(DateFormat.LONG, Locale.FRANCE);

You can use a DateFormat to parse also.

myDate = df.parse(myString);

There are many static factory methods available. Use getDateInstance to get the normal date format for that country. Use getTimeInstance to get the time format for that country. Use getDateTimeInstance to get a date and time format. You can pass in different options to these factory methods to control the length of the result; from SHORT to MEDIUM to LONG to FULL. The exact result depends on the locale, but generally:

SHORT is completely numeric, such as 12.13.52 or 3:30pm
MEDIUM is longer, such as Jan 12, 1952
LONG is longer, such as January 12, 1952 or 3:30:32pm
FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

Use getPatternInstance to format with a skeleton. Typically this is with a predefined skeleton, like YEAR_ABBR_MONTH for something like "Sept 2012". If you don't want to use one of the predefined skeletons, you can supply your own. The skeletons are like the patterns in SimpleDateFormat, except they:

only keep the field pattern letter and ignore all other parts in a pattern, such as space, punctuation, and string literals.
are independent of the order of fields.
ignore certain differences in the field's pattern letter length:
1. For those non-digit calendar fields, the pattern letter length is important, such as MMM, MMMM, and MMMMM; E and EEEE, and the field's pattern letter length is honored.
2. For the digit calendar fields, such as M or MM, d or dd, yy or yyyy, the field pattern length is ignored and the best match, which is defined in date time patterns, will be returned without honor the field pattern letter length in skeleton.

You can also set the time zone on the format if you wish. If you want even more control over the format or parsing, (or want to give your users more control), you can try casting the DateFormat you get from the factory methods to a SimpleDateFormat. This will work for the majority of countries; just remember to put it in a try block in case you encounter an unusual one.

You can also use forms of the parse and format methods with ParsePosition and FieldPosition to allow you to

progressively parse through pieces of a string.
align any particular field, or find out where it is for selection on the screen.

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

Nested classes
	`BooleanAttribute` boolean attributes
open	`Field` The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that DateFormat.
	`HourCycle` Hour Cycle

Constants
static 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.
static String	`ABBR_MONTH` [icu] Constant for date skeleton with abbreviated month.
static String	`ABBR_MONTH_DAY` [icu] Constant for date skeleton with abbreviated month and day.
static String	`ABBR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with abbreviated month, weekday, and day.
static String	`ABBR_QUARTER` [icu] Constant for date skeleton with abbreviated quarter.
static 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.
static 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.
static String	`ABBR_WEEKDAY` [icu] Constant for date skeleton with abbreviated weekday.
static Int	`AM_PM_FIELD` FieldPosition selector for 'a' field alignment, corresponding to the `Calendar#AM_PM` field.
static Int	`AM_PM_MIDNIGHT_NOON_FIELD` [icu] FieldPosition selector for 'b' field alignment.
static Int	`DATE_FIELD` FieldPosition selector for 'd' field alignment, corresponding to the `Calendar#DATE` field.
static String	`DAY` [icu] Constant for date skeleton with day.
static Int	`DAY_OF_WEEK_FIELD` FieldPosition selector for 'E' field alignment, corresponding to the `Calendar#DAY_OF_WEEK` field.
static Int	`DAY_OF_WEEK_IN_MONTH_FIELD` FieldPosition selector for 'F' field alignment, corresponding to the `Calendar#DAY_OF_WEEK_IN_MONTH` field.
static Int	`DAY_OF_YEAR_FIELD` FieldPosition selector for 'D' field alignment, corresponding to the `Calendar#DAY_OF_YEAR` field.
static Int	`DEFAULT` Constant for default style pattern.
static Int	`DOW_LOCAL_FIELD` [icu] FieldPosition selector for 'e' field alignment, corresponding to the `Calendar#DOW_LOCAL` field.
static Int	`ERA_FIELD` FieldPosition selector for 'G' field alignment, corresponding to the `Calendar#ERA` field.
static Int	`EXTENDED_YEAR_FIELD` [icu] FieldPosition selector for 'u' field alignment, corresponding to the `Calendar#EXTENDED_YEAR` field.
static Int	`FLEXIBLE_DAY_PERIOD_FIELD` [icu] FieldPosition selector for 'B' field alignment.
static Int	`FRACTIONAL_SECOND_FIELD` [icu] FieldPosition selector for 'S' field alignment, corresponding to the `Calendar#MILLISECOND` field.
static Int	`FULL` Constant for full style pattern.
static String	`GENERIC_TZ` [icu] Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone.
static String	`HOUR` [icu] Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24).
static Int	`HOUR0_FIELD` FieldPosition selector for 'K' field alignment, corresponding to the `Calendar#HOUR` field.
static Int	`HOUR1_FIELD` FieldPosition selector for 'h' field alignment, corresponding to the `Calendar#HOUR` field.
static String	`HOUR24` [icu] Constant for date skeleton with hour in 24-hour presentation.
static String	`HOUR24_MINUTE` [icu] Constant for date skeleton with hour and minute in 24-hour presentation.
static String	`HOUR24_MINUTE_SECOND` [icu] Constant for date skeleton with hour, minute, and second in 24-hour presentation.
static String	`HOUR_MINUTE` [icu] Constant for date skeleton with hour and minute, with the locale's preferred hour format (12 or 24).
static String	`HOUR_MINUTE_SECOND` [icu] Constant for date skeleton with hour, minute, and second, with the locale's preferred hour format (12 or 24).
static Int	`HOUR_OF_DAY0_FIELD` FieldPosition selector for 'H' field alignment, corresponding to the `Calendar#HOUR_OF_DAY` field.
static Int	`HOUR_OF_DAY1_FIELD` FieldPosition selector for 'k' field alignment, corresponding to the `Calendar#HOUR_OF_DAY` field.
static Int	`JULIAN_DAY_FIELD` [icu] FieldPosition selector for 'g' field alignment, corresponding to the `Calendar#JULIAN_DAY` field.
static String	`LOCATION_TZ` [icu] Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone.
static Int	`LONG` Constant for long style pattern.
static Int	`MEDIUM` Constant for medium style pattern.
static Int	`MILLISECONDS_IN_DAY_FIELD` [icu] FieldPosition selector for 'A' field alignment, corresponding to the `Calendar#MILLISECONDS_IN_DAY` field.
static Int	`MILLISECOND_FIELD` Alias for FRACTIONAL_SECOND_FIELD.
static String	`MINUTE` [icu] Constant for date skeleton with minute.
static Int	`MINUTE_FIELD` FieldPosition selector for 'm' field alignment, corresponding to the `Calendar#MINUTE` field.
static String	`MINUTE_SECOND` [icu] Constant for date skeleton with minute and second.
static String	`MONTH` [icu] Constant for date skeleton with month.
static String	`MONTH_DAY` [icu] Constant for date skeleton with long month and day.
static Int	`MONTH_FIELD` FieldPosition selector for 'M' field alignment, corresponding to the `Calendar#MONTH` field.
static String	`MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with month, weekday, and day.
static Int	`NONE` [icu] Constant for empty style pattern.
static String	`NUM_MONTH` [icu] Constant for date skeleton with numeric month.
static String	`NUM_MONTH_DAY` [icu] Constant for date skeleton with numeric month and day.
static String	`NUM_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with numeric month, weekday, and day.
static String	`QUARTER` [icu] Constant for date skeleton with quarter.
static Int	`QUARTER_FIELD` [icu] FieldPosition selector for 'Q' field alignment, corresponding to the `Calendar#MONTH` field.
static Int	`RELATIVE` [icu] Constant for relative style mask.
static Int	`RELATIVE_DEFAULT` [icu] Constant for relative default style pattern.
static Int	`RELATIVE_FULL` [icu] Constant for relative full style pattern.
static Int	`RELATIVE_LONG` [icu] Constant for relative style pattern.
static Int	`RELATIVE_MEDIUM` [icu] Constant for relative style pattern.
static Int	`RELATIVE_SHORT` [icu] Constant for relative style pattern.
static String	`SECOND` [icu] Constant for date skeleton with second.
static Int	`SECOND_FIELD` FieldPosition selector for 's' field alignment, corresponding to the `Calendar#SECOND` field.
static Int	`SHORT` Constant for short style pattern.
static String	`SPECIFIC_TZ` [icu] Constant for specific non-location format, such as Pacific Daylight Time; used in combinations date + time + zone, or time + zone.
static Int	`STANDALONE_DAY_FIELD` [icu] FieldPosition selector for 'c' field alignment, corresponding to the `Calendar#DAY_OF_WEEK` field.
static Int	`STANDALONE_MONTH_FIELD` [icu] FieldPosition selector for 'L' field alignment, corresponding to the `Calendar#MONTH` field.
static Int	`STANDALONE_QUARTER_FIELD` [icu] FieldPosition selector for 'q' field alignment, corresponding to the `Calendar#MONTH` field.
static Int	`TIMEZONE_FIELD` FieldPosition selector for 'z' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_GENERIC_FIELD` [icu] FieldPosition selector for 'v' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_ISO_FIELD` [icu] FieldPosition selector for 'X' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_ISO_LOCAL_FIELD` [icu] FieldPosition selector for 'x' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD` [icu] FieldPosition selector for 'O' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_RFC_FIELD` [icu] FieldPosition selector for 'Z' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static Int	`TIMEZONE_SPECIAL_FIELD` [icu] FieldPosition selector for 'V' field alignment, corresponding to the `Calendar#ZONE_OFFSET` and `Calendar#DST_OFFSET` fields.
static String	`WEEKDAY` [icu] Constant for date skeleton with weekday.
static Int	`WEEK_OF_MONTH_FIELD` FieldPosition selector for 'W' field alignment, corresponding to the `Calendar#WEEK_OF_MONTH` field.
static Int	`WEEK_OF_YEAR_FIELD` FieldPosition selector for 'w' field alignment, corresponding to the `Calendar#WEEK_OF_YEAR` field.
static String	`YEAR` [icu] Constant for date skeleton with year.
static String	`YEAR_ABBR_MONTH` [icu] Constant for date skeleton with year and abbreviated month.
static String	`YEAR_ABBR_MONTH_DAY` [icu] Constant for date skeleton with year, abbreviated month, and day.
static String	`YEAR_ABBR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, abbreviated month, weekday, and day.
static String	`YEAR_ABBR_QUARTER` [icu] Constant for date skeleton with year and abbreviated quarter.
static Int	`YEAR_FIELD` FieldPosition selector for 'y' field alignment, corresponding to the `Calendar#YEAR` field.
static String	`YEAR_MONTH` [icu] Constant for date skeleton with year and month.
static String	`YEAR_MONTH_DAY` [icu] Constant for date skeleton with year, month, and day.
static String	`YEAR_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, month, weekday, and day.
static Int	`YEAR_NAME_FIELD` [icu] FieldPosition selector for 'U' field alignment, corresponding to the `Calendar#YEAR` field.
static String	`YEAR_NUM_MONTH` [icu] Constant for date skeleton with year and numeric month.
static String	`YEAR_NUM_MONTH_DAY` [icu] Constant for date skeleton with year, numeric month, and day.
static String	`YEAR_NUM_MONTH_WEEKDAY_DAY` [icu] Constant for date skeleton with year, numeric month, weekday, and day.
static String	`YEAR_QUARTER` [icu] Constant for date skeleton with year and quarter.
static Int	`YEAR_WOY_FIELD` [icu] FieldPosition selector for 'Y' field alignment, corresponding to the `Calendar#YEAR_WOY` field.

Protected constructors
`DateFormat()` Creates a new date format.

Public methods
open Any	`clone()` Overrides clone.
open Boolean	`equals(other: Any?)` Overrides equals.
StringBuffer!	`format(obj: Any!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!)` Formats a time object into a time string.
abstract StringBuffer!	`format(cal: Calendar!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!)` Formats a date into a date/time string.
open StringBuffer!	`format(date: Date!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!)` Formats a Date into a date/time string.
String!	`format(date: Date!)` Formats a Date into a date/time string.
open static Array<Locale!>!	`getAvailableLocales()` Returns the set of locales for which DateFormats are installed.
open Boolean	`getBooleanAttribute(key: DateFormat.BooleanAttribute!)` Returns the current value for the specified BooleanAttribute for this instance if attribute is missing false is returned.
open Calendar!	`getCalendar()` Returns the calendar associated with this date/time formatter.
open DisplayContext!	`getContext(type: DisplayContext.Type!)` [icu] Get the formatter's DisplayContext value for the specified DisplayContext.
static DateFormat!	`getDateInstance()` Returns the date formatter with the default formatting style for the default `FORMAT` locale.
static DateFormat!	`getDateInstance(style: Int)` Returns the date formatter with the given formatting style for the default `FORMAT` locale.
static DateFormat!	`getDateInstance(style: Int, aLocale: Locale!)` Returns the date formatter with the given formatting style for the given locale.
static DateFormat!	`getDateInstance(style: Int, locale: ULocale!)` Returns the date formatter with the given formatting style for the given locale.
static 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`.
static 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`.
static 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`.
static DateFormat!	`getDateTimeInstance()` Returns the date/time formatter with the default formatting style for the default `FORMAT` locale.
static DateFormat!	`getDateTimeInstance(dateStyle: Int, timeStyle: Int)` Returns the date/time formatter with the given date and time formatting styles for the default `FORMAT` locale.
static DateFormat!	`getDateTimeInstance(dateStyle: Int, timeStyle: Int, aLocale: Locale!)` Returns the date/time formatter with the given formatting styles for the given locale.
static DateFormat!	`getDateTimeInstance(dateStyle: Int, timeStyle: Int, locale: ULocale!)` Returns the date/time formatter with the given formatting styles for the given locale.
static 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`.
static 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`.
static 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`.
static DateFormat!	`getInstance()` Returns a default date/time formatter that uses the SHORT style for both the date and the time.
static DateFormat!	`getInstance(cal: Calendar!, locale: Locale!)` Returns a date/time formatter that uses the SHORT style for both the date and the time.
static DateFormat!	`getInstance(cal: Calendar!, locale: ULocale!)` Returns a date/time formatter that uses the SHORT style for both the date and the time.
static DateFormat!	`getInstance(cal: Calendar!)` Returns a default date/time formatter that uses the SHORT style for both the date and the time.
static DateFormat!	`getInstanceForSkeleton(skeleton: String!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the default locale.
static DateFormat!	`getInstanceForSkeleton(skeleton: String!, locale: Locale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
static DateFormat!	`getInstanceForSkeleton(skeleton: String!, locale: ULocale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
static 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`.
static 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`.
open NumberFormat!	`getNumberFormat()` Returns the number formatter which this date/time formatter uses to format and parse a time.
static DateFormat!	`getPatternInstance(skeleton: String!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the default locale.
static DateFormat!	`getPatternInstance(skeleton: String!, locale: Locale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
static DateFormat!	`getPatternInstance(skeleton: String!, locale: ULocale!)` [icu] Returns a `DateFormat` object that can be used to format dates and times in the given locale.
static 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`.
static 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`.
static DateFormat!	`getTimeInstance()` Gets the time formatter with the default formatting style for the default `FORMAT` locale.
static DateFormat!	`getTimeInstance(style: Int)` Returns the time formatter with the given formatting style for the default `FORMAT` locale.
static DateFormat!	`getTimeInstance(style: Int, aLocale: Locale!)` Returns the time formatter with the given formatting style for the given locale.
static DateFormat!	`getTimeInstance(style: Int, locale: ULocale!)` Returns the time formatter with the given formatting style for the given locale.
static 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`.
static 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`.
static DateFormat!	`getTimeInstance(cal: Calendar!, timeStyle: Int)` Creates a `DateFormat` object that can be used to format times in the calendar system specified by `cal`.
open TimeZone!	`getTimeZone()` Returns the time zone.
open Int	`hashCode()` Overrides hashCode.
open Boolean	`isCalendarLenient()` Returns whether date/time parsing in the encapsulated Calendar object is lenient.
open Boolean	`isLenient()` Returns whether both date/time parsing in the encapsulated Calendar object and DateFormat whitespace & numeric processing is lenient.
open Date!	`parse(text: String!)` Parses a date/time string.
abstract Unit	`parse(text: String!, cal: Calendar!, pos: ParsePosition!)` Parses a date/time string according to the given parse position.
open Date!	`parse(text: String!, pos: ParsePosition!)` Parses a date/time string according to the given parse position.
open Any!	`parseObject(source: String!, pos: ParsePosition!)` Parses a date/time string into an Object.
open DateFormat!	`setBooleanAttribute(key: DateFormat.BooleanAttribute!, value: Boolean)` Sets a boolean attribute for this instance.
open Unit	`setCalendar(newCalendar: Calendar!)` Sets the calendar to be used by this date format.
open Unit	`setCalendarLenient(lenient: Boolean)` Specifies whether date/time parsing in the encapsulated Calendar object should be lenient.
open Unit	`setContext(context: DisplayContext!)` [icu] Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.
open Unit	`setLenient(lenient: Boolean)` Specifies whether date/time parsing is to be lenient.
open Unit	`setNumberFormat(newNumberFormat: NumberFormat!)` Sets the number formatter.
open Unit	`setTimeZone(zone: TimeZone!)` Sets the time zone for the calendar of this DateFormat object.

Properties
Calendar!	`calendar` The calendar that `DateFormat` uses to produce the time field values needed to implement date and time formatting.
NumberFormat!	`numberFormat` The number formatter that `DateFormat` uses to format numbers in dates and times.

Parameters
`obj`	Any!: must be a Number or a Date or a Calendar.
`toAppendTo`	StringBuffer!: the string buffer for the returning time string.
`pos`	A `FieldPosition` identifying a field in the formatted text
`fieldPosition`	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'.

Exceptions
`java.lang.NullPointerException`	if `toAppendTo` or `pos` is null
`java.lang.IllegalArgumentException`	if the Format cannot format the given object

Parameters
`cal`	Calendar!: a Calendar set to the date and time to be formatted into a date/time string. When the calendar type is different from the internal calendar held by this DateFormat instance, the date and the time zone will be inherited from the input calendar, but other calendar field values will be calculated by the internal calendar.
`toAppendTo`	StringBuffer!: the string buffer for the returning date/time string.
`fieldPosition`	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'.

Parameters
`date`	Date!: a Date to be formatted into a date/time string.
`toAppendTo`	StringBuffer!: the string buffer for the returning date/time string.
`fieldPosition`	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'.

Parameters
`cal`	Calendar!: The calendar system for which a date format is desired.
`dateStyle`	Int: The type of date format desired. This can be `DateFormat#SHORT`, `DateFormat#MEDIUM`, etc.
`locale`	Locale!: The locale for which the date format is desired.

Parameters
`dateStyle`	Int: the given date formatting style. As currently implemented, relative date formatting only affects a limited range of calendar days before or after the current date, based on the CLDR <field type="day">/<relative> data: For example, in English, "Yesterday", "Today", and "Tomorrow". Outside of this range, relative dates are formatted using the corresponding non-relative style.
`timeStyle`	Int: the given time formatting style. Relative time styles are not currently supported, and behave just like the corresponding non-relative style.
`aLocale`	Locale!: the given locale.

Parameters
`skeleton`	String!: The skeleton that selects the fields to be formatted. (Uses the `DateTimePatternGenerator`.) This can be `DateFormat#ABBR_MONTH`, `DateFormat#MONTH_WEEKDAY_DAY`, etc.
`locale`	Locale!: The locale for which the date/time format is desired.

Parameters
`style`	Int: the given formatting style. For example, SHORT for "h:mm a" in the US locale. Relative time styles are not currently supported, and behave just like the corresponding non-relative style.
`aLocale`	Locale!: the given locale.

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`	ParsePosition!: 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
`source`	String!: A `String`, part of which should be parsed.
`pos`	ParsePosition!: A `ParsePosition` object with index and error index information as described above.

DateFormat

Synchronization

Summary

Constants

ABBR_GENERIC_TZ

ABBR_MONTH

ABBR_MONTH_DAY

ABBR_MONTH_WEEKDAY_DAY

ABBR_QUARTER

ABBR_SPECIFIC_TZ

ABBR_UTC_TZ

ABBR_WEEKDAY

AM_PM_FIELD

AM_PM_MIDNIGHT_NOON_FIELD

DATE_FIELD

DAY

DAY_OF_WEEK_FIELD

DAY_OF_WEEK_IN_MONTH_FIELD

DAY_OF_YEAR_FIELD

DEFAULT

DOW_LOCAL_FIELD

ERA_FIELD

EXTENDED_YEAR_FIELD

FLEXIBLE_DAY_PERIOD_FIELD

FRACTIONAL_SECOND_FIELD

FULL

GENERIC_TZ

HOUR

HOUR0_FIELD

HOUR1_FIELD

HOUR24

HOUR24_MINUTE

HOUR24_MINUTE_SECOND

HOUR_MINUTE

HOUR_MINUTE_SECOND

HOUR_OF_DAY0_FIELD

HOUR_OF_DAY1_FIELD

JULIAN_DAY_FIELD

LOCATION_TZ

LONG

MEDIUM

MILLISECONDS_IN_DAY_FIELD

MILLISECOND_FIELD

MINUTE

MINUTE_FIELD

MINUTE_SECOND

MONTH

MONTH_DAY

MONTH_FIELD

MONTH_WEEKDAY_DAY

NONE

NUM_MONTH

NUM_MONTH_DAY

NUM_MONTH_WEEKDAY_DAY

QUARTER

QUARTER_FIELD

RELATIVE

RELATIVE_DEFAULT

RELATIVE_FULL

RELATIVE_LONG

RELATIVE_MEDIUM

RELATIVE_SHORT

SECOND

SECOND_FIELD

SHORT

SPECIFIC_TZ

STANDALONE_DAY_FIELD

STANDALONE_MONTH_FIELD

STANDALONE_QUARTER_FIELD

TIMEZONE_FIELD

TIMEZONE_GENERIC_FIELD

TIMEZONE_ISO_FIELD

TIMEZONE_ISO_LOCAL_FIELD

TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD

TIMEZONE_RFC_FIELD

TIMEZONE_SPECIAL_FIELD

WEEKDAY

WEEK_OF_MONTH_FIELD

WEEK_OF_YEAR_FIELD

YEAR