Added in API level 24

DateFormat

---

Kotlin |Java

abstract class DateFormat : UFormat

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

Known Direct Subclasses SimpleDateFormat 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".

1. The formatting styles include FULL, LONG, MEDIUM, and SHORT. More detail and examples of using these styles are provided in the method descriptions.
2. 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:

1. only keep the field pattern letter and ignore all other parts in a pattern, such as space, punctuation, and string literals.
2. are independent of the order of fields.
3. 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.
abstract StringBuffer!	format(cal: Calendar!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!) Formats a date into a date/time string.
StringBuffer!	format(obj: Any!, toAppendTo: StringBuffer!, fieldPosition: FieldPosition!) Formats a time object into a time string.
String!	format(date: Date!) 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.
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(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!	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, locale: Locale!) Creates a DateFormat object that can be used to format dates in the calendar system specified by cal.
static DateFormat!	getDateInstance(style: Int) Returns the date formatter with the given formatting style for the default FORMAT locale.
static DateFormat!	getDateInstance(style: Int, locale: ULocale!) Returns the date formatter with the given formatting style for the given locale.
static DateFormat!	getDateInstance(style: Int, aLocale: Locale!) Returns the date formatter with the given formatting style for the given locale.
static DateFormat!	getDateTimeInstance() Returns the date/time formatter with the default formatting style for the default FORMAT locale.
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!	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, 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(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, locale: ULocale!) Returns the date/time formatter with the given formatting styles for the given 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!	getInstance() Returns a default 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!	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!, locale: Locale!) Returns a date/time formatter that uses the SHORT style for both the date and the time.
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.
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(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: ULocale!) [icu] Returns a DateFormat object that can be used to format dates and times in the given 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.
open NumberFormat!	getNumberFormat() Returns the number formatter which this date/time formatter uses to format and parse a time.
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!	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(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: ULocale!) [icu] Returns a DateFormat object that can be used to format dates and times in the given 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!	getTimeInstance() Gets the time formatter with the default formatting style for the default FORMAT locale.
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.
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, locale: Locale!) Creates a DateFormat object that can be used to format times in the calendar system specified by cal.
static DateFormat!	getTimeInstance(style: Int) Returns the time formatter with the given formatting style for the default FORMAT locale.
static DateFormat!	getTimeInstance(style: Int, locale: ULocale!) Returns the time formatter with the given formatting style for the given locale.
static DateFormat!	getTimeInstance(style: Int, aLocale: Locale!) Returns the time formatter with the given formatting style for the given locale.
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.

Constants

ABBR_GENERIC_TZ

Added in API level 24

static val ABBR_GENERIC_TZ: String

[icu] Constant for generic non-location format, abbreviated if possible, such as PT; used in combinations date + time + zone, or time + zone.

Value: "v"

See Also

ABBR_MONTH

Added in API level 24

static val ABBR_MONTH: String

[icu] Constant for date skeleton with abbreviated month.

Value: "MMM"

ABBR_MONTH_DAY

Added in API level 24

static val ABBR_MONTH_DAY: String

[icu] Constant for date skeleton with abbreviated month and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "MMMd"

ABBR_MONTH_WEEKDAY_DAY

Added in API level 24

static val ABBR_MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "MMMEd"

ABBR_QUARTER

Added in API level 24

static val ABBR_QUARTER: String

[icu] Constant for date skeleton with abbreviated quarter.

Value: "QQQ"

ABBR_SPECIFIC_TZ

Added in API level 24

static val ABBR_SPECIFIC_TZ: String

[icu] Constant for specific non-location format, abbreviated if possible, such as PDT; used in combinations date + time + zone, or time + zone.

Value: "z"

See Also

ABBR_UTC_TZ

Added in API level 24

static val ABBR_UTC_TZ: String

[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.

Value: "ZZZZ"

See Also

ABBR_WEEKDAY

Added in API level 24

static val ABBR_WEEKDAY: String

[icu] Constant for date skeleton with abbreviated weekday.

Value: "E"

AM_PM_FIELD

Added in API level 24

static val AM_PM_FIELD: Int

FieldPosition selector for 'a' field alignment, corresponding to the Calendar.AM_PM field.

Value: 14

AM_PM_MIDNIGHT_NOON_FIELD

Added in API level 28

static val AM_PM_MIDNIGHT_NOON_FIELD: Int

[icu] FieldPosition selector for 'b' field alignment. No related Calendar field. This displays the fixed day period (am/pm/midnight/noon).

Value: 35

DATE_FIELD

Added in API level 24

static val DATE_FIELD: Int

FieldPosition selector for 'd' field alignment, corresponding to the Calendar.DATE field.

Value: 3

DAY

Added in API level 24

static val DAY: String

[icu] Constant for date skeleton with day.

Value: "d"

DAY_OF_WEEK_FIELD

Added in API level 24

static val DAY_OF_WEEK_FIELD: Int

FieldPosition selector for 'E' field alignment, corresponding to the Calendar.DAY_OF_WEEK field.

Value: 9

DAY_OF_WEEK_IN_MONTH_FIELD

Added in API level 24

static val DAY_OF_WEEK_IN_MONTH_FIELD: Int

FieldPosition selector for 'F' field alignment, corresponding to the Calendar.DAY_OF_WEEK_IN_MONTH field.

Value: 11

DAY_OF_YEAR_FIELD

Added in API level 24

static val DAY_OF_YEAR_FIELD: Int

FieldPosition selector for 'D' field alignment, corresponding to the Calendar.DAY_OF_YEAR field.

Value: 10

DEFAULT

Added in API level 24

static val DEFAULT: Int

Constant for default style pattern. Its value is MEDIUM.

Value: 2

DOW_LOCAL_FIELD

Added in API level 24

static val DOW_LOCAL_FIELD: Int

[icu] FieldPosition selector for 'e' field alignment, corresponding to the Calendar.DOW_LOCAL field.

Value: 19

ERA_FIELD

Added in API level 24

static val ERA_FIELD: Int

FieldPosition selector for 'G' field alignment, corresponding to the Calendar.ERA field.

Value: 0

EXTENDED_YEAR_FIELD

Added in API level 24

static val EXTENDED_YEAR_FIELD: Int

[icu] FieldPosition selector for 'u' field alignment, corresponding to the Calendar.EXTENDED_YEAR field.

Value: 20

FLEXIBLE_DAY_PERIOD_FIELD

Added in API level 28

static val FLEXIBLE_DAY_PERIOD_FIELD: Int

[icu] FieldPosition selector for 'B' field alignment. No related Calendar field. This displays the flexible day period.

Value: 36

FRACTIONAL_SECOND_FIELD

Added in API level 24

static val FRACTIONAL_SECOND_FIELD: Int

[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.

Value: 8

FULL

Added in API level 24

static val FULL: Int

Constant for full style pattern.

Value: 0

GENERIC_TZ

Added in API level 24

static val GENERIC_TZ: String

[icu] Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone.

Value: "vvvv"

See Also

HOUR

Added in API level 24

static val HOUR: String

[icu] Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24).

Value: "j"

HOUR0_FIELD

Added in API level 24

static val HOUR0_FIELD: Int

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.

Value: 16

HOUR1_FIELD

Added in API level 24

static val HOUR1_FIELD: Int

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.

Value: 15

HOUR24

Added in API level 24

static val HOUR24: String

[icu] Constant for date skeleton with hour in 24-hour presentation.

Value: "H"

HOUR24_MINUTE

Added in API level 24

static val HOUR24_MINUTE: String

[icu] Constant for date skeleton with hour and minute in 24-hour presentation. Used in combinations date + time, date + time + zone, or time + zone.

Value: "Hm"

HOUR24_MINUTE_SECOND

Added in API level 24

static val HOUR24_MINUTE_SECOND: String

[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.

Value: "Hms"

HOUR_MINUTE

Added in API level 24

static val HOUR_MINUTE: String

[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.

Value: "jm"

HOUR_MINUTE_SECOND

Added in API level 24

static val HOUR_MINUTE_SECOND: String

[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.

Value: "jms"

HOUR_OF_DAY0_FIELD

Added in API level 24

static val HOUR_OF_DAY0_FIELD: Int

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.

Value: 5

HOUR_OF_DAY1_FIELD

Added in API level 24

static val HOUR_OF_DAY1_FIELD: Int

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.

Value: 4

JULIAN_DAY_FIELD

Added in API level 24

static val JULIAN_DAY_FIELD: Int

[icu] FieldPosition selector for 'g' field alignment, corresponding to the Calendar.JULIAN_DAY field.

Value: 21

LOCATION_TZ

Added in API level 24

static val LOCATION_TZ: String

[icu] Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone.

Value: "VVVV"

See Also

LONG

Added in API level 24

static val LONG: Int

Constant for long style pattern.

Value: 1

MEDIUM

Added in API level 24

static val MEDIUM: Int

Constant for medium style pattern.

Value: 2

MILLISECONDS_IN_DAY_FIELD

Added in API level 24

static val MILLISECONDS_IN_DAY_FIELD: Int

[icu] FieldPosition selector for 'A' field alignment, corresponding to the Calendar.MILLISECONDS_IN_DAY field.

Value: 22

MILLISECOND_FIELD

Added in API level 24

static val MILLISECOND_FIELD: Int

Alias for FRACTIONAL_SECOND_FIELD.

Value: 8

MINUTE

Added in API level 24

static val MINUTE: String

[icu] Constant for date skeleton with minute.

Value: "m"

MINUTE_FIELD

Added in API level 24

static val MINUTE_FIELD: Int

FieldPosition selector for 'm' field alignment, corresponding to the Calendar.MINUTE field.

Value: 6

MINUTE_SECOND

Added in API level 24

static val MINUTE_SECOND: String

[icu] Constant for date skeleton with minute and second. Used in combinations date + time, date + time + zone, or time + zone.

Value: "ms"

MONTH

Added in API level 24

static val MONTH: String

[icu] Constant for date skeleton with month.

Value: "MMMM"

MONTH_DAY

Added in API level 24

static val MONTH_DAY: String

[icu] Constant for date skeleton with long month and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "MMMMd"

MONTH_FIELD

Added in API level 24

static val MONTH_FIELD: Int

FieldPosition selector for 'M' field alignment, corresponding to the Calendar.MONTH field.

Value: 2

MONTH_WEEKDAY_DAY

Added in API level 24

static val MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "MMMMEEEEd"

NONE

Added in API level 24

static val NONE: Int

[icu] Constant for empty style pattern.

Value: -1

NUM_MONTH

Added in API level 24

static val NUM_MONTH: String

[icu] Constant for date skeleton with numeric month.

Value: "M"

NUM_MONTH_DAY

Added in API level 24

static val NUM_MONTH_DAY: String

[icu] Constant for date skeleton with numeric month and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "Md"

NUM_MONTH_WEEKDAY_DAY

Added in API level 24

static val NUM_MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "MEd"

QUARTER

Added in API level 24

static val QUARTER: String

[icu] Constant for date skeleton with quarter.

Value: "QQQQ"

QUARTER_FIELD

Added in API level 24

static val QUARTER_FIELD: Int

[icu] FieldPosition selector for 'Q' field alignment, corresponding to the Calendar.MONTH field. This displays the quarter.

Value: 27

RELATIVE

Added in API level 24

static val RELATIVE: Int

[icu] Constant for relative style mask.

Value: 128

RELATIVE_DEFAULT

Added in API level 24

static val RELATIVE_DEFAULT: Int

[icu] Constant for relative default style pattern.

Value: 130

RELATIVE_FULL

Added in API level 24

static val RELATIVE_FULL: Int

[icu] Constant for relative full style pattern.

Value: 128

RELATIVE_LONG

Added in API level 24

static val RELATIVE_LONG: Int

[icu] Constant for relative style pattern.

Value: 129

RELATIVE_MEDIUM

Added in API level 24

static val RELATIVE_MEDIUM: Int

[icu] Constant for relative style pattern.

Value: 130

RELATIVE_SHORT

Added in API level 24

static val RELATIVE_SHORT: Int

[icu] Constant for relative style pattern.

Value: 131

SECOND

Added in API level 24

static val SECOND: String

[icu] Constant for date skeleton with second.

Value: "s"

SECOND_FIELD

Added in API level 24

static val SECOND_FIELD: Int

FieldPosition selector for 's' field alignment, corresponding to the Calendar.SECOND field.

Value: 7

SHORT

Added in API level 24

static val SHORT: Int

Constant for short style pattern.

Value: 3

SPECIFIC_TZ

Added in API level 24

static val SPECIFIC_TZ: String

[icu] Constant for specific non-location format, such as Pacific Daylight Time; used in combinations date + time + zone, or time + zone.

Value: "zzzz"

See Also

STANDALONE_DAY_FIELD

Added in API level 24

static val STANDALONE_DAY_FIELD: Int

[icu] FieldPosition selector for 'c' field alignment, corresponding to the Calendar.DAY_OF_WEEK field. This displays the stand alone day name, if available.

Value: 25

STANDALONE_MONTH_FIELD

Added in API level 24

static val STANDALONE_MONTH_FIELD: Int

[icu] FieldPosition selector for 'L' field alignment, corresponding to the Calendar.MONTH field. This displays the stand alone month name, if available.

Value: 26

STANDALONE_QUARTER_FIELD

Added in API level 24

static val STANDALONE_QUARTER_FIELD: Int

[icu] FieldPosition selector for 'q' field alignment, corresponding to the Calendar.MONTH field. This displays the stand alone quarter, if available.

Value: 28

TIMEZONE_FIELD

Added in API level 24

static val TIMEZONE_FIELD: Int

FieldPosition selector for 'z' field alignment, corresponding to the Calendar.ZONE_OFFSET and Calendar.DST_OFFSET fields.

Value: 17

TIMEZONE_GENERIC_FIELD

Added in API level 24

static val TIMEZONE_GENERIC_FIELD: Int

[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.

Value: 24

TIMEZONE_ISO_FIELD

Added in API level 24

static val TIMEZONE_ISO_FIELD: Int

[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").

Value: 32

TIMEZONE_ISO_LOCAL_FIELD

Added in API level 24

static val TIMEZONE_ISO_LOCAL_FIELD: Int

[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.

Value: 33

TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD

Added in API level 24

static val TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD: Int

[icu] FieldPosition selector for 'O' field alignment, corresponding to the Calendar.ZONE_OFFSET and Calendar.DST_OFFSET fields. This displays the localized GMT format.

Value: 31

TIMEZONE_RFC_FIELD

Added in API level 24

static val TIMEZONE_RFC_FIELD: Int

[icu] FieldPosition selector for 'Z' field alignment, corresponding to the Calendar.ZONE_OFFSET and Calendar.DST_OFFSET fields.

Value: 23

TIMEZONE_SPECIAL_FIELD

Added in API level 24

static val TIMEZONE_SPECIAL_FIELD: Int

[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.

Value: 29

WEEKDAY

Added in API level 24

static val WEEKDAY: String

[icu] Constant for date skeleton with weekday.

Value: "EEEE"

WEEK_OF_MONTH_FIELD

Added in API level 24

static val WEEK_OF_MONTH_FIELD: Int

FieldPosition selector for 'W' field alignment, corresponding to the Calendar.WEEK_OF_MONTH field.

Value: 13

WEEK_OF_YEAR_FIELD

Added in API level 24

static val WEEK_OF_YEAR_FIELD: Int

FieldPosition selector for 'w' field alignment, corresponding to the Calendar.WEEK_OF_YEAR field.

Value: 12

YEAR

Added in API level 24

static val YEAR: String

[icu] Constant for date skeleton with year.

Value: "y"

YEAR_ABBR_MONTH

Added in API level 24

static val YEAR_ABBR_MONTH: String

[icu] Constant for date skeleton with year and abbreviated month.

Value: "yMMM"

YEAR_ABBR_MONTH_DAY

Added in API level 24

static val YEAR_ABBR_MONTH_DAY: String

[icu] Constant for date skeleton with year, abbreviated month, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMMMd"

YEAR_ABBR_MONTH_WEEKDAY_DAY

Added in API level 24

static val YEAR_ABBR_MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with year, abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMMMEd"

YEAR_ABBR_QUARTER

Added in API level 24

static val YEAR_ABBR_QUARTER: String

[icu] Constant for date skeleton with year and abbreviated quarter.

Value: "yQQQ"

YEAR_FIELD

Added in API level 24

static val YEAR_FIELD: Int

FieldPosition selector for 'y' field alignment, corresponding to the Calendar.YEAR field.

Value: 1

YEAR_MONTH

Added in API level 24

static val YEAR_MONTH: String

[icu] Constant for date skeleton with year and month.

Value: "yMMMM"

YEAR_MONTH_DAY

Added in API level 24

static val YEAR_MONTH_DAY: String

[icu] Constant for date skeleton with year, month, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMMMMd"

YEAR_MONTH_WEEKDAY_DAY

Added in API level 24

static val YEAR_MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with year, month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMMMMEEEEd"

YEAR_NAME_FIELD

Added in API level 24

static val YEAR_NAME_FIELD: Int

[icu] FieldPosition selector for 'U' field alignment, corresponding to the Calendar.YEAR field. This displays the cyclic year name, if available.

Value: 30

YEAR_NUM_MONTH

Added in API level 24

static val YEAR_NUM_MONTH: String

[icu] Constant for date skeleton with year and numeric month.

Value: "yM"

YEAR_NUM_MONTH_DAY

Added in API level 24

static val YEAR_NUM_MONTH_DAY: String

[icu] Constant for date skeleton with year, numeric month, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMd"

YEAR_NUM_MONTH_WEEKDAY_DAY

Added in API level 24

static val YEAR_NUM_MONTH_WEEKDAY_DAY: String

[icu] Constant for date skeleton with year, numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone.

Value: "yMEd"

YEAR_QUARTER

Added in API level 24

static val YEAR_QUARTER: String

[icu] Constant for date skeleton with year and quarter.

Value: "yQQQQ"

YEAR_WOY_FIELD

Added in API level 24

static val YEAR_WOY_FIELD: Int

[icu] FieldPosition selector for 'Y' field alignment, corresponding to the Calendar.YEAR_WOY field.

Value: 18

Protected constructors

DateFormat

Added in API level 24

protected DateFormat()

Creates a new date format.

Public methods

clone

Added in API level 24

open fun clone(): Any

Overrides clone.

Return
Any	a clone of this instance.

Exceptions
java.lang.CloneNotSupportedException	if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

equals

Added in API level 24

open fun equals(other: Any?): Boolean

Overrides equals.

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

format

Added in API level 24

abstract fun format(
    cal: Calendar!, 
    toAppendTo: StringBuffer!, 
    fieldPosition: FieldPosition!
): StringBuffer!

Formats a date into a date/time string.

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'.

Return
StringBuffer!	the formatted date/time string.

format

Added in API level 24

fun format(
    obj: Any!, 
    toAppendTo: StringBuffer!, 
    fieldPosition: FieldPosition!
): StringBuffer!

Formats a time object into a time string. Examples of time objects are a time value expressed in milliseconds and a Date object.

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'.

Return
StringBuffer!	the formatted time string.

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

See Also

• java.text.Format

format

Added in API level 24

fun format(date: Date!): String!

Formats a Date into a date/time string.

Parameters
date	Date!: the time value to be formatted into a time string.

Return
String!	the formatted time string.

format

Added in API level 24

open fun format(
    date: Date!, 
    toAppendTo: StringBuffer!, 
    fieldPosition: FieldPosition!
): StringBuffer!

Formats a Date into a date/time string.

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'.

Return
StringBuffer!	the formatted date/time string.

getAvailableLocales

Added in API level 24

open static fun getAvailableLocales(): Array<Locale!>!

Returns the set of locales for which DateFormats are installed.

Return
Array<Locale!>!	the set of locales for which DateFormats are installed.

getBooleanAttribute

Added in API level 24

open fun getBooleanAttribute(key: DateFormat.BooleanAttribute!): Boolean

Returns the current value for the specified BooleanAttribute for this instance if attribute is missing false is returned.

See Also

• android.icu.text.DateFormat.BooleanAttribute

getCalendar

Added in API level 24

open fun getCalendar(): Calendar!

Returns the calendar associated with this date/time formatter.

Return
Calendar!	the calendar associated with this date/time formatter.

getContext

Added in API level 24

open fun getContext(type: DisplayContext.Type!): DisplayContext!

[icu] Get the formatter's DisplayContext value for the specified DisplayContext.Type, such as CAPITALIZATION.

Parameters
type	DisplayContext.Type!: the DisplayContext.Type whose value to return

Return
DisplayContext!	the current DisplayContext setting for the specified type

getDateInstance

Added in API level 24

static fun getDateInstance(): DateFormat!

Returns the date formatter with the default formatting style for the default FORMAT locale.

Return
DateFormat!	a date formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getDateInstance

Added in API level 24

static fun getDateInstance(
    cal: Calendar!, 
    dateStyle: Int
): DateFormat!

Creates a DateFormat object for the default locale that can be used to format dates in the calendar system specified by cal.

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.

getDateInstance

Added in API level 24

static fun getDateInstance(
    cal: Calendar!, 
    dateStyle: Int, 
    locale: ULocale!
): DateFormat!

Creates a DateFormat object that can be used to format dates in the calendar system specified by cal.

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	ULocale!: The locale for which the date format is desired.

getDateInstance

Added in API level 24

static fun getDateInstance(
    cal: Calendar!, 
    dateStyle: Int, 
    locale: Locale!
): DateFormat!

Creates a DateFormat object that can be used to format dates in the calendar system specified by cal.

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.

getDateInstance

Added in API level 24

static fun getDateInstance(style: Int): DateFormat!

Returns the date formatter with the given formatting style for the default FORMAT locale.

Parameters

style

Int: the given formatting style. For example, SHORT for "M/d/yy" in the US locale. 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.

Return
DateFormat!	a date formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getDateInstance

Added in API level 24

static fun getDateInstance(
    style: Int, 
    locale: ULocale!
): DateFormat!

Returns the date formatter with the given formatting style for the given locale.

Parameters
style	Int: the given formatting style. For example, SHORT for "M/d/yy" in the US locale. 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.
locale	ULocale!: the given ulocale.

Return
DateFormat!	a date formatter.

getDateInstance

Added in API level 24

static fun getDateInstance(
    style: Int, 
    aLocale: Locale!
): DateFormat!

Returns the date formatter with the given formatting style for the given locale.

Parameters
style	Int: the given formatting style. For example, SHORT for "M/d/yy" in the US locale. 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.
aLocale	Locale!: the given locale.

Return
DateFormat!	a date formatter.

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(): DateFormat!

Returns the date/time formatter with the default formatting style for the default FORMAT locale.

Return
DateFormat!	a date/time formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    cal: Calendar!, 
    dateStyle: Int, 
    timeStyle: Int
): DateFormat!

Creates a DateFormat object for the default locale that can be used to format dates and times in the calendar system specified by cal.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
dateStyle	Int: The type of date format desired. This can be DateFormat.SHORT, DateFormat.MEDIUM, etc.
timeStyle	Int: The type of time format desired. This can be DateFormat.SHORT, DateFormat.MEDIUM, etc.

See Also

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    cal: Calendar!, 
    dateStyle: Int, 
    timeStyle: Int, 
    locale: ULocale!
): DateFormat!

Creates a DateFormat object that can be used to format dates and times in the calendar system specified by cal.

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

See Also

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    cal: Calendar!, 
    dateStyle: Int, 
    timeStyle: Int, 
    locale: Locale!
): DateFormat!

Creates a DateFormat object that can be used to format dates and times in the calendar system specified by cal.

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

See Also

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    dateStyle: Int, 
    timeStyle: Int
): DateFormat!

Returns the date/time formatter with the given date and time formatting styles for the default FORMAT locale.

Parameters
dateStyle	Int: the given date formatting style. For example, SHORT for "M/d/yy" in the US locale. 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. 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.

Return
DateFormat!	a date/time formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    dateStyle: Int, 
    timeStyle: Int, 
    locale: ULocale!
): DateFormat!

Returns the date/time formatter with the given formatting styles for the given locale.

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.
locale	ULocale!: the given ulocale.

Return
DateFormat!	a date/time formatter.

getDateTimeInstance

Added in API level 24

static fun getDateTimeInstance(
    dateStyle: Int, 
    timeStyle: Int, 
    aLocale: Locale!
): DateFormat!

Returns the date/time formatter with the given formatting styles for the given locale.

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.

Return
DateFormat!	a date/time formatter.

getInstance

Added in API level 24

static fun getInstance(): DateFormat!

Returns a default date/time formatter that uses the SHORT style for both the date and the time.

getInstance

Added in API level 24

static fun getInstance(cal: Calendar!): DateFormat!

Returns a default date/time formatter that uses the SHORT style for both the date and the time.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.

getInstance

Added in API level 33

static fun getInstance(
    cal: Calendar!, 
    locale: ULocale!
): DateFormat!

Returns a date/time formatter that uses the SHORT style for both the date and the time.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
locale	ULocale!: The locale for which the date/time format is desired.

getInstance

Added in API level 24

static fun getInstance(
    cal: Calendar!, 
    locale: Locale!
): DateFormat!

Returns a date/time formatter that uses the SHORT style for both the date and the time.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
locale	Locale!: The locale for which the date/time format is desired.

getInstanceForSkeleton

Added in API level 24

static fun getInstanceForSkeleton(
    cal: Calendar!, 
    skeleton: String!, 
    locale: ULocale!
): DateFormat!

[icu] Creates a DateFormat object that can be used to format dates and times in the calendar system specified by cal.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
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	ULocale!: The locale for which the date/time format is desired.

getInstanceForSkeleton

Added in API level 24

static fun getInstanceForSkeleton(
    cal: Calendar!, 
    skeleton: String!, 
    locale: Locale!
): DateFormat!

[icu] Creates a DateFormat object that can be used to format dates and times in the calendar system specified by cal.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
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.

getInstanceForSkeleton

Added in API level 24

static fun getInstanceForSkeleton(skeleton: String!): DateFormat!

[icu] Returns a DateFormat object that can be used to format dates and times in the default 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.

getInstanceForSkeleton

Added in API level 24

static fun getInstanceForSkeleton(
    skeleton: String!, 
    locale: ULocale!
): DateFormat!

[icu] Returns a DateFormat object that can be used to format dates and times in 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	ULocale!: The locale for which the date/time format is desired.

getInstanceForSkeleton

Added in API level 24

static fun getInstanceForSkeleton(
    skeleton: String!, 
    locale: Locale!
): DateFormat!

[icu] Returns a DateFormat object that can be used to format dates and times in 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.

getNumberFormat

Added in API level 24

open fun getNumberFormat(): NumberFormat!

Returns the number formatter which this date/time formatter uses to format and parse a time.

Return
NumberFormat!	the number formatter which this date/time formatter uses.

getPatternInstance

Added in API level 24

static fun getPatternInstance(
    cal: Calendar!, 
    skeleton: String!, 
    locale: ULocale!
): DateFormat!

[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.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
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	ULocale!: The locale for which the date/time format is desired.

getPatternInstance

Added in API level 24

static fun getPatternInstance(
    cal: Calendar!, 
    skeleton: String!, 
    locale: Locale!
): DateFormat!

[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.

Parameters
cal	Calendar!: The calendar system for which a date/time format is desired.
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.

getPatternInstance

Added in API level 24

static fun getPatternInstance(skeleton: String!): DateFormat!

[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.

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.

getPatternInstance

Added in API level 24

static fun getPatternInstance(
    skeleton: String!, 
    locale: ULocale!
): DateFormat!

[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.

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	ULocale!: The locale for which the date/time format is desired.

getPatternInstance

Added in API level 24

static fun getPatternInstance(
    skeleton: String!, 
    locale: Locale!
): DateFormat!

[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.

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.

getTimeInstance

Added in API level 24

static fun getTimeInstance(): DateFormat!

Gets the time formatter with the default formatting style for the default FORMAT locale.

Return
DateFormat!	a time formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getTimeInstance

Added in API level 24

static fun getTimeInstance(
    cal: Calendar!, 
    timeStyle: Int
): DateFormat!

Creates a DateFormat object that can be used to format times in the calendar system specified by cal.

Parameters
cal	Calendar!: The calendar system for which a time format is desired.
timeStyle	Int: The type of time format desired. This can be DateFormat.SHORT, DateFormat.MEDIUM, etc.

See Also

getTimeInstance

Added in API level 24

static fun getTimeInstance(
    cal: Calendar!, 
    timeStyle: Int, 
    locale: ULocale!
): DateFormat!

Creates a DateFormat object that can be used to format times in the calendar system specified by cal.

Parameters
cal	Calendar!: The calendar system for which a time format is desired.
timeStyle	Int: The type of time format desired. This can be DateFormat.SHORT, DateFormat.MEDIUM, etc.
locale	ULocale!: The locale for which the time format is desired.

See Also

getTimeInstance

Added in API level 24

static fun getTimeInstance(
    cal: Calendar!, 
    timeStyle: Int, 
    locale: Locale!
): DateFormat!

Creates a DateFormat object that can be used to format times in the calendar system specified by cal.

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

See Also

getTimeInstance

Added in API level 24

static fun getTimeInstance(style: Int): DateFormat!

Returns the time formatter with the given formatting style for the default FORMAT locale.

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.

Return
DateFormat!	a time formatter.

See Also

• android.icu.util.ULocale.Category#FORMAT

getTimeInstance

Added in API level 24

static fun getTimeInstance(
    style: Int, 
    locale: ULocale!
): DateFormat!

Returns the time formatter with the given formatting style for the given locale.

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.
locale	ULocale!: the given ulocale.

Return
DateFormat!	a time formatter.

getTimeInstance

Added in API level 24

static fun getTimeInstance(
    style: Int, 
    aLocale: Locale!
): DateFormat!

Returns the time formatter with the given formatting style for the given locale.

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.

Return
DateFormat!	a time formatter.

getTimeZone

Added in API level 24

open fun getTimeZone(): TimeZone!

Returns the time zone.

Return
TimeZone!	the time zone associated with the calendar of DateFormat.

hashCode

Added in API level 24

open fun hashCode(): Int

Overrides hashCode.

Return
Int	a hash code value for this object.

isCalendarLenient

Added in API level 24

open fun isCalendarLenient(): Boolean

Returns whether date/time parsing in the encapsulated Calendar object is lenient.

isLenient

Added in API level 24

open fun isLenient(): Boolean

Returns whether both date/time parsing in the encapsulated Calendar object and DateFormat whitespace & numeric processing is lenient.

parse

Added in API level 24

open fun parse(text: String!): Date!

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.

Parameters
text	String!: The date/time string to be parsed

Return
Date!	A Date, or null if the input could not be parsed

Exceptions
java.text.ParseException	If the given string cannot be parsed as a date.

See Also

• #parse(String, ParsePosition)

parse

Added in API level 24

abstract fun parse(
    text: String!, 
    cal: Calendar!, 
    pos: ParsePosition!
): Unit

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 Calendar that is equivalent to Date(837039928046). Before calling this method the caller should initialize the calendar in one of two ways (unless existing field information is to be kept): (1) clear the calendar, or (2) set the calendar to the current date (or to any date whose fields should be used to supply values that are missing in the parsed date). For example, Chinese calendar dates do not normally provide an era/cycle; in this case the calendar that is passed in should be set to a date within the era that should be assumed, normally the current era.

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

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.

See Also

• #setLenient(boolean)

parse

Added in API level 24

open fun parse(
    text: String!, 
    pos: ParsePosition!
): Date!

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.

Parameters
text	String!: The date/time string to be parsed
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.

Return
Date!	A Date, or null if the input could not be parsed

See Also

• #setLenient(boolean)

parseObject

Added in API level 24

open fun parseObject(
    source: String!, 
    pos: ParsePosition!
): Any!

Parses a date/time string into an Object. This convenience method simply calls parse(String, ParsePosition).

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.

Return
Any!	An Object parsed from the string. In case of error, returns null.

Exceptions
java.lang.NullPointerException	if source or pos is null.

See Also

• #parse(String, ParsePosition)

setBooleanAttribute

Added in API level 24

open fun setBooleanAttribute(
    key: DateFormat.BooleanAttribute!, 
    value: Boolean
): DateFormat!

Sets a boolean attribute for this instance. Aspects of DateFormat leniency are controlled by boolean attributes.

See Also

• android.icu.text.DateFormat.BooleanAttribute

setCalendar

Added in API level 24

open fun setCalendar(newCalendar: Calendar!): Unit

Sets the calendar to be used by this date format. Initially, the default calendar for the specified or default locale is used.

Parameters
newCalendar	Calendar!: the new Calendar to be used by the date format

setCalendarLenient

Added in API level 24

open fun setCalendarLenient(lenient: Boolean): Unit

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.

Parameters
lenient	Boolean: when true, Calendar parsing is lenient

See Also

• android.icu.util.Calendar#setLenient

setContext

Added in API level 24

open fun setContext(context: DisplayContext!): Unit

[icu] Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE.

Parameters
context	DisplayContext!: The DisplayContext value to set.

setLenient

Added in API level 24

open fun setLenient(lenient: Boolean): Unit

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.

Parameters
lenient	Boolean: True specifies date/time interpretation to be lenient.

See Also

• android.icu.util.Calendar#setLenient
• #setBooleanAttribute(BooleanAttribute, boolean)
• #setCalendarLenient(boolean)

setNumberFormat

Added in API level 24

open fun setNumberFormat(newNumberFormat: NumberFormat!): Unit

Sets the number formatter.

Parameters
newNumberFormat	NumberFormat!: the given new NumberFormat.

setTimeZone

Added in API level 24

open fun setTimeZone(zone: TimeZone!): Unit

Sets the time zone for the calendar of this DateFormat object.

Parameters
zone	TimeZone!: the given new time zone.

Properties

calendar

Added in API level 24

protected var 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

Added in API level 24

protected var 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.