Added in API level 26

TemporalAccessor

interface TemporalAccessor
DayOfWeek

A day-of-week, such as 'Tuesday'.

Era

An era of the time-line.

Month

A month-of-year, such as 'July'.

MonthDay

A month-day in the ISO-8601 calendar system, such as --12-03.

Temporal

Framework-level interface defining read-write access to a temporal object, such as a date, time, offset or some combination of these.

ZoneOffset

A time-zone offset from Greenwich/UTC, such as +02:00.

ChronoLocalDate

A date without time-of-day or time-zone in an arbitrary chronology, intended for advanced globalization use cases.

ChronoLocalDateTime

A date-time without a time-zone in an arbitrary chronology, intended for advanced globalization use cases.

ChronoZonedDateTime

A date-time with a time-zone in an arbitrary chronology, intended for advanced globalization use cases.

DayOfWeek.FRIDAY

The singleton instance for the day-of-week of Friday.

DayOfWeek.MONDAY

The singleton instance for the day-of-week of Monday.

DayOfWeek.SATURDAY

The singleton instance for the day-of-week of Saturday.

DayOfWeek.SUNDAY

The singleton instance for the day-of-week of Sunday.

DayOfWeek.THURSDAY

The singleton instance for the day-of-week of Thursday.

DayOfWeek.TUESDAY

The singleton instance for the day-of-week of Tuesday.

DayOfWeek.WEDNESDAY

The singleton instance for the day-of-week of Wednesday.

HijrahDate

A date in the Hijrah calendar system.

HijrahDate

A date in the Hijrah calendar system.

HijrahEra

An era in the Hijrah calendar system.

HijrahEra.AH

The singleton instance for the current era, 'Anno Hegirae', which has the numeric value 1.

Instant

An instantaneous point on the time-line.

IsoEra

An era in the ISO calendar system.

IsoEra.BCE

The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0.

IsoEra.CE

The singleton instance for the current era, 'Current Era', which has the numeric value 1.

JapaneseDate

A date in the Japanese Imperial calendar system.

JapaneseDate

A date in the Japanese Imperial calendar system.

JapaneseEra

An era in the Japanese Imperial calendar system.

LocalDate

A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.

LocalDate

A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.

LocalDateTime

A date-time without a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30.

LocalDateTime

A date-time without a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30.

LocalTime

A time without a time-zone in the ISO-8601 calendar system, such as 10:15:30.

MinguoDate

A date in the Minguo calendar system.

MinguoDate

A date in the Minguo calendar system.

MinguoEra

An era in the Minguo calendar system.

MinguoEra.BEFORE_ROC

The singleton instance for the era before the current one, 'Before Republic of China Era', which has the numeric value 0.

MinguoEra.ROC

The singleton instance for the current era, 'Republic of China Era', which has the numeric value 1.

Month.APRIL

The singleton instance for the month of April with 30 days.

Month.AUGUST

The singleton instance for the month of August with 31 days.

Month.DECEMBER

The singleton instance for the month of December with 31 days.

Month.FEBRUARY

The singleton instance for the month of February with 28 days, or 29 in a leap year.

Month.JANUARY

The singleton instance for the month of January with 31 days.

Month.JULY

The singleton instance for the month of July with 31 days.

Month.JUNE

The singleton instance for the month of June with 30 days.

Month.MARCH

The singleton instance for the month of March with 31 days.

Month.MAY

The singleton instance for the month of May with 31 days.

Month.NOVEMBER

The singleton instance for the month of November with 30 days.

Month.OCTOBER

The singleton instance for the month of October with 31 days.

Month.SEPTEMBER

The singleton instance for the month of September with 30 days.

OffsetDateTime

A date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 2007-12-03T10:15:30+01:00.

OffsetTime

A time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 10:15:30+01:00.

ThaiBuddhistDate

A date in the Thai Buddhist calendar system.

ThaiBuddhistDate

A date in the Thai Buddhist calendar system.

ThaiBuddhistEra

An era in the Thai Buddhist calendar system.

ThaiBuddhistEra.BE

The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.

ThaiBuddhistEra.BEFORE_BE

The singleton instance for the era before the current one, 'Before Buddhist Era', which has the numeric value 0.

Year

A year in the ISO-8601 calendar system, such as 2007.

YearMonth

A year-month in the ISO-8601 calendar system, such as 2007-12.

ZonedDateTime

A date-time with a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30+01:00 Europe/Paris.

ZonedDateTime

A date-time with a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30+01:00 Europe/Paris.

Framework-level interface defining read-only access to a temporal object, such as a date, time, offset or some combination of these.

This is the base interface type for date, time and offset objects. It is implemented by those classes that can provide information as fields or queries.

Most date and time information can be represented as a number. These are modeled using TemporalField with the number held using a long to handle large values. Year, month and day-of-month are simple examples of fields, but they also include instant and offsets. See ChronoField for the standard set of fields.

Two pieces of date/time information cannot be represented by numbers, the chronology and the time-zone. These can be accessed via queries using the static methods defined on TemporalQuery.

A sub-interface, Temporal, extends this definition to one that also supports adjustment and manipulation on more complete temporal objects.

This interface is a framework-level interface that should not be widely used in application code. Instead, applications should create and pass around instances of concrete types, such as LocalDate. There are many reasons for this, part of which is that implementations of this interface may be in calendar systems other than ISO. See java.time.chrono.ChronoLocalDate for a fuller discussion of the issues.

Summary

Public methods
open Int
get(field: TemporalField!)

Gets the value of the specified field as an int.

abstract Long

Gets the value of the specified field as a long.

abstract Boolean

Checks if the specified field is supported.

open R
query(query: TemporalQuery<R>!)

Queries this date-time.

open ValueRange!

Gets the range of valid values for the specified field.

Public methods

get

Added in API level 26
open fun get(field: TemporalField!): Int

Gets the value of the specified field as an int.

This queries the date-time for the value of the specified field. The returned value will always be within the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

Parameters
field TemporalField!: the field to get, not null
Return
Int the value for the field, within the valid range of values
Exceptions
java.time.DateTimeException if a value for the field cannot be obtained or the value is outside the range of valid values for the field
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported or the range of values exceeds an int
java.lang.ArithmeticException if numeric overflow occurs

getLong

Added in API level 26
abstract fun getLong(field: TemporalField!): Long

Gets the value of the specified field as a long.

This queries the date-time for the value of the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

Parameters
field TemporalField!: the field to get, not null
Return
Long the value for the field
Exceptions
java.time.DateTimeException if a value for the field cannot be obtained
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported
java.lang.ArithmeticException if numeric overflow occurs

isSupported

Added in API level 26
abstract fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if the date-time can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

Parameters
field TemporalField!: the field to check, null returns false
Return
Boolean true if this date-time can be queried for the field, false if not

query

Added in API level 26
open fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this date-time.

This queries this date-time using the specified query strategy object.

Queries are a key tool for extracting information from date-times. They exists to externalize the process of querying, permitting different approaches, as per the strategy design pattern. Examples might be a query that checks if the date is the day before February 29th in a leap year, or calculates the number of days to your next birthday.

The most common query implementations are method references, such as LocalDate::from and ZoneId::from. Additional implementations are provided as static methods on TemporalQuery.

Parameters
<R> the type of the result
query TemporalQuery<R>!: the query to invoke, not null
Return
R the query result, null may be returned (defined by the query)
Exceptions
java.time.DateTimeException if unable to query
java.lang.ArithmeticException if numeric overflow occurs

range

Added in API level 26
open fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.

Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

Parameters
field TemporalField!: the field to query the range for, not null
Return
ValueRange! the range of valid values for the field, not null
Exceptions
java.time.DateTimeException if the range for the field cannot be obtained
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported