Class DateTimeFormatter

Formatter for printing and parsing date-time objects.

See java.time.format.DateTimeFormatter for full documentation

Constructors

constructor

new DateTimeFormatter(): DateTimeFormatter
Returns DateTimeFormatter

Properties

`Static`BASIC_ISO_DATE

BASIC_ISO_DATE: DateTimeFormatter

The ISO date formatter that formats or parses a date without an offset, such as '20111203'.

`Static`ISO_DATE

ISO_DATE: DateTimeFormatter

The ISO date formatter that formats or parses a date with the offset if available, such as '2011-12-03' or '2011-12-03+01:00'.

`Static`ISO_DATE_TIME

ISO_DATE_TIME: DateTimeFormatter

The ISO-like date-time formatter that formats or parses a date-time with the offset and zone if available, such as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

`Static`ISO_INSTANT

ISO_INSTANT: DateTimeFormatter

The ISO instant formatter that formats or parses an instant in UTC, such as '2011-12-03T10:15:30Z'.

`Static`ISO_LOCAL_DATE

ISO_LOCAL_DATE: DateTimeFormatter

The ISO date formatter that formats or parses a date without an offset, such as '2011-12-03'.

`Static`ISO_LOCAL_DATE_TIME

ISO_LOCAL_DATE_TIME: DateTimeFormatter

The ISO date-time formatter that formats or parses a date-time without an offset, such as '2011-12-03T10:15:30'.

`Static`ISO_LOCAL_TIME

ISO_LOCAL_TIME: DateTimeFormatter

The ISO time formatter that formats or parses a time without an offset, such as '10:15' or '10:15:30'.

`Static`ISO_OFFSET_DATE

ISO_OFFSET_DATE: DateTimeFormatter

The ISO date formatter that formats or parses a date with an offset, such as '2011-12-03+01:00'.

`Static`ISO_OFFSET_DATE_TIME

ISO_OFFSET_DATE_TIME: DateTimeFormatter

The ISO date-time formatter that formats or parses a date-time with an offset, such as '2011-12-03T10:15:30+01:00'.

`Static`ISO_OFFSET_TIME

ISO_OFFSET_TIME: DateTimeFormatter

The ISO time formatter that formats or parses a time with an offset, such as '10:15+01:00' or '10:15:30+01:00'.

`Static`ISO_ORDINAL_DATE

ISO_ORDINAL_DATE: DateTimeFormatter

The ISO date formatter that formats or parses the ordinal date without an offset, such as '2012-337'.

`Static`ISO_TIME

ISO_TIME: DateTimeFormatter

The ISO time formatter that formats or parses a time, with the offset if available, such as '10:15', '10:15:30' or '10:15:30+01:00'.

`Static`ISO_WEEK_DATE

ISO_WEEK_DATE: DateTimeFormatter

The ISO date formatter that formats or parses the week-based date without an offset, such as '2012-W48-6'.

`Static`ISO_ZONED_DATE_TIME

ISO_ZONED_DATE_TIME: DateTimeFormatter

The ISO-like date-time formatter that formats or parses a date-time with offset and zone, such as '2011-12-03T10:15:30+01:00[Europe/Paris]'.

`Static`RFC_1123_DATE_TIME

RFC_1123_DATE_TIME: DateTimeFormatter

The RFC-1123 date-time formatter, such as 'Tue, 3 Jun 2008 11:05:30 GMT'.

Methods

format

format(temporal: TemporalAccessor): string
Formats a date-time object using this formatter.
Parameters
- temporal: TemporalAccessor
Returns string
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4868

getResolverFields

getResolverFields(): Set<TemporalField>
Gets the resolver fields to use during parsing.

Returns Set<TemporalField>
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4892

getZone

getZone(): ZoneId
Gets the overriding zone to be used during formatting.

Returns ZoneId
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4901

parse

parse(text: string): TemporalAccessor
Fully parses the text producing a temporal object.
Parameters
- text: string
Returns TemporalAccessor
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4910
parse<T>(text: string, query: TemporalQueryFn<T>): T
Fully parses the text producing an object of the specified type.
Type Parameters
- T
Parameters
- text: string
- query: TemporalQueryFn<T>
Returns T
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4919

parseBest

parseBest(text: string, ...queries: TemporalQueryFn<any>[]): TemporalAccessor
Fully parses the text producing an object of one of the specified types.
Parameters
- text: string
- ...queries: TemporalQueryFn<any>[]
Returns TemporalAccessor
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4923

toFormat

toFormat(): Format
Returns this formatter as a java.text.Format instance.

Returns Format
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4932
toFormat(parseQuery: TemporalQueryFn<any>): Format
Returns this formatter as a java.text.Format instance that will parse using the specified query.
Parameters
- parseQuery: TemporalQueryFn<any>
Returns Format
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4936

withResolverFields

withResolverFields(...resolverFields: TemporalField[]): DateTimeFormatter
Returns a copy of this formatter with a new set of resolver fields.
Parameters
- ...resolverFields: TemporalField[]
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4955
withResolverFields(resolverFields: Set<TemporalField>): DateTimeFormatter
Returns a copy of this formatter with a new set of resolver fields.
Parameters
- resolverFields: Set<TemporalField>
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4959

withZone

withZone(zone: ZoneId): DateTimeFormatter
Returns a copy of this formatter with a new override zone.
Parameters
- zone: ZoneId
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4968

`Static`ofLocalizedDate

ofLocalizedDate(dateStyle: FormatStyle): DateTimeFormatter
Returns a locale specific date format for the ISO chronology.
Parameters
- dateStyle: FormatStyle
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4835

`Static`ofLocalizedDateTime

ofLocalizedDateTime(dateTimeStyle: FormatStyle): DateTimeFormatter
Returns a locale specific date-time formatter for the ISO chronology.
Parameters
- dateTimeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4839
ofLocalizedDateTime(
dateStyle: FormatStyle,
timeStyle: FormatStyle,
): DateTimeFormatter
Returns a locale specific date and time format for the ISO chronology.
Parameters
- dateStyle: FormatStyle
- timeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4843

`Static`ofLocalizedTime

ofLocalizedTime(timeStyle: FormatStyle): DateTimeFormatter
Returns a locale specific time format for the ISO chronology.
Parameters
- timeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4847

`Static`ofPattern

ofPattern(pattern: string): DateTimeFormatter
Creates a formatter using the specified pattern.
Parameters
- pattern: string
Returns DateTimeFormatter
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4851

`Static`parsedExcessDays

parsedExcessDays(): TemporalQueryFn<Period>
A query that provides access to the excess days that were parsed.

Returns TemporalQueryFn<Period>
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4860

`Static`parsedLeapSecond

parsedLeapSecond(): TemporalQueryFn<Boolean>
A query that provides access to whether a leap-second was parsed.

Returns TemporalQueryFn<Boolean>
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:4864

Class DateTimeFormatter

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DateTimeFormatter

Properties

StaticBASIC_ISO_DATE

StaticISO_DATE

StaticISO_DATE_TIME

StaticISO_INSTANT

StaticISO_LOCAL_DATE

StaticISO_LOCAL_DATE_TIME

StaticISO_LOCAL_TIME

StaticISO_OFFSET_DATE

StaticISO_OFFSET_DATE_TIME

StaticISO_OFFSET_TIME

StaticISO_ORDINAL_DATE

StaticISO_TIME

StaticISO_WEEK_DATE

StaticISO_ZONED_DATE_TIME

StaticRFC_1123_DATE_TIME

Methods

format

Parameters

Returns string

getResolverFields

Returns Set<TemporalField>

getZone

Returns ZoneId

parse

Parameters

Returns TemporalAccessor

Type Parameters

Parameters

Returns T

parseBest

Parameters

Returns TemporalAccessor

toFormat

Returns Format

Parameters

Returns Format

withResolverFields

Parameters

Returns DateTimeFormatter

Parameters

Returns DateTimeFormatter

withZone

Parameters

Returns DateTimeFormatter

StaticofLocalizedDate

Parameters

Returns DateTimeFormatter

StaticofLocalizedDateTime

Parameters

Returns DateTimeFormatter

Parameters

Returns DateTimeFormatter

StaticofLocalizedTime

Parameters

Returns DateTimeFormatter

StaticofPattern

Parameters

Returns DateTimeFormatter

StaticparsedExcessDays

Returns TemporalQueryFn<Period>

StaticparsedLeapSecond

Returns TemporalQueryFn<Boolean>

Settings

On This Page

`Static`BASIC_ISO_DATE

`Static`ISO_DATE

`Static`ISO_DATE_TIME

`Static`ISO_INSTANT

`Static`ISO_LOCAL_DATE

`Static`ISO_LOCAL_DATE_TIME

`Static`ISO_LOCAL_TIME

`Static`ISO_OFFSET_DATE

`Static`ISO_OFFSET_DATE_TIME

`Static`ISO_OFFSET_TIME

`Static`ISO_ORDINAL_DATE

`Static`ISO_TIME

`Static`ISO_WEEK_DATE

`Static`ISO_ZONED_DATE_TIME

`Static`RFC_1123_DATE_TIME

`Static`ofLocalizedDate

`Static`ofLocalizedDateTime

`Static`ofLocalizedTime

`Static`ofPattern

`Static`parsedExcessDays

`Static`parsedLeapSecond