ChronoLocalDateTime
interface ChronoLocalDateTime<D : ChronoLocalDate!> : Temporal, TemporalAdjuster, Comparable<ChronoLocalDateTime<*>!>
java.time.chrono.ChronoLocalDateTime |
A date-time without a time-zone in an arbitrary chronology, intended for advanced globalization use cases.
Most applications should declare method signatures, fields and variables as LocalDateTime
, not this interface.
A ChronoLocalDateTime
is the abstract representation of a local date-time where the Chronology chronology
, or calendar system, is pluggable. The date-time is defined in terms of fields expressed by TemporalField
, where most common implementations are defined in ChronoField
. The chronology defines how the calendar system operates and the meaning of the standard fields.
When to use this interface
The design of the API encourages the use ofLocalDateTime
rather than this interface, even in the case where the application needs to deal with multiple calendar systems. The rationale for this is explored in detail in ChronoLocalDate
.
Ensure that the discussion in ChronoLocalDate
has been read and understood before using this interface.
Summary
Public methods | |
---|---|
open Temporal! |
adjustInto(temporal: Temporal!) Adjusts the specified temporal object to have the same date and time as this object. |
abstract ChronoZonedDateTime<D>! |
Combines this time with a time-zone to create a |
open Int |
compareTo(other: ChronoLocalDateTime<*>!) Compares this date-time to another date-time, including the chronology. |
open String! |
format(formatter: DateTimeFormatter!) Formats this date-time using the specified formatter. |
open static ChronoLocalDateTime<*>! |
from(temporal: TemporalAccessor!) Obtains an instance of |
open Chronology! |
Gets the chronology of this date-time. |
open Boolean |
isAfter(other: ChronoLocalDateTime<*>!) Checks if this date-time is after the specified date-time ignoring the chronology. |
open Boolean |
isBefore(other: ChronoLocalDateTime<*>!) Checks if this date-time is before the specified date-time ignoring the chronology. |
open Boolean |
isEqual(other: ChronoLocalDateTime<*>!) Checks if this date-time is equal to the specified date-time ignoring the chronology. |
abstract Boolean |
isSupported(field: TemporalField!) Checks if the specified field is supported. |
open Boolean |
isSupported(unit: TemporalUnit!) Checks if the specified unit is supported. |
open ChronoLocalDateTime<D>! |
minus(amount: TemporalAmount!) Returns an object of the same type as this object with an amount subtracted. |
open ChronoLocalDateTime<D>! |
minus(amountToSubtract: Long, unit: TemporalUnit!) Returns an object of the same type as this object with the specified period subtracted. |
open ChronoLocalDateTime<D>! |
plus(amount: TemporalAmount!) Returns an object of the same type as this object with an amount added. |
abstract ChronoLocalDateTime<D>! |
plus(amountToAdd: Long, unit: TemporalUnit!) Returns an object of the same type as this object with the specified period added. |
open R |
query(query: TemporalQuery<R>!) Queries this date-time using the specified query. |
open static Comparator<ChronoLocalDateTime<*>!>! |
Gets a comparator that compares |
open Long |
toEpochSecond(offset: ZoneOffset!) Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z. |
open Instant! |
toInstant(offset: ZoneOffset!) Converts this date-time to an |
abstract D |
Gets the local date part of this date-time. |
abstract LocalTime! |
Gets the local time part of this date-time. |
open ChronoLocalDateTime<D>! |
with(adjuster: TemporalAdjuster!) Returns an adjusted object of the same type as this object with the adjustment made. |
abstract ChronoLocalDateTime<D>! |
with(field: TemporalField!, newValue: Long) Returns an object of the same type as this object with the specified field altered. |
Inherited functions | |
---|---|
Public methods
adjustInto
open fun adjustInto(temporal: Temporal!): Temporal!
Adjusts the specified temporal object to have the same date and time as this object.
This returns a temporal object of the same observable type as the input with the date and time changed to be the same as this.
The adjustment is equivalent to using Temporal#with(TemporalField, long)
twice, passing ChronoField#EPOCH_DAY
and ChronoField#NANO_OF_DAY
as the fields.
In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster)
:
// these two lines are equivalent, but the second approach is recommended temporal = thisLocalDateTime.adjustInto(temporal); temporal = temporal.with(thisLocalDateTime);
This instance is immutable and unaffected by this method call.
Parameters | |
---|---|
temporal |
Temporal!: the target object to be adjusted, not null |
Return | |
---|---|
Temporal! |
the adjusted object, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to make the adjustment |
java.lang.ArithmeticException |
if numeric overflow occurs |
atZone
abstract fun atZone(zone: ZoneId!): ChronoZonedDateTime<D>!
Combines this time with a time-zone to create a ChronoZonedDateTime
.
This returns a ChronoZonedDateTime
formed from this date-time at the specified time-zone. The result will match this date-time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.
The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules
of the zone ID.
In most cases, there is only one valid offset for a local date-time. In the case of an overlap, where clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".
In the case of a gap, where clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".
To obtain the later offset during an overlap, call ChronoZonedDateTime#withLaterOffsetAtOverlap()
on the result of this method.
Parameters | |
---|---|
zone |
ZoneId!: the time-zone to use, not null |
Return | |
---|---|
ChronoZonedDateTime<D>! |
the zoned date-time formed from this date-time, not null |
compareTo
open fun compareTo(other: ChronoLocalDateTime<*>!): Int
Compares this date-time to another date-time, including the chronology.
The comparison is based first on the underlying time-line date-time, then on the chronology. It is "consistent with equals", as defined by Comparable
.
For example, the following is the comparator order:
2012-12-03T12:00 (ISO)
2012-12-04T12:00 (ISO)
2555-12-04T12:00 (ThaiBuddhist)
2012-12-05T12:00 (ISO)
If all the date-time objects being compared are in the same chronology, then the additional chronology stage is not required and only the local date-time is used.
This default implementation performs the comparison defined above.
Parameters | |
---|---|
o |
the object to be compared. |
other |
ChronoLocalDateTime<*>!: the other date-time to compare to, not null |
Return | |
---|---|
Int |
the comparator value, negative if less, positive if greater |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
format
open fun format(formatter: DateTimeFormatter!): String!
Formats this date-time using the specified formatter.
This date-time will be passed to the formatter to produce a string.
The default implementation must behave as follows:
return formatter.format(this);
Parameters | |
---|---|
formatter |
DateTimeFormatter!: the formatter to use, not null |
Return | |
---|---|
String! |
the formatted date-time string, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if an error occurs during printing |
from
open static fun from(temporal: TemporalAccessor!): ChronoLocalDateTime<*>!
Obtains an instance of ChronoLocalDateTime
from a temporal object.
This obtains a local date-time based on the specified temporal. A TemporalAccessor
represents an arbitrary set of date and time information, which this factory converts to an instance of ChronoLocalDateTime
.
The conversion extracts and combines the chronology and the date-time from the temporal object. The behavior is equivalent to using Chronology#localDateTime(TemporalAccessor)
with the extracted chronology. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects.
This method matches the signature of the functional interface TemporalQuery
allowing it to be used as a query via method reference, ChronoLocalDateTime::from
.
Parameters | |
---|---|
temporal |
TemporalAccessor!: the temporal object to convert, not null |
Return | |
---|---|
ChronoLocalDateTime<*>! |
the date-time, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to convert to a ChronoLocalDateTime |
getChronology
open fun getChronology(): Chronology!
Gets the chronology of this date-time.
The Chronology
represents the calendar system in use. The era and other fields in ChronoField
are defined by the chronology.
Return | |
---|---|
Chronology! |
the chronology, not null |
isAfter
open fun isAfter(other: ChronoLocalDateTime<*>!): Boolean
Checks if this date-time is after the specified date-time ignoring the chronology.
This method differs from the comparison in compareTo
in that it only compares the underlying date-time and not the chronology. This allows dates in different calendar systems to be compared based on the time-line position.
This default implementation performs the comparison based on the epoch-day and nano-of-day.
Parameters | |
---|---|
other |
ChronoLocalDateTime<*>!: the other date-time to compare to, not null |
Return | |
---|---|
Boolean |
true if this is after the specified date-time |
isBefore
open fun isBefore(other: ChronoLocalDateTime<*>!): Boolean
Checks if this date-time is before the specified date-time ignoring the chronology.
This method differs from the comparison in compareTo
in that it only compares the underlying date-time and not the chronology. This allows dates in different calendar systems to be compared based on the time-line position.
This default implementation performs the comparison based on the epoch-day and nano-of-day.
Parameters | |
---|---|
other |
ChronoLocalDateTime<*>!: the other date-time to compare to, not null |
Return | |
---|---|
Boolean |
true if this is before the specified date-time |
isEqual
open fun isEqual(other: ChronoLocalDateTime<*>!): Boolean
Checks if this date-time is equal to the specified date-time ignoring the chronology.
This method differs from the comparison in compareTo
in that it only compares the underlying date and time and not the chronology. This allows date-times in different calendar systems to be compared based on the time-line position.
This default implementation performs the comparison based on the epoch-day and nano-of-day.
Parameters | |
---|---|
other |
ChronoLocalDateTime<*>!: the other date-time to compare to, not null |
Return | |
---|---|
Boolean |
true if the underlying date-time is equal to the specified date-time on the timeline |
isSupported
abstract fun isSupported(field: TemporalField!): Boolean
Checks if the specified field is supported.
This checks if the specified field can be queried on this date-time. If false, then calling the range
, get
and with(java.time.temporal.TemporalField,long)
methods will throw an exception.
The set of supported fields is defined by the chronology and normally includes all ChronoField
date and time fields.
If the field is not a ChronoField
, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor)
passing this
as the argument. Whether the field is supported is determined by the field.
Parameters | |
---|---|
field |
TemporalField!: the field to check, null returns false |
Return | |
---|---|
Boolean |
true if the field can be queried, false if not |
isSupported
open fun isSupported(unit: TemporalUnit!): Boolean
Checks if the specified unit is supported.
This checks if the specified unit can be added to or subtracted from this date-time. If false, then calling the plus(long,java.time.temporal.TemporalUnit)
and minus
methods will throw an exception.
The set of supported units is defined by the chronology and normally includes all ChronoUnit
units except FOREVER
.
If the unit is not a ChronoUnit
, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this
as the argument. Whether the unit is supported is determined by the unit.
Parameters | |
---|---|
unit |
TemporalUnit!: the unit to check, null returns false |
Return | |
---|---|
Boolean |
true if the unit can be added/subtracted, false if not |
minus
open fun minus(amount: TemporalAmount!): ChronoLocalDateTime<D>!
Returns an object of the same type as this object with an amount subtracted.
This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a java.time.Period
but may be any other type implementing the TemporalAmount
interface, such as java.time.Duration
.
Some example code indicating how and why this method is used:
date = date.minus(period); // subtract a Period instance date = date.minus(duration); // subtract a Duration instance date = date.minus(workingDays(6)); // example user-written workingDays method
Note that calling plus
followed by minus
is not guaranteed to return the same date-time.
Parameters | |
---|---|
amount |
TemporalAmount!: the amount to subtract, not null |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the subtraction cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
minus
open fun minus(
amountToSubtract: Long,
unit: TemporalUnit!
): ChronoLocalDateTime<D>!
Returns an object of the same type as this object with the specified period subtracted.
This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate
, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
Parameters | |
---|---|
amountToSubtract |
Long: the amount of the specified unit to subtract, may be negative |
unit |
TemporalUnit!: the unit of the amount to subtract, not null |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified period subtracted, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the unit cannot be subtracted |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
plus
open fun plus(amount: TemporalAmount!): ChronoLocalDateTime<D>!
Returns an object of the same type as this object with an amount added.
This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a java.time.Period
but may be any other type implementing the TemporalAmount
interface, such as java.time.Duration
.
Some example code indicating how and why this method is used:
date = date.plus(period); // add a Period instance date = date.plus(duration); // add a Duration instance date = date.plus(workingDays(6)); // example user-written workingDays method
Note that calling plus
followed by minus
is not guaranteed to return the same date-time.
Parameters | |
---|---|
amount |
TemporalAmount!: the amount to add, not null |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the addition cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
plus
abstract fun plus(
amountToAdd: Long,
unit: TemporalUnit!
): ChronoLocalDateTime<D>!
Returns an object of the same type as this object with the specified period added.
This method returns a new object based on this one with the specified period added. For example, on a LocalDate
, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
Parameters | |
---|---|
amountToAdd |
Long: the amount of the specified unit to add, may be negative |
unit |
TemporalUnit!: the unit of the amount to add, not null |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified period added, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the unit cannot be added |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
query
open fun <R : Any!> query(query: TemporalQuery<R>!): R
Queries this date-time using the specified query.
This queries this date-time using the specified query strategy object. The TemporalQuery
object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.
The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor)
method on the specified query passing this
as the argument.
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 (defined by the query) |
java.lang.ArithmeticException |
if numeric overflow occurs (defined by the query) |
timeLineOrder
open static fun timeLineOrder(): Comparator<ChronoLocalDateTime<*>!>!
Gets a comparator that compares ChronoLocalDateTime
in time-line order ignoring the chronology.
This comparator differs from the comparison in compareTo
in that it only compares the underlying date-time and not the chronology. This allows dates in different calendar systems to be compared based on the position of the date-time on the local time-line. The underlying comparison is equivalent to comparing the epoch-day and nano-of-day.
Return | |
---|---|
Comparator<ChronoLocalDateTime<*>!>! |
a comparator that compares in time-line order ignoring the chronology |
toEpochSecond
open fun toEpochSecond(offset: ZoneOffset!): Long
Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.
This combines this local date-time and the specified offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.
This default implementation calculates from the epoch-day of the date and the second-of-day of the time.
Parameters | |
---|---|
offset |
ZoneOffset!: the offset to use for the conversion, not null |
Return | |
---|---|
Long |
the number of seconds from the epoch of 1970-01-01T00:00:00Z |
toInstant
open fun toInstant(offset: ZoneOffset!): Instant!
Converts this date-time to an Instant
.
This combines this local date-time and the specified offset to form an Instant
.
This default implementation calculates from the epoch-day of the date and the second-of-day of the time.
Parameters | |
---|---|
offset |
ZoneOffset!: the offset to use for the conversion, not null |
Return | |
---|---|
Instant! |
an Instant representing the same instant, not null |
toLocalDate
abstract fun toLocalDate(): D
Gets the local date part of this date-time.
This returns a local date with the same year, month and day as this date-time.
Return | |
---|---|
D |
the date part of this date-time, not null |
toLocalTime
abstract fun toLocalTime(): LocalTime!
Gets the local time part of this date-time.
This returns a local time with the same hour, minute, second and nanosecond as this date-time.
Return | |
---|---|
LocalTime! |
the time part of this date-time, not null |
with
open fun with(adjuster: TemporalAdjuster!): ChronoLocalDateTime<D>!
Returns an adjusted object of the same type as this object with the adjustment made.
This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters
. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.
Some example code indicating how and why this method is used:
date = date.with(Month.JULY); // most key classes implement TemporalAdjuster date = date.with(lastDayOfMonth()); // static import from Adjusters date = date.with(next(WEDNESDAY)); // static import from Adjusters and DayOfWeek
Parameters | |
---|---|
adjuster |
TemporalAdjuster!: the adjuster to use, not null |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to make the adjustment |
java.lang.ArithmeticException |
if numeric overflow occurs |
with
abstract fun with(
field: TemporalField!,
newValue: Long
): ChronoLocalDateTime<D>!
Returns an object of the same type as this object with the specified field altered.
This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate
, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
Parameters | |
---|---|
field |
TemporalField!: the field to set in the result, not null |
newValue |
Long: the new value of the field in the result |
Return | |
---|---|
ChronoLocalDateTime<D>! |
an object of the same type with the specified field set, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the field cannot be set |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |