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.
temporal | the target object to be adjusted, not null |
Combines this date-time with a time-zone to create a ZonedDateTime.
This returns a ZonedDateTime 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
ZonedDateTime.withLaterOffsetAtOverlap() on the result of this method.
To throw an exception when there is a gap or overlap, use
ZonedDateTime.ofStrict(LocalDateTime, ZoneOffset, ZoneId).
zone | the time-zone to use, not null |
Compares this date-time to another date-time.
The comparison is primarily based on the date-time, from earliest to latest.
It is "consistent with equals", as defined by Comparable.
If all the date-times being compared are instances of LocalDateTime,
then the comparison will be entirely based on the date-time.
If some dates being compared are in different chronologies, then the
chronology is also considered, see ChronoLocalDateTime.compareTo.
other | the other date-time to compare to, not null |
Formats this date-time using the specified formatter.
This date-time will be passed to the formatter to produce a string.
formatter | the formatter to use, not null |
Gets the value of the specified field from this date-time as an int.
This queries this 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 it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here.
The supported fields will return valid
values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY,
EPOCH_DAY and PROLEPTIC_MONTH which are too large to fit in
an int and throw an UnsupportedTemporalTypeException.
All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
field | the field to get, not null |
Gets the value of the specified field from this date-time as a long.
This queries this date-time for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here.
The supported fields will return valid
values based on this date-time.
All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
field | the field to get, not null |
Checks if this date-time is after the specified date-time.
This checks to see if this date-time represents a point on the local time-line after the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isAfter(b) == false a.isAfter(a) == false b.isAfter(a) == true
This method only considers the position of the two date-times on the local time-line.
It does not take into account the chronology, or calendar system.
This is different from the comparison in compareTo(ChronoLocalDateTime),
but is the same approach as ChronoLocalDateTime.timeLineOrder().
other | the other date-time to compare to, not null |
Checks if this date-time is before the specified date-time.
This checks to see if this date-time represents a point on the local time-line before the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isBefore(b) == true a.isBefore(a) == false b.isBefore(a) == false
This method only considers the position of the two date-times on the local time-line.
It does not take into account the chronology, or calendar system.
This is different from the comparison in compareTo(ChronoLocalDateTime),
but is the same approach as ChronoLocalDateTime.timeLineOrder().
other | the other date-time to compare to, not null |
Checks if this date-time is equal to the specified date-time.
This checks to see if this date-time represents the same point on the local time-line as the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isEqual(b) == false a.isEqual(a) == true b.isEqual(a) == false
This method only considers the position of the two date-times on the local time-line.
It does not take into account the chronology, or calendar system.
This is different from the comparison in compareTo(ChronoLocalDateTime),
but is the same approach as ChronoLocalDateTime.timeLineOrder().
other | the other date-time to compare to, not null |
Checks if the specified field is supported.
This checks if this date-time can be queried for the specified field.
If false, then calling the range,
get and with(TemporalField, long)
methods will throw an exception.
If the field is a ChronoField then the query is implemented here.
The supported fields are:
NANO_OF_SECOND
NANO_OF_DAY
MICRO_OF_SECOND
MICRO_OF_DAY
MILLI_OF_SECOND
MILLI_OF_DAY
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR_OF_AMPM
CLOCK_HOUR_OF_AMPM
HOUR_OF_DAY
CLOCK_HOUR_OF_DAY
AMPM_OF_DAY
DAY_OF_WEEK
ALIGNED_DAY_OF_WEEK_IN_MONTH
ALIGNED_DAY_OF_WEEK_IN_YEAR
DAY_OF_MONTH
DAY_OF_YEAR
EPOCH_DAY
ALIGNED_WEEK_OF_MONTH
ALIGNED_WEEK_OF_YEAR
MONTH_OF_YEAR
PROLEPTIC_MONTH
YEAR_OF_ERA
YEAR
ERA
ChronoField instances will return false.
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.
field | the field to check, null returns false |
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, TemporalUnit) and
minus methods will throw an exception.
If the unit is a ChronoUnit then the query is implemented here.
The supported units are:
NANOS
MICROS
MILLIS
SECONDS
MINUTES
HOURS
HALF_DAYS
DAYS
WEEKS
MONTHS
YEARS
DECADES
CENTURIES
MILLENNIA
ERAS
ChronoUnit instances will return false.
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.
unit | the unit to check, null returns false |
Returns a copy of this date-time with the specified amount subtracted.
This returns a LocalDateTime, based on this one, with the specified amount subtracted.
The amount is typically Period or Duration but may be
any other type implementing the TemporalAmount interface.
The calculation is delegated to the amount object by calling
TemporalAmount.subtractFrom(Temporal). The amount implementation is free
to implement the subtraction in any way it wishes, however it typically
calls back to minus(long, TemporalUnit). Consult the documentation
of the amount implementation to determine if it can be successfully subtracted.
This instance is immutable and unaffected by this method call.
amountToSubtract | the amount to subtract, not null |
LocalDateTime based on this date-time with the subtraction made, not null
Returns a copy of this date-time with the specified amount subtracted.
This returns a LocalDateTime, based on this one, with the amount
in terms of the unit subtracted. If it is not possible to subtract the amount,
because the unit is not supported or for some other reason, an exception is thrown.
This method is equivalent to plus(long, TemporalUnit) with the amount negated.
See that method for a full description of how addition, and thus subtraction, works.
This instance is immutable and unaffected by this method call.
amountToSubtract | the amount of the unit to subtract from the result, may be negative | |
unit | the unit of the amount to subtract, not null |
LocalDateTime based on this date-time with the specified amount subtracted, not null
Returns a copy of this date-time with the specified amount added.
This returns a LocalDateTime, based on this one, with the specified amount added.
The amount is typically Period or Duration but may be
any other type implementing the TemporalAmount interface.
The calculation is delegated to the amount object by calling
TemporalAmount.addTo(Temporal). The amount implementation is free
to implement the addition in any way it wishes, however it typically
calls back to plus(long, TemporalUnit). Consult the documentation
of the amount implementation to determine if it can be successfully added.
This instance is immutable and unaffected by this method call.
amountToAdd | the amount to add, not null |
LocalDateTime based on this date-time with the addition made, not null
Returns a copy of this date-time with the specified amount added.
This returns a LocalDateTime, based on this one, with the amount
in terms of the unit added. If it is not possible to add the amount, because the
unit is not supported or for some other reason, an exception is thrown.
If the field is a ChronoUnit then the addition is implemented here.
Date units are added as per LocalDate.plus(long, TemporalUnit).
Time units are added as per LocalTime.plus(long, TemporalUnit) with
any overflow in days added equivalent to using plusDays(long).
If the field is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.addTo(Temporal, long)
passing this as the argument. In this case, the unit determines
whether and how to perform the addition.
This instance is immutable and unaffected by this method call.
amountToAdd | the amount of the unit to add to the result, may be negative | |
unit | the unit of the amount to add, not null |
LocalDateTime based on this date-time with the specified amount added, not null
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.
query | the query to invoke, not null |
Gets the range of valid values for the specified field.
The range object expresses the minimum and maximum valid values for a field. This date-time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here.
The supported fields will return
appropriate range instances.
All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor)
passing this as the argument.
Whether the range can be obtained is determined by the field.
field | the field to query the range for, not null |
Gets the LocalDate part of this date-time.
This returns a LocalDate with the same year, month and day
as this date-time.
Gets the LocalTime part of this date-time.
This returns a LocalTime with the same hour, minute, second and
nanosecond as this date-time.
Calculates the amount of time until another date-time in terms of the specified unit.
This calculates the amount of time between two LocalDateTime
objects in terms of a single TemporalUnit.
The start and end points are this and the specified date-time.
The result will be negative if the end is before the start.
The Temporal passed to this method is converted to a
LocalDateTime using from(TemporalAccessor).
For example, the amount in days between two date-times can be calculated
using startDateTime.until(endDateTime, DAYS).
The calculation returns a whole number, representing the number of complete units between the two date-times. For example, the amount in months between 2012-06-15T00:00 and 2012-08-14T23:59 will only be one month as it is one minute short of two months.
There are two equivalent ways of using this method.
The first is to invoke this method.
The second is to use TemporalUnit.between(Temporal, Temporal):
// these two lines are equivalent amount = start.until(end, MONTHS); amount = MONTHS.between(start, end);The choice should be made based on which makes the code more readable.
The calculation is implemented in this method for ChronoUnit.
The units NANOS, MICROS, MILLIS, SECONDS,
MINUTES, HOURS and HALF_DAYS, DAYS,
WEEKS, MONTHS, YEARS, DECADES,
CENTURIES, MILLENNIA and ERAS are supported.
Other ChronoUnit values will throw an exception.
If the unit is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.between(Temporal, Temporal)
passing this as the first argument and the converted input temporal
as the second argument.
This instance is immutable and unaffected by this method call.
endExclusive | the end date, exclusive, which is converted to a LocalDateTime, not null | |
unit | the unit to measure the amount in, not null |
Returns an adjusted copy of this date-time.
This returns a LocalDateTime, based on this one, with the date-time adjusted.
The adjustment takes place using the specified adjuster strategy object.
Read the documentation of the adjuster to understand what adjustment will be made.
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".
Key date-time classes also implement the TemporalAdjuster interface,
such as Month and MonthDay.
The adjuster is responsible for handling special cases, such as the varying
lengths of month and leap years.
For example this code returns a date on the last day of July:
import static java.time.Month.*; import static java.time.temporal.TemporalAdjusters.*; result = localDateTime.with(JULY).with(lastDayOfMonth());
The classes LocalDate and LocalTime implement TemporalAdjuster,
thus this method can be used to change the date, time or offset:
result = localDateTime.with(date); result = localDateTime.with(time);
The result of this method is obtained by invoking the
TemporalAdjuster.adjustInto(Temporal) method on the
specified adjuster passing this as the argument.
This instance is immutable and unaffected by this method call.
adjuster | the adjuster to use, not null |
LocalDateTime based on this with the adjustment made, not null
Returns a copy of this date-time with the specified field set to a new value.
This returns a LocalDateTime, based on this one, with the value
for the specified field changed.
This can be used to change any supported field, such as the year, month or day-of-month.
If it is not possible to set the value, because the field is not supported or for
some other reason, an exception is thrown.
In some cases, changing the specified field can cause the resulting date-time to become invalid, such as changing the month from 31st January to February would make the day-of-month invalid. In cases like this, the field is responsible for resolving the date. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the field is a ChronoField then the adjustment is implemented here.
The supported fields will behave as per
the matching method on LocalDate
or LocalTime.
All other ChronoField instances will throw an UnsupportedTemporalTypeException.
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 argument. In this case, the field determines
whether and how to adjust the instant.
This instance is immutable and unaffected by this method call.
field | the field to set in the result, not null | |
newValue | the new value of the field in the result |
LocalDateTime based on this with the specified field set, not null
Diagram: LocalDateTime