D - the concrete type for the date of this date-time
since 1.8public interface ChronoLocalDateTime<D extends ChronoLocalDate> extends Temporal, TemporalAdjuster, Comparable<ChronoLocalDateTime<?>>
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.
LocalDateTime 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.
This interface must be implemented with care to ensure other classes operate correctly. All implementations that can be instantiated must be final, immutable and thread-safe. Subclasses should be Serializable wherever possible.
| Modifier and Type | Method and Description |
|---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have the same date and time as this object.
|
ChronoZonedDateTime<D> |
atZone(ZoneId zone)
Combines this time with a time-zone to create a
ChronoZonedDateTime. |
boolean |
equals(Object obj)
Checks if this date-time is equal to another date-time, including the chronology.
|
Chronology |
getChronology()
Gets the chronology of this date-time.
|
int |
hashCode()
A hash code for this date-time.
|
boolean |
isAfter(ChronoLocalDateTime<?> other)
Checks if this date-time is after the specified date-time ignoring the chronology.
|
boolean |
isBefore(ChronoLocalDateTime<?> other)
Checks if this date-time is before the specified date-time ignoring the chronology.
|
boolean |
isEqual(ChronoLocalDateTime<?> other)
Checks if this date-time is equal to the specified date-time ignoring the chronology.
|
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
boolean |
isSupported(TemporalUnit unit)
Checks if the specified unit is supported.
|
ChronoLocalDateTime<D> |
minus(long amountToSubtract,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period subtracted.
|
ChronoLocalDateTime<D> |
minus(TemporalAmount amount)
Returns an object of the same type as this object with an amount subtracted.
|
ChronoLocalDateTime<D> |
plus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period added.
|
ChronoLocalDateTime<D> |
plus(TemporalAmount amount)
Returns an object of the same type as this object with an amount added.
|
long |
toEpochSecond(ZoneOffset offset)
Converts this date-time to the number of seconds from the epoch
of 1970-01-01T00:00:00Z.
|
Instant |
toInstant(ZoneOffset offset)
Converts this date-time to an
Instant. |
D |
toLocalDate()
Gets the local date part of this date-time.
|
LocalTime |
toLocalTime()
Gets the local time part of this date-time.
|
String |
toString()
Outputs this date-time as a
String. |
ChronoLocalDateTime<D> |
with(TemporalAdjuster adjuster)
Returns an adjusted object of the same type as this object with the adjustment made.
|
ChronoLocalDateTime<D> |
with(TemporalField field,
long newValue)
Returns an object of the same type as this object with the specified field altered.
|
get, getLong, query, rangecompareToTemporal adjustInto(Temporal temporal)
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.
adjustInto in interface TemporalAdjustertemporal - the target object to be adjusted, not nullDateTimeException - if unable to make the adjustmentChronoZonedDateTime<D> atZone(ZoneId zone)
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.
zone - the time-zone to use, not nullboolean equals(@Nullable Object obj)
Compares this date-time with another ensuring that the date-time and chronology are the same.
equals in class Objectobj - the object to check, null returns falseObject.hashCode(),
HashMapChronology getChronology()
The Chronology represents the calendar system in use.
The era and other fields in ChronoField are defined by the chronology.
int hashCode()
hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)boolean isAfter(ChronoLocalDateTime<?> other)
This method differs from the comparison in Comparable.compareTo(T) 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.
other - the other date-time to compare to, not nullboolean isBefore(ChronoLocalDateTime<?> other)
This method differs from the comparison in Comparable.compareTo(T) 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.
other - the other date-time to compare to, not nullboolean isEqual(ChronoLocalDateTime<?> other)
This method differs from the comparison in Comparable.compareTo(T) 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.
other - the other date-time to compare to, not nullboolean isSupported(@Nullable TemporalField field)
This checks if the specified field can be queried on this date-time.
If false, then calling the range,
get and with(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.
isSupported in interface TemporalAccessorfield - the field to check, null returns falseboolean isSupported(@Nullable TemporalUnit unit)
This checks if the specified unit can be added to or subtracted from this date-time.
If false, then calling the plus(long, 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.
isSupported in interface Temporalunit - the unit to check, null returns falseChronoLocalDateTime<D> minus(long amountToSubtract, TemporalUnit unit)
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.
Implementations must behave in a manor equivalent to the default method behavior.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit)
: plus(-amountToSubtract, unit));
minus in interface TemporalamountToSubtract - the amount of the specified unit to subtract, may be negativeunit - the unit of the amount to subtract, not nullDateTimeException - if the unit cannot be subtractedChronoLocalDateTime<D> minus(TemporalAmount amount)
This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a
Period but may be any other type implementing the TemporalAmount interface, such as
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.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return amount.subtractFrom(this);
minus in interface Temporalamount - the amount to subtract, not nullDateTimeException - if the subtraction cannot be madeChronoLocalDateTime<D> plus(long amountToAdd, TemporalUnit unit)
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.
Implementations must check and handle all units defined in ChronoUnit. If the unit is
supported, then the addition must be performed. If unsupported, then an
UnsupportedTemporalTypeException must be thrown.
If the unit is not a ChronoUnit, then the result of this method is obtained by invoking
TemporalUnit.addTo(Temporal, long) passing this as the first argument.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
plus in interface TemporalamountToAdd - the amount of the specified unit to add, may be negativeunit - the unit of the amount to add, not nullDateTimeException - if the unit cannot be addedChronoLocalDateTime<D> plus(TemporalAmount amount)
This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a
Period but may be any other type implementing the TemporalAmount interface, such as
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.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return amount.addTo(this);
plus in interface Temporalamount - the amount to add, not nullDateTimeException - if the addition cannot be madelong toEpochSecond(ZoneOffset offset)
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.
offset - the offset to use for the conversion, not nullInstant toInstant(ZoneOffset offset)
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.
offset - the offset to use for the conversion, not nullInstant representing the same instant, not nullD toLocalDate()
This returns a local date with the same year, month and day as this date-time.
LocalTime toLocalTime()
This returns a local time with the same hour, minute, second and nanosecond as this date-time.
String toString()
String.
The output will include the full local date-time.
ChronoLocalDateTime<D> with(TemporalAdjuster adjuster)
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 DayOfWeekimplSpec
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return adjuster.adjustInto(this);
with in interface Temporaladjuster - the adjuster to use, not nullDateTimeException - if unable to make the adjustmentChronoLocalDateTime<D> with(TemporalField field, long newValue)
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.
Implementations must check and handle all fields defined in ChronoField. If the field is
supported, then the adjustment must be performed. If unsupported, then an
UnsupportedTemporalTypeException must be thrown.
If the field is not a ChronoField, then the result of this method is obtained by invoking
TemporalField.adjustInto(Temporal, long) passing this as the first argument.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
with in interface Temporalfield - the field to set in the result, not nullnewValue - the new value of the field in the resultDateTimeException - if the field cannot be set