Class DateTimeFormatter

Formatter for printing and parsing date-time objects.

See java.time.format.DateTimeFormatter for full documentation

Hierarchy

DateTimeFormatter

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): string
Formats a date-time object using this formatter.
Parameters
- temporal: TemporalAccessor
Returns string
- Defined in Java.d.ts:4868

getResolverFields

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

Returns Set<TemporalField>
- Defined in Java.d.ts:4892

getZone

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

Returns ZoneId
- Defined in Java.d.ts:4901

parse

parse(text): TemporalAccessor
Fully parses the text producing a temporal object.
Parameters
- text: string
Returns TemporalAccessor
- Defined in Java.d.ts:4910
parse<T>(text, query): 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 Java.d.ts:4919

parseBest

parseBest(text, ...queries): TemporalAccessor
Fully parses the text producing an object of one of the specified types.
Parameters
- text: string
- Rest ...queries: TemporalQueryFn<any>[]
Returns TemporalAccessor
- Defined in Java.d.ts:4923

toFormat

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

Returns Format
- Defined in Java.d.ts:4932
toFormat(parseQuery): 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 Java.d.ts:4936

withResolverFields

withResolverFields(...resolverFields): DateTimeFormatter
Returns a copy of this formatter with a new set of resolver fields.
Parameters
- Rest ...resolverFields: TemporalField[]
Returns DateTimeFormatter
- Defined in Java.d.ts:4955
withResolverFields(resolverFields): DateTimeFormatter
Returns a copy of this formatter with a new set of resolver fields.
Parameters
- resolverFields: Set<TemporalField>
Returns DateTimeFormatter
- Defined in Java.d.ts:4959

withZone

withZone(zone): DateTimeFormatter
Returns a copy of this formatter with a new override zone.
Parameters
- zone: ZoneId
Returns DateTimeFormatter
- Defined in Java.d.ts:4968

`Static` ofLocalizedDate

ofLocalizedDate(dateStyle): DateTimeFormatter
Returns a locale specific date format for the ISO chronology.
Parameters
- dateStyle: FormatStyle
Returns DateTimeFormatter
- Defined in Java.d.ts:4835

`Static` ofLocalizedDateTime

ofLocalizedDateTime(dateTimeStyle): DateTimeFormatter
Returns a locale specific date-time formatter for the ISO chronology.
Parameters
- dateTimeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in Java.d.ts:4839
ofLocalizedDateTime(dateStyle, timeStyle): DateTimeFormatter
Returns a locale specific date and time format for the ISO chronology.
Parameters
- dateStyle: FormatStyle
- timeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in Java.d.ts:4843

`Static` ofLocalizedTime

ofLocalizedTime(timeStyle): DateTimeFormatter
Returns a locale specific time format for the ISO chronology.
Parameters
- timeStyle: FormatStyle
Returns DateTimeFormatter
- Defined in Java.d.ts:4847

`Static` ofPattern

ofPattern(pattern): DateTimeFormatter
Creates a formatter using the specified pattern.
Parameters
- pattern: string
Returns DateTimeFormatter
- Defined in 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 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 Java.d.ts:4864

Class DateTimeFormatter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DateTimeFormatter

Properties

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

Methods

format

Parameters

temporal: TemporalAccessor

Returns string

getResolverFields

Returns Set<TemporalField>

getZone

Returns ZoneId

parse

Parameters

text: string

Returns TemporalAccessor

Type Parameters

T

Parameters

text: string

query: TemporalQueryFn<T>

Returns T

parseBest

Parameters

text: string

Rest ...queries: TemporalQueryFn<any>[]

Returns TemporalAccessor

toFormat

Returns Format

Parameters

parseQuery: TemporalQueryFn<any>

Returns Format

withResolverFields

Parameters

Rest ...resolverFields: TemporalField[]

Returns DateTimeFormatter

Parameters

resolverFields: Set<TemporalField>

Returns DateTimeFormatter

withZone

Parameters

zone: ZoneId

Returns DateTimeFormatter

Static ofLocalizedDate

Parameters

dateStyle: FormatStyle

Returns DateTimeFormatter

Static ofLocalizedDateTime

Parameters

dateTimeStyle: FormatStyle

Returns DateTimeFormatter

Parameters

dateStyle: FormatStyle

timeStyle: FormatStyle

Returns DateTimeFormatter

Static ofLocalizedTime

Parameters

timeStyle: FormatStyle

`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

`Rest` ...queries: TemporalQueryFn<any>[]

`Rest` ...resolverFields: TemporalField[]

`Static` ofLocalizedDate

`Static` ofLocalizedDateTime

`Static` ofLocalizedTime

`Static` ofPattern

`Static` parsedExcessDays

`Static` parsedLeapSecond