Added in API level 1

SimpleDateFormat

open class SimpleDateFormat : DateFormat

kotlin.Any
↳	java.text.Format
	↳	java.text.DateFormat
		↳	java.text.SimpleDateFormat

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

SimpleDateFormat allows you to start by choosing any user-defined patterns for date-time formatting. However, you are encouraged to create a date-time formatter with either getTimeInstance, getDateInstance, or getDateTimeInstance in DateFormat. Each of these class methods can return a date/time formatter initialized with a default format pattern. You may modify the format pattern using the applyPattern methods as desired. For more information on using these methods, see DateFormat.

Date and Time Patterns

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.

The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

Chart shows pattern letters, date/time component, presentation, and examples.

Letter	Date or Time Component	Presentation	Examples	Supported (API Levels)
`G`	Era designator	Text	`AD`	1+
`y`	Year	Year	`1996`; `96`	1+
`Y`	Week year	Year	`2009`; `09`	24+
`M`	Month in year (context sensitive)	Month	`July`; `Jul`; `07`	1+
`L`	Month in year (standalone form)	Month	`July`; `Jul`; `07`	TBD
`w`	Week in year	Number	`27`	1+
`W`	Week in month	Number	`2`	1+
`D`	Day in year	Number	`189`	1+
`d`	Day in month	Number	`10`	1+
`F`	Day of week in month	Number	`2`	1+
`E`	Day name in week	Text	`Tuesday`; `Tue`	1+
`u`	Day number of week (1 = Monday, ..., 7 = Sunday)	Number	`1`	24+
`a`	Am/pm marker	Text	`PM`	1+
`H`	Hour in day (0-23)	Number	`0`	1+
`k`	Hour in day (1-24)	Number	`24`	1+
`K`	Hour in am/pm (0-11)	Number	`0`	1+
`h`	Hour in am/pm (1-12)	Number	`12`	1+
`m`	Minute in hour	Number	`30`	1+
`s`	Second in minute	Number	`55`	1+
`S`	Millisecond	Number	`978`	1+
`z`	Time zone	General time zone	`Pacific Standard Time`; `PST`; `GMT-08:00`	1+
`Z`	Time zone	RFC 822 time zone	`-0800`	1+
`X`	Time zone	ISO 8601 time zone	`-08`; `-0800`; `-08:00`	24+

Pattern letters are usually repeated, as their number determines the exact presentation:

Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's needed to separate two adjacent fields.
Year: If the formatter's Calendar is the Gregorian calendar, the following rules are applied.
- For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.
- For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.
- For parsing with the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, as defined by Character.isDigit(char), will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isn't all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.
Otherwise, calendar system specific forms are applied. For both formatting and parsing, if the number of pattern letters is 4 or more, a calendar specific long form is used. Otherwise, a calendar specific short or abbreviated form is used.
If week year 'Y' is specified and the calendar doesn't support any week years, the calendar year ('y') is used instead. The support of week years can be tested with a call to getCalendar(). isWeekDateSupported().
Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
- Letter M produces context-sensitive month names, such as the embedded form of names. Letter M is context-sensitive in the sense that when it is used in the standalone pattern, for example, "MMMM", it gives the standalone form of a month name and when it is used in the pattern containing other field(s), for example, "d MMMM", it gives the format form of a month name. For example, January in the Catalan language is "de gener" in the format form while it is "gener" in the standalone form. In this case, "MMMM" will produce "gener" and the month part of the "d MMMM" will produce "de gener". If a DateFormatSymbols has been set explicitly with constructor SimpleDateFormat(java.lang.String,java.text.DateFormatSymbols) or method setDateFormatSymbols(java.text.DateFormatSymbols), the month names given by the DateFormatSymbols are used.
- Letter L produces the standalone form of month names.
General time zone: Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:
```
<a id="GMTOffsetTimeZone">GMTOffsetTimeZone:</a><code>GMT</code>SignHours<code>:</code>MinutesSign:one of
 <code>+ -</code>Hours:DigitDigitDigitMinutes:DigitDigitDigit:one of
 <code>0 1 2 3 4 5 6 7 8 9</code>
```
Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.
For parsing, RFC 822 time zones are also accepted.
RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:
```
RFC822TimeZone:SignTwoDigitHoursMinutesTwoDigitHours:Digit Digit
```
TwoDigitHours must be between 00 and 23. Other definitions are as for general time zones.
For parsing, general time zones are also accepted.
ISO 8601 Time zone: The number of pattern letters designates the format for both formatting and parsing as follows:
```
ISO8601TimeZone:OneLetterISO8601TimeZoneTwoLetterISO8601TimeZoneThreeLetterISO8601TimeZoneOneLetterISO8601TimeZone:SignTwoDigitHours<code>Z</code>TwoLetterISO8601TimeZone:SignTwoDigitHoursMinutes<code>Z</code>ThreeLetterISO8601TimeZone:SignTwoDigitHours<code>:</code>Minutes<code>Z</code>
```
Other definitions are as for general time zones or RFC 822 time zones.
For formatting, if the offset value from GMT is 0, "Z" is produced. If the number of pattern letters is 1, any fraction of an hour is ignored. For example, if the pattern is "X" and the time zone is "GMT+05:30", "+05" is produced.

For parsing, the letter "Z" is parsed as the UTC time zone designator (therefore "09:30Z" is parsed as "09:30 UTC". General time zones are not accepted.

If the number of "X" pattern letters is 4 or more (e.g. XXXX), IllegalArgumentException is thrown when constructing a SimpleDateFormat or applying a.

SimpleDateFormat also supports localized date and time pattern strings. In these strings, the pattern letters described above may be replaced with other, locale dependent, pattern letters. SimpleDateFormat does not deal with the localization of text other than the pattern letters; that's up to the client of the class.

Examples

The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone. Examples of date and time patterns interpreted in the U.S. locale

Date and Time Pattern	Result
`"yyyy.MM.dd G 'at' HH:mm:ss z"`	`2001.07.04 AD at 12:08:56 PDT`
`"EEE, MMM d, ''yy"`	`Wed, Jul 4, '01`
`"h:mm a"`	`12:08 PM`
`"hh 'o''clock' a, zzzz"`	`12 o'clock PM, Pacific Daylight Time`
`"K:mm a, z"`	`0:08 PM, PDT`
`"yyyyy.MMMMM.dd GGG hh:mm aaa"`	`02001.July.04 AD 12:08 PM`
`"EEE, d MMM yyyy HH:mm:ss Z"`	`Wed, 4 Jul 2001 12:08:56 -0700`
`"yyMMddHHmmssZ"`	`010704120856-0700`
`"yyyy-MM-dd'T'HH:mm:ss.SSSZ"`	`2001-07-04T12:08:56.235-0700`
`"yyyy-MM-dd'T'HH:mm:ss.SSSXXX"`	`2001-07-04T12:08:56.235-07:00`
`"YYYY-'W'ww-u"`	`2001-W27-3`

Synchronization

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

Summary

Inherited constants

From class DateFormat

`Int`	`AM_PM_FIELD` Useful constant for AM_PM field alignment. Used in FieldPosition of date/time formatting.
`Int`	`DATE_FIELD` Useful constant for DATE field alignment. Used in FieldPosition of date/time formatting.
`Int`	`DAY_OF_WEEK_FIELD` Useful constant for DAY_OF_WEEK field alignment. Used in FieldPosition of date/time formatting.
`Int`	`DAY_OF_WEEK_IN_MONTH_FIELD` Useful constant for DAY_OF_WEEK_IN_MONTH field alignment. Used in FieldPosition of date/time formatting.
`Int`	`DAY_OF_YEAR_FIELD` Useful constant for DAY_OF_YEAR field alignment. Used in FieldPosition of date/time formatting.
`Int`	`DEFAULT` Constant for default style pattern. Its value is MEDIUM.
`Int`	`ERA_FIELD` Useful constant for ERA field alignment. Used in FieldPosition of date/time formatting.
`Int`	`FULL` Constant for full style pattern.
`Int`	`HOUR0_FIELD` Useful constant for zero-based HOUR field alignment. Used in FieldPosition of date/time formatting. HOUR0_FIELD is used for the zero-based 12-hour clock. For example, 11:30 PM + 1 hour results in 00:30 AM.
`Int`	`HOUR1_FIELD` Useful constant for one-based HOUR field alignment. Used in FieldPosition of date/time formatting. HOUR1_FIELD is used for the one-based 12-hour clock. For example, 11:30 PM + 1 hour results in 12:30 AM.
`Int`	`HOUR_OF_DAY0_FIELD` Useful constant for zero-based HOUR_OF_DAY field alignment. Used in FieldPosition of date/time formatting. HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock. For example, 23:59 + 01:00 results in 00:59.
`Int`	`HOUR_OF_DAY1_FIELD` Useful constant for one-based HOUR_OF_DAY field alignment. Used in FieldPosition of date/time formatting. HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock. For example, 23:59 + 01:00 results in 24:59.
`Int`	`LONG` Constant for long style pattern.
`Int`	`MEDIUM` Constant for medium style pattern.
`Int`	`MILLISECOND_FIELD` Useful constant for MILLISECOND field alignment. Used in FieldPosition of date/time formatting.
`Int`	`MINUTE_FIELD` Useful constant for MINUTE field alignment. Used in FieldPosition of date/time formatting.
`Int`	`MONTH_FIELD` Useful constant for MONTH field alignment. Used in FieldPosition of date/time formatting.
`Int`	`SECOND_FIELD` Useful constant for SECOND field alignment. Used in FieldPosition of date/time formatting.
`Int`	`SHORT` Constant for short style pattern.
`Int`	`TIMEZONE_FIELD` Useful constant for TIMEZONE field alignment. Used in FieldPosition of date/time formatting.
`Int`	`WEEK_OF_MONTH_FIELD` Useful constant for WEEK_OF_MONTH field alignment. Used in FieldPosition of date/time formatting.
`Int`	`WEEK_OF_YEAR_FIELD` Useful constant for WEEK_OF_YEAR field alignment. Used in FieldPosition of date/time formatting.
`Int`	`YEAR_FIELD` Useful constant for YEAR field alignment. Used in FieldPosition of date/time formatting.

Public constructors
`SimpleDateFormat()` Constructs a `SimpleDateFormat` using the default pattern and date format symbols for the default `FORMAT` locale.
`SimpleDateFormat(pattern: String!)` Constructs a `SimpleDateFormat` using the given pattern and the default date format symbols for the default `FORMAT` locale.
`SimpleDateFormat(pattern: String!, formatSymbols: DateFormatSymbols!)` Constructs a `SimpleDateFormat` using the given pattern and date format symbols.
`SimpleDateFormat(pattern: String!, locale: Locale!)` Constructs a `SimpleDateFormat` using the given pattern and the default date format symbols for the given locale.

Public methods
open Unit	`applyLocalizedPattern(pattern: String!)` Applies the given localized pattern string to this date format.
open Unit	`applyPattern(pattern: String!)` Applies the given pattern string to this date format.
open Any	`clone()` Creates a copy of this `SimpleDateFormat`.
open Boolean	`equals(other: Any?)` Compares the given object with this `SimpleDateFormat` for equality.
open StringBuffer	`format(date: Date, toAppendTo: StringBuffer, pos: FieldPosition)` Formats the given `Date` into a date/time string and appends the result to the given `StringBuffer`.
open AttributedCharacterIterator!	`formatToCharacterIterator(obj: Any!)` Formats an Object producing an `AttributedCharacterIterator`.
open Date!	`get2DigitYearStart()` Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.
open DateFormatSymbols!	`getDateFormatSymbols()` Gets a copy of the date and time format symbols of this date format.
open Int	`hashCode()` Returns the hash code value for this `SimpleDateFormat` object.
open Date?	`parse(text: String, pos: ParsePosition)` Parses text from a string to produce a `Date`.
open Unit	`set2DigitYearStart(startDate: Date!)` Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.
open Unit	`setDateFormatSymbols(newFormatSymbols: DateFormatSymbols!)` Sets the date and time format symbols of this date format.
open String!	`toLocalizedPattern()` Returns a localized pattern string describing this date format.
open String!	`toPattern()` Returns a pattern string describing this date format.

Inherited functions

From class DateFormat

`StringBuffer`	`format(obj: Any, toAppendTo: StringBuffer, fieldPosition: FieldPosition)` Formats the given `Object` into a date-time string. The formatted string is appended to the given `StringBuffer`.
`String`	`format(date: Date)` Formats a `Date` into a date-time string.
`Array<Locale!>`	`getAvailableLocales()` Returns an array of all locales for which the `get*Instance` methods of this class can return localized instances. It must contain at least a `Locale` instance equal to `Locale.US`.
`Calendar`	`getCalendar()` Gets the calendar associated with this date/time formatter.
`DateFormat`	`getDateInstance()` Gets the date formatter with the default formatting style for the default `FORMAT` locale. This is equivalent to calling `getDateInstance(DEFAULT,`.
`DateFormat`	`getDateInstance(style: Int)` Gets the date formatter with the given formatting style for the default `FORMAT` locale. This is equivalent to calling `getDateInstance(style,`.
`DateFormat`	`getDateInstance(style: Int, aLocale: Locale)` Gets the date formatter with the given formatting style for the given locale.
`DateFormat`	`getDateTimeInstance()` Gets the date/time formatter with the default formatting style for the default `FORMAT` locale. This is equivalent to calling `getDateTimeInstance(DEFAULT,`.
`DateFormat`	`getDateTimeInstance(dateStyle: Int, timeStyle: Int)` Gets the date/time formatter with the given date and time formatting styles for the default `FORMAT` locale. This is equivalent to calling `getDateTimeInstance(dateStyle,`.
`DateFormat`	`getDateTimeInstance(dateStyle: Int, timeStyle: Int, aLocale: Locale)` Gets the date/time formatter with the given formatting styles for the given locale.
`DateFormat`	`getInstance()` Get a default date/time formatter that uses the SHORT style for both the date and the time.
`NumberFormat`	`getNumberFormat()` Gets the number formatter which this date/time formatter uses to format and parse a time.
`DateFormat`	`getTimeInstance()` Gets the time formatter with the default formatting style for the default `FORMAT` locale. This is equivalent to calling `getTimeInstance(DEFAULT,`.
`DateFormat`	`getTimeInstance(style: Int)` Gets the time formatter with the given formatting style for the default `FORMAT` locale. This is equivalent to calling `getTimeInstance(style,`.
`DateFormat`	`getTimeInstance(style: Int, aLocale: Locale)` Gets the time formatter with the given formatting style for the given locale.
`TimeZone`	`getTimeZone()` Gets the time zone. This method is equivalent to the following call. <code>getCalendar().getTimeZone() </code>
`Boolean`	`isLenient()` Tell whether date/time parsing is to be lenient. This method is equivalent to the following call. <code>getCalendar().isLenient() </code>
`Date?`	`parse(source: String)` Parses text from the beginning of the given string to produce a date. The method may not use the entire text of the given string. See the `parse(java.lang.String,java.text.ParsePosition)` method for more information on date parsing. WARNING: Don't use this method to deserialize a date. The underlying localized date/time format and parsing behaviors can change across Android versions as common usage in the locale changes. Consider using `long` type for storing a timestamp or `java.time.format.DateTimeFormatter#ISO_INSTANT` for deserializing the ISO-8601 instant format.
`Any?`	`parseObject(source: String, pos: ParsePosition)` Parses text from a string to produce a `Date`. The method attempts to parse text starting at the index given by `pos`. If parsing succeeds, then the index of `pos` is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed date is returned. The updated `pos` can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of `pos` is not changed, the error index of `pos` is set to the index of the character where the error occurred, and null is returned. See the `parse(java.lang.String,java.text.ParsePosition)` method for more information on date parsing.
`Unit`	`setCalendar(newCalendar: Calendar)` Set the calendar to be used by this date format. Initially, the default calendar for the specified or default locale is used. Any `TimeZone` and leniency values that have previously been set are overwritten by `newCalendar`'s values.
`Unit`	`setLenient(lenient: Boolean)` Specify whether or not 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. With strict parsing, inputs must match this object's format. This method is equivalent to the following call. <code>getCalendar().setLenient(lenient) </code> This leniency value is overwritten by a call to `setCalendar()`.
`Unit`	`setNumberFormat(newNumberFormat: NumberFormat)` Allows you to set the number formatter.
`Unit`	`setTimeZone(zone: TimeZone)` Sets the time zone for the calendar of this `DateFormat` object. This method is equivalent to the following call. <code>getCalendar().setTimeZone(zone) </code> The `TimeZone` set by this method is overwritten by a `setCalendar` call. The `TimeZone` set by this method may be overwritten as a result of a call to the parse method.

From class Format

String!

format(obj: Any!)

Formats an object to produce a string. This is equivalent to format(obj, new StringBuffer(), new FieldPosition(0)).toString();

AttributedCharacterIterator!

formatToCharacterIterator(obj: Any!)

Formats an Object producing an AttributedCharacterIterator. You can use the returned AttributedCharacterIterator to build the resulting String, as well as to determine information about the resulting String.

Each attribute key of the AttributedCharacterIterator will be of type Field. It is up to each Format implementation to define what the legal values are for each attribute in the AttributedCharacterIterator, but typically the attribute key is also used as the attribute value.

The default implementation creates an AttributedCharacterIterator with no attributes. Subclasses that support fields should override this and create an AttributedCharacterIterator with meaningful attributes.

Any!

parseObject(source: String!)

Parses text from the beginning of the given string to produce an object. The method may not use the entire text of the given string.

Inherited properties

From class DateFormat

Calendar

calendar

The Calendar instance used for calculating the date-time fields and the instant of time. This field is used for both formatting and parsing.

Subclasses should initialize this field to a Calendar appropriate for the Locale associated with this DateFormat.

NumberFormat

numberFormat

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

Public constructors

SimpleDateFormat

Added in API level 1

SimpleDateFormat()

Constructs a SimpleDateFormat using the default pattern and date format symbols for the default FORMAT locale. Note: This constructor may not support all locales. For full coverage, use the factory methods in the DateFormat class.

SimpleDateFormat

Added in API level 1

SimpleDateFormat(pattern: String!)

Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the default FORMAT locale. Note: This constructor may not support all locales. For full coverage, use the factory methods in the DateFormat class.

This is equivalent to calling SimpleDateFormat(pattern, Locale.getDefault(Locale.Category.FORMAT)).

Parameters
`pattern`	String!: the pattern describing the date and time format

Exceptions
`java.lang.NullPointerException`	if the given pattern is null
`java.lang.IllegalArgumentException`	if the given pattern is invalid

See Also

SimpleDateFormat

Added in API level 1

SimpleDateFormat(
    pattern: String!, 
    formatSymbols: DateFormatSymbols!)

Constructs a SimpleDateFormat using the given pattern and date format symbols.

Parameters
`pattern`	String!: the pattern describing the date and time format
`formatSymbols`	DateFormatSymbols!: the date format symbols to be used for formatting

Exceptions
`java.lang.NullPointerException`	if the given pattern or formatSymbols is null
`java.lang.IllegalArgumentException`	if the given pattern is invalid

SimpleDateFormat

Added in API level 1

SimpleDateFormat(
    pattern: String!, 
    locale: Locale!)

Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the given locale. Note: This constructor may not support all locales. For full coverage, use the factory methods in the DateFormat class.

Parameters
`pattern`	String!: the pattern describing the date and time format
`locale`	Locale!: the locale whose date format symbols should be used

Exceptions
`java.lang.NullPointerException`	if the given pattern or locale is null
`java.lang.IllegalArgumentException`	if the given pattern is invalid

Public methods

applyLocalizedPattern

Added in API level 1

open fun applyLocalizedPattern(pattern: String!): Unit

Applies the given localized pattern string to this date format.

Parameters
`pattern`	String!: a String to be mapped to the new date and time format pattern for this format

Exceptions
`java.lang.NullPointerException`	if the given pattern is null
`java.lang.IllegalArgumentException`	if the given pattern is invalid

applyPattern

Added in API level 1

open fun applyPattern(pattern: String!): Unit

Applies the given pattern string to this date format.

Parameters
`pattern`	String!: the new date and time pattern for this date format

Exceptions
`java.lang.NullPointerException`	if the given pattern is null
`java.lang.IllegalArgumentException`	if the given pattern is invalid

clone

Added in API level 1

open fun clone(): Any

Creates a copy of this SimpleDateFormat. This also clones the format's date format symbols.

Return
`Any`	a clone of this `SimpleDateFormat`

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 1

open fun equals(other: Any?): Boolean

Compares the given object with this SimpleDateFormat for equality.

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	true if the given object is equal to this `SimpleDateFormat`

format

Added in API level 1

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

Formats the given Date into a date/time string and appends the result to the given StringBuffer.

Parameters
`date`	Date: the date-time value to be formatted into a date-time string.
`toAppendTo`	StringBuffer: where the new date-time text is to be appended.
`fieldPosition`	keeps track on the position of the field within the returned string. For example, given a date-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 date-time field appears more than once in a pattern, the `fieldPosition` will be set for the first occurrence of that date-time field. For instance, formatting a `Date` to the date-time string `"1 PM PDT (Pacific Daylight Time)"` using the pattern `"h a z (zzzz)"` and the alignment field `DateFormat.TIMEZONE_FIELD`, the begin index and end index of `fieldPosition` will be set to 5 and 8, respectively, for the first occurrence of the timezone pattern character `'z'`.
`pos`	FieldPosition: keeps track on the position of the field within the returned string. For example, given a date-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 date-time field appears more than once in a pattern, the `fieldPosition` will be set for the first occurrence of that date-time field. For instance, formatting a `Date` to the date-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.

Exceptions
`java.lang.NullPointerException`	if any of the parameters is `null`.

formatToCharacterIterator

Added in API level 1

open fun formatToCharacterIterator(obj: Any!): AttributedCharacterIterator!

Each attribute key of the AttributedCharacterIterator will be of type DateFormat.Field, with the corresponding attribute value being the same as the attribute key.

Parameters
`obj`	Any!: The object to format

Return
`AttributedCharacterIterator!`	AttributedCharacterIterator describing the formatted value.

Exceptions
`java.lang.NullPointerException`	if obj is null.
`java.lang.IllegalArgumentException`	if the Format cannot format the given object, or if the Format's pattern string is invalid.

get2DigitYearStart

Added in API level 1

open fun get2DigitYearStart(): Date!

Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.

Return
`Date!`	the start of the 100-year period into which two digit years are parsed

See Also

#set2DigitYearStart

getDateFormatSymbols

Added in API level 1

open fun getDateFormatSymbols(): DateFormatSymbols!

Gets a copy of the date and time format symbols of this date format.

Return
`DateFormatSymbols!`	the date and time format symbols of this date format

See Also

#setDateFormatSymbols

hashCode

Added in API level 1

open fun hashCode(): Int

Returns the hash code value for this SimpleDateFormat object.

Return
`Int`	the hash code value for this `SimpleDateFormat` object.

parse

Added in API level 1

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

Parses text from a string to produce a Date.

The method attempts to parse text starting at the index given by pos. If parsing succeeds, then the index of pos is updated to the index after the last character used (parsing does not necessarily use all characters up to the end of the string), and the parsed date is returned. The updated pos can be used to indicate the starting point for the next call to this method. If an error occurs, then the index of pos is not changed, the error index of pos is set to the index of the character where the error occurred, and null is returned.

This parsing operation uses the calendar to produce a Date. All of the calendar's date-time fields are cleared before parsing, and the calendar's default values of the date-time fields are used for any missing date-time information. For example, the year value of the parsed Date is 1970 with GregorianCalendar if no year value is given from the parsing operation. The TimeZone value may be overwritten, depending on the given pattern and the time zone value in text. Any TimeZone value that has previously been set by a call to setTimeZone may need to be restored for further operations.

WARNING: Don't use this method to deserialize a date. The underlying localized date/time format and parsing behaviors can change across Android versions as common usage in the locale changes. Consider using long type for storing a timestamp or java.time.format.DateTimeFormatter#ISO_INSTANT for deserializing the ISO-8601 instant format.

Parameters
`source`	The date/time string to be parsed
`pos`	ParsePosition: A `ParsePosition` object with index and error index information as described above.
`text`	String: A `String`, part of which should be parsed.

Return
`Date?`	A `Date` parsed from the string. In case of error, returns null.

Exceptions
`java.lang.NullPointerException`	if `text` or `pos` is null.

set2DigitYearStart

Added in API level 1

open fun set2DigitYearStart(startDate: Date!): Unit

Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.

Parameters
`startDate`	Date!: During parsing, two digit years will be placed in the range `startDate` to `startDate + 100 years`.

Exceptions
`java.lang.NullPointerException`	if `startDate` is `null`.

See Also

#get2DigitYearStart

setDateFormatSymbols

Added in API level 1

open fun setDateFormatSymbols(newFormatSymbols: DateFormatSymbols!): Unit

Sets the date and time format symbols of this date format.

Parameters
`newFormatSymbols`	DateFormatSymbols!: the new date and time format symbols

Exceptions
`java.lang.NullPointerException`	if the given newFormatSymbols is null

See Also

#getDateFormatSymbols

toLocalizedPattern

Added in API level 1

open fun toLocalizedPattern(): String!

Returns a localized pattern string describing this date format.

Return
`String!`	a localized pattern string describing this date format.

toPattern

Added in API level 1

open fun toPattern(): String!

Returns a pattern string describing this date format.

Return
`String!`	a pattern string describing this date format.