public final class LocalDateTimeextends Objectimplements Temporal, TemporalAdjuster, ChronoLocalDateTime<LocalDate>, Serializable
2007-12-03T10:15:30. LocalDateTime is an immutable date-time object that represents a date-time, often viewed as year-month-day-hour-minute-second. Other date and time fields, such as day-of-year, day-of-week and week-of-year, can also be accessed. Time is represented to nanosecond precision. For example, the value "2nd October 2007 at 13:45.30.123456789" can be stored in a LocalDateTime.
This class does not store or represent a time-zone. Instead, it is a description of the date, as used for birthdays, combined with the local time as seen on a wall clock. It cannot represent an instant on the time-line without additional information such as an offset or time-zone.
The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.
This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of LocalDateTime may have unpredictable results and should be avoided. The equals method should be used for comparisons.
| Modifier and Type | Field and Description |
|---|---|
static LocalDateTime | MAXThe maximum supported LocalDateTime, '+999999999-12-31T23:59:59.999999999'. |
static LocalDateTime | MINThe minimum supported LocalDateTime, '-999999999-01-01T00:00:00'. |
| 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. |
OffsetDateTime | atOffset(ZoneOffset offset)Combines this date-time with an offset to create an OffsetDateTime. |
ZonedDateTime | atZone(ZoneId zone)Combines this date-time with a time-zone to create a ZonedDateTime. |
int | compareTo(ChronoLocalDateTime<?> other)Compares this date-time to another date-time. |
boolean | equals(Object obj)Checks if this date-time is equal to another date-time. |
String | format(DateTimeFormatter formatter)Formats this date-time using the specified formatter. |
static LocalDateTime | from(TemporalAccessor temporal)Obtains an instance of LocalDateTime from a temporal object. |
int | get(TemporalField field)Gets the value of the specified field from this date-time as an int. |
int | getDayOfMonth()Gets the day-of-month field. |
DayOfWeek | getDayOfWeek()Gets the day-of-week field, which is an enum DayOfWeek. |
int | getDayOfYear()Gets the day-of-year field. |
int | getHour()Gets the hour-of-day field. |
long | getLong(TemporalField field)Gets the value of the specified field from this date-time as a long. |
int | getMinute()Gets the minute-of-hour field. |
Month | getMonth()Gets the month-of-year field using the Month enum. |
int | getMonthValue()Gets the month-of-year field from 1 to 12. |
int | getNano()Gets the nano-of-second field. |
int | getSecond()Gets the second-of-minute field. |
int | getYear()Gets the year field. |
int | hashCode()A hash code for this date-time. |
boolean | isAfter(ChronoLocalDateTime<?> other)Checks if this date-time is after the specified date-time. |
boolean | isBefore(ChronoLocalDateTime<?> other)Checks if this date-time is before the specified date-time. |
boolean | isEqual(ChronoLocalDateTime<?> other)Checks if this date-time is equal to the specified date-time. |
boolean | isSupported(TemporalField field)Checks if the specified field is supported. |
boolean | isSupported(TemporalUnit unit)Checks if the specified unit is supported. |
LocalDateTime | minus(long amountToSubtract, TemporalUnit unit)Returns a copy of this date-time with the specified amount subtracted. |
LocalDateTime | minus(TemporalAmount amountToSubtract)Returns a copy of this date-time with the specified amount subtracted. |
LocalDateTime | minusDays(long days)Returns a copy of this LocalDateTime with the specified number of days subtracted. |
LocalDateTime | minusHours(long hours)Returns a copy of this LocalDateTime with the specified number of hours subtracted. |
LocalDateTime | minusMinutes(long minutes)Returns a copy of this LocalDateTime with the specified number of minutes subtracted. |
LocalDateTime | minusMonths(long months)Returns a copy of this LocalDateTime with the specified number of months subtracted. |
LocalDateTime | minusNanos(long nanos)Returns a copy of this LocalDateTime with the specified number of nanoseconds subtracted. |
LocalDateTime | minusSeconds(long seconds)Returns a copy of this LocalDateTime with the specified number of seconds subtracted. |
LocalDateTime | minusWeeks(long weeks)Returns a copy of this LocalDateTime with the specified number of weeks subtracted. |
LocalDateTime | minusYears(long years)Returns a copy of this LocalDateTime with the specified number of years subtracted. |
static LocalDateTime | now()Obtains the current date-time from the system clock in the default time-zone. |
static LocalDateTime | now(Clock clock)Obtains the current date-time from the specified clock. |
static LocalDateTime | now(ZoneId zone)Obtains the current date-time from the system clock in the specified time-zone. |
static LocalDateTime | of(int year, int month, int dayOfMonth, int hour, int minute)Obtains an instance of LocalDateTime from year, month, day, hour and minute, setting the second and nanosecond to zero. |
static LocalDateTime | of(int year, int month, int dayOfMonth, int hour, int minute, int second)Obtains an instance of LocalDateTime from year, month, day, hour, minute and second, setting the nanosecond to zero. |
static LocalDateTime | of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond)Obtains an instance of LocalDateTime from year, month, day, hour, minute, second and nanosecond. |
static LocalDateTime | of(int year, Month month, int dayOfMonth, int hour, int minute)Obtains an instance of LocalDateTime from year, month, day, hour and minute, setting the second and nanosecond to zero. |
static LocalDateTime | of(int year, Month month, int dayOfMonth, int hour, int minute, int second)Obtains an instance of LocalDateTime from year, month, day, hour, minute and second, setting the nanosecond to zero. |
static LocalDateTime | of(int year, Month month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond)Obtains an instance of LocalDateTime from year, month, day, hour, minute, second and nanosecond. |
static LocalDateTime | of(LocalDate date, LocalTime time)Obtains an instance of LocalDateTime from a date and time. |
static LocalDateTime | ofEpochSecond(long epochSecond, int nanoOfSecond, ZoneOffset offset)Obtains an instance of LocalDateTime using seconds from the epoch of 1970-01-01T00:00:00Z. |
static LocalDateTime | ofInstant(Instant instant, ZoneId zone)Obtains an instance of LocalDateTime from an Instant and zone ID. |
static LocalDateTime | parse(CharSequence text)Obtains an instance of LocalDateTime from a text string such as 2007-12-03T10:15:30. |
static LocalDateTime | parse(CharSequence text, DateTimeFormatter formatter)Obtains an instance of LocalDateTime from a text string using a specific formatter. |
LocalDateTime | plus(long amountToAdd, TemporalUnit unit)Returns a copy of this date-time with the specified amount added. |
LocalDateTime | plus(TemporalAmount amountToAdd)Returns a copy of this date-time with the specified amount added. |
LocalDateTime | plusDays(long days)Returns a copy of this LocalDateTime with the specified number of days added. |
LocalDateTime | plusHours(long hours)Returns a copy of this LocalDateTime with the specified number of hours added. |
LocalDateTime | plusMinutes(long minutes)Returns a copy of this LocalDateTime with the specified number of minutes added. |
LocalDateTime | plusMonths(long months)Returns a copy of this LocalDateTime with the specified number of months added. |
LocalDateTime | plusNanos(long nanos)Returns a copy of this LocalDateTime with the specified number of nanoseconds added. |
LocalDateTime | plusSeconds(long seconds)Returns a copy of this LocalDateTime with the specified number of seconds added. |
LocalDateTime | plusWeeks(long weeks)Returns a copy of this LocalDateTime with the specified number of weeks added. |
LocalDateTime | plusYears(long years)Returns a copy of this LocalDateTime with the specified number of years added. |
<R> R | query(TemporalQuery<R> query)Queries this date-time using the specified query. |
ValueRange | range(TemporalField field)Gets the range of valid values for the specified field. |
LocalDate | toLocalDate()Gets the LocalDate part of this date-time. |
LocalTime | toLocalTime()Gets the LocalTime part of this date-time. |
String | toString()Outputs this date-time as a String, such as 2007-12-03T10:15:30. |
LocalDateTime | truncatedTo(TemporalUnit unit)Returns a copy of this LocalDateTime with the time truncated. |
long | until(Temporal endExclusive, TemporalUnit unit)Calculates the amount of time until another date-time in terms of the specified unit. |
LocalDateTime | with(TemporalAdjuster adjuster)Returns an adjusted copy of this date-time. |
LocalDateTime | with(TemporalField field, long newValue)Returns a copy of this date-time with the specified field set to a new value. |
LocalDateTime | withDayOfMonth(int dayOfMonth)Returns a copy of this LocalDateTime with the day-of-month altered. |
LocalDateTime | withDayOfYear(int dayOfYear)Returns a copy of this LocalDateTime with the day-of-year altered. |
LocalDateTime | withHour(int hour)Returns a copy of this LocalDateTime with the hour-of-day altered. |
LocalDateTime | withMinute(int minute)Returns a copy of this LocalDateTime with the minute-of-hour altered. |
LocalDateTime | withMonth(int month)Returns a copy of this LocalDateTime with the month-of-year altered. |
LocalDateTime | withNano(int nanoOfSecond)Returns a copy of this LocalDateTime with the nano-of-second altered. |
LocalDateTime | withSecond(int second)Returns a copy of this LocalDateTime with the second-of-minute altered. |
LocalDateTime | withYear(int year)Returns a copy of this LocalDateTime with the year altered. |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitgetChronology, timeLineOrder, toEpochSecond, toInstantpublic static final LocalDateTime MIN
LocalDateTime, '-999999999-01-01T00:00:00'. This is the local date-time of midnight at the start of the minimum date. This combines LocalDate.MIN and LocalTime.MIN. This could be used by an application as a "far past" date-time.public static final LocalDateTime MAX
LocalDateTime, '+999999999-12-31T23:59:59.999999999'. This is the local date-time just before midnight at the end of the maximum date. This combines LocalDate.MAX and LocalTime.MAX. This could be used by an application as a "far future" date-time.public static LocalDateTime now()
This will query the system clock in the default time-zone to obtain the current date-time.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
public static LocalDateTime now(ZoneId zone)
This will query the system clock to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
zone - the zone ID to use, not nullpublic static LocalDateTime now(Clock clock)
This will query the specified clock to obtain the current date-time. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.
clock - the clock to use, not nullpublic static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute)
LocalDateTime from year, month, day, hour and minute, setting the second and nanosecond to zero. This returns a LocalDateTime with the specified year, month, day-of-month, hour and minute. The day must be valid for the year and month, otherwise an exception will be thrown. The second and nanosecond fields will be set to zero.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, not nulldayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second)
LocalDateTime from year, month, day, hour, minute and second, setting the nanosecond to zero. This returns a LocalDateTime with the specified year, month, day-of-month, hour, minute and second. The day must be valid for the year and month, otherwise an exception will be thrown. The nanosecond field will be set to zero.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, not nulldayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59second - the second-of-minute to represent, from 0 to 59DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond)
LocalDateTime from year, month, day, hour, minute, second and nanosecond. This returns a LocalDateTime with the specified year, month, day-of-month, hour, minute, second and nanosecond. The day must be valid for the year and month, otherwise an exception will be thrown.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, not nulldayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59second - the second-of-minute to represent, from 0 to 59nanoOfSecond - the nano-of-second to represent, from 0 to 999,999,999DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute)
LocalDateTime from year, month, day, hour and minute, setting the second and nanosecond to zero. This returns a LocalDateTime with the specified year, month, day-of-month, hour and minute. The day must be valid for the year and month, otherwise an exception will be thrown. The second and nanosecond fields will be set to zero.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, from 1 (January) to 12 (December)dayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second)
LocalDateTime from year, month, day, hour, minute and second, setting the nanosecond to zero. This returns a LocalDateTime with the specified year, month, day-of-month, hour, minute and second. The day must be valid for the year and month, otherwise an exception will be thrown. The nanosecond field will be set to zero.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, from 1 (January) to 12 (December)dayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59second - the second-of-minute to represent, from 0 to 59DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond)
LocalDateTime from year, month, day, hour, minute, second and nanosecond. This returns a LocalDateTime with the specified year, month, day-of-month, hour, minute, second and nanosecond. The day must be valid for the year and month, otherwise an exception will be thrown.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, from 1 (January) to 12 (December)dayOfMonth - the day-of-month to represent, from 1 to 31hour - the hour-of-day to represent, from 0 to 23minute - the minute-of-hour to represent, from 0 to 59second - the second-of-minute to represent, from 0 to 59nanoOfSecond - the nano-of-second to represent, from 0 to 999,999,999DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static LocalDateTime of(LocalDate date, LocalTime time)
LocalDateTime from a date and time.date - the local date, not nulltime - the local time, not nullpublic static LocalDateTime ofInstant(Instant instant, ZoneId zone)
LocalDateTime from an Instant and zone ID. This creates a local date-time based on the specified instant. First, the offset from UTC/Greenwich is obtained using the zone ID and instant, which is simple as there is only one valid offset for each instant. Then, the instant and offset are used to calculate the local date-time.
instant - the instant to create the date-time from, not nullzone - the time-zone, which may be an offset, not nullDateTimeException - if the result exceeds the supported rangepublic static LocalDateTime ofEpochSecond(long epochSecond, int nanoOfSecond, ZoneOffset offset)
LocalDateTime using seconds from the epoch of 1970-01-01T00:00:00Z. This allows the epoch-second field to be converted to a local date-time. This is primarily intended for low-level conversions rather than general application usage.
epochSecond - the number of seconds from the epoch of 1970-01-01T00:00:00ZnanoOfSecond - the nanosecond within the second, from 0 to 999,999,999offset - the zone offset, not nullDateTimeException - if the result exceeds the supported range, or if the nano-of-second is invalidpublic static LocalDateTime from(TemporalAccessor temporal)
LocalDateTime 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 LocalDateTime.
The conversion extracts and combines the LocalDate and the LocalTime from the temporal object. 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, LocalDateTime::from.
from in interface ChronoLocalDateTime<LocalDate>temporal - the temporal object to convert, not nullDateTimeException - if unable to convert to a LocalDateTimeChronology.localDateTime(TemporalAccessor)public static LocalDateTime parse(CharSequence text)
LocalDateTime from a text string such as 2007-12-03T10:15:30. The string must represent a valid date-time and is parsed using DateTimeFormatter.ISO_LOCAL_DATE_TIME.
text - the text to parse such as "2007-12-03T10:15:30", not nullDateTimeParseException - if the text cannot be parsedpublic static LocalDateTime parse(CharSequence text, DateTimeFormatter formatter)
LocalDateTime from a text string using a specific formatter. The text is parsed using the formatter, returning a date-time.
text - the text to parse, not nullformatter - the formatter to use, not nullDateTimeParseException - if the text cannot be parsedpublic boolean isSupported(TemporalField field)
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.
isSupported in interface ChronoLocalDateTime<LocalDate>isSupported in interface TemporalAccessorfield - the field to check, null returns falsepublic boolean isSupported(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.
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.
isSupported in interface ChronoLocalDateTime<LocalDate>isSupported in interface Temporalunit - the unit to check, null returns falsepublic ValueRange range(TemporalField 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.
range in interface TemporalAccessorfield - the field to query the range for, not nullDateTimeException - if the range for the field cannot be obtainedUnsupportedTemporalTypeException - if the field is not supportedpublic int get(TemporalField field)
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 a DateTimeException. 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.
get in interface TemporalAccessorfield - the field to get, not nullDateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the fieldUnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an intArithmeticException - if numeric overflow occurspublic long getLong(TemporalField field)
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.
getLong in interface TemporalAccessorfield - the field to get, not nullDateTimeException - if a value for the field cannot be obtainedUnsupportedTemporalTypeException - if the field is not supportedArithmeticException - if numeric overflow occurspublic LocalDate toLocalDate()
LocalDate part of this date-time. This returns a LocalDate with the same year, month and day as this date-time.
toLocalDate in interface ChronoLocalDateTime<LocalDate>public int getYear()
This method returns the primitive int value for the year.
The year returned by this method is proleptic as per get(YEAR). To obtain the year-of-era, use get(YEAR_OF_ERA).
public int getMonthValue()
This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling getMonth().
getMonth()public Month getMonth()
Month enum. This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.
getMonthValue()public int getDayOfMonth()
This method returns the primitive int value for the day-of-month.
public int getDayOfYear()
This method returns the primitive int value for the day-of-year.
public DayOfWeek getDayOfWeek()
DayOfWeek. This method returns the enum DayOfWeek for the day-of-week. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.
Additional information can be obtained from the DayOfWeek. This includes textual names of the values.
public LocalTime toLocalTime()
LocalTime part of this date-time. This returns a LocalTime with the same hour, minute, second and nanosecond as this date-time.
toLocalTime in interface ChronoLocalDateTime<LocalDate>public int getHour()
public int getMinute()
public int getSecond()
public int getNano()
public LocalDateTime with(TemporalAdjuster adjuster)
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.
with in interface ChronoLocalDateTime<LocalDate>with in interface Temporaladjuster - the adjuster to use, not nullLocalDateTime based on this with the adjustment made, not nullDateTimeException - if the adjustment cannot be madeArithmeticException - if numeric overflow occurspublic LocalDateTime with(TemporalField field, long newValue)
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.
with in interface ChronoLocalDateTime<LocalDate>with in interface Temporalfield - the field to set in the result, not nullnewValue - the new value of the field in the resultLocalDateTime based on this with the specified field set, not nullDateTimeException - if the field cannot be setUnsupportedTemporalTypeException - if the field is not supportedArithmeticException - if numeric overflow occurspublic LocalDateTime withYear(int year)
LocalDateTime with the year altered. The time does not affect the calculation and will be the same in the result. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
This instance is immutable and unaffected by this method call.
year - the year to set in the result, from MIN_YEAR to MAX_YEARLocalDateTime based on this date-time with the requested year, not nullDateTimeException - if the year value is invalidpublic LocalDateTime withMonth(int month)
LocalDateTime with the month-of-year altered. The time does not affect the calculation and will be the same in the result. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
This instance is immutable and unaffected by this method call.
month - the month-of-year to set in the result, from 1 (January) to 12 (December)LocalDateTime based on this date-time with the requested month, not nullDateTimeException - if the month-of-year value is invalidpublic LocalDateTime withDayOfMonth(int dayOfMonth)
LocalDateTime with the day-of-month altered. If the resulting date-time is invalid, an exception is thrown. The time does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
dayOfMonth - the day-of-month to set in the result, from 1 to 28-31LocalDateTime based on this date-time with the requested day, not nullDateTimeException - if the day-of-month value is invalid, or if the day-of-month is invalid for the month-yearpublic LocalDateTime withDayOfYear(int dayOfYear)
LocalDateTime with the day-of-year altered. If the resulting date-time is invalid, an exception is thrown.
This instance is immutable and unaffected by this method call.
dayOfYear - the day-of-year to set in the result, from 1 to 365-366LocalDateTime based on this date with the requested day, not nullDateTimeException - if the day-of-year value is invalid, or if the day-of-year is invalid for the yearpublic LocalDateTime withHour(int hour)
LocalDateTime with the hour-of-day altered. This instance is immutable and unaffected by this method call.
hour - the hour-of-day to set in the result, from 0 to 23LocalDateTime based on this date-time with the requested hour, not nullDateTimeException - if the hour value is invalidpublic LocalDateTime withMinute(int minute)
LocalDateTime with the minute-of-hour altered. This instance is immutable and unaffected by this method call.
minute - the minute-of-hour to set in the result, from 0 to 59LocalDateTime based on this date-time with the requested minute, not nullDateTimeException - if the minute value is invalidpublic LocalDateTime withSecond(int second)
LocalDateTime with the second-of-minute altered. This instance is immutable and unaffected by this method call.
second - the second-of-minute to set in the result, from 0 to 59LocalDateTime based on this date-time with the requested second, not nullDateTimeException - if the second value is invalidpublic LocalDateTime withNano(int nanoOfSecond)
LocalDateTime with the nano-of-second altered. This instance is immutable and unaffected by this method call.
nanoOfSecond - the nano-of-second to set in the result, from 0 to 999,999,999LocalDateTime based on this date-time with the requested nanosecond, not nullDateTimeException - if the nano value is invalidpublic LocalDateTime truncatedTo(TemporalUnit unit)
LocalDateTime with the time truncated. Truncation returns a copy of the original date-time with fields smaller than the specified unit set to zero. For example, truncating with the minutes unit will set the second-of-minute and nano-of-second field to zero.
The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.
This instance is immutable and unaffected by this method call.
unit - the unit to truncate to, not nullLocalDateTime based on this date-time with the time truncated, not nullDateTimeException - if unable to truncateUnsupportedTemporalTypeException - if the unit is not supportedpublic LocalDateTime plus(TemporalAmount amountToAdd)
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.
plus in interface ChronoLocalDateTime<LocalDate>plus in interface TemporalamountToAdd - the amount to add, not nullLocalDateTime based on this date-time with the addition made, not nullDateTimeException - if the addition cannot be madeArithmeticException - if numeric overflow occurspublic LocalDateTime plus(long amountToAdd, TemporalUnit unit)
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.
plus in interface ChronoLocalDateTime<LocalDate>plus in interface TemporalamountToAdd - the amount of the unit to add to the result, may be negativeunit - the unit of the amount to add, not nullLocalDateTime based on this date-time with the specified amount added, not nullDateTimeException - if the addition cannot be madeUnsupportedTemporalTypeException - if the unit is not supportedArithmeticException - if numeric overflow occurspublic LocalDateTime plusYears(long years)
LocalDateTime with the specified number of years added. This method adds the specified amount to the years field in three steps:
For example, 2008-02-29 (leap year) plus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
years - the years to add, may be negativeLocalDateTime based on this date-time with the years added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusMonths(long months)
LocalDateTime with the specified number of months added. This method adds the specified amount to the months field in three steps:
For example, 2007-03-31 plus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
months - the months to add, may be negativeLocalDateTime based on this date-time with the months added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusWeeks(long weeks)
LocalDateTime with the specified number of weeks added. This method adds the specified amount in weeks to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one week would result in 2009-01-07.
This instance is immutable and unaffected by this method call.
weeks - the weeks to add, may be negativeLocalDateTime based on this date-time with the weeks added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusDays(long days)
LocalDateTime with the specified number of days added. This method adds the specified amount to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one day would result in 2009-01-01.
This instance is immutable and unaffected by this method call.
days - the days to add, may be negativeLocalDateTime based on this date-time with the days added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusHours(long hours)
LocalDateTime with the specified number of hours added. This instance is immutable and unaffected by this method call.
hours - the hours to add, may be negativeLocalDateTime based on this date-time with the hours added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusMinutes(long minutes)
LocalDateTime with the specified number of minutes added. This instance is immutable and unaffected by this method call.
minutes - the minutes to add, may be negativeLocalDateTime based on this date-time with the minutes added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusSeconds(long seconds)
LocalDateTime with the specified number of seconds added. This instance is immutable and unaffected by this method call.
seconds - the seconds to add, may be negativeLocalDateTime based on this date-time with the seconds added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime plusNanos(long nanos)
LocalDateTime with the specified number of nanoseconds added. This instance is immutable and unaffected by this method call.
nanos - the nanos to add, may be negativeLocalDateTime based on this date-time with the nanoseconds added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minus(TemporalAmount amountToSubtract)
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.
minus in interface ChronoLocalDateTime<LocalDate>minus in interface TemporalamountToSubtract - the amount to subtract, not nullLocalDateTime based on this date-time with the subtraction made, not nullDateTimeException - if the subtraction cannot be madeArithmeticException - if numeric overflow occurspublic LocalDateTime minus(long amountToSubtract, TemporalUnit unit)
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.
minus in interface ChronoLocalDateTime<LocalDate>minus in interface TemporalamountToSubtract - the amount of the unit to subtract from the result, may be negativeunit - the unit of the amount to subtract, not nullLocalDateTime based on this date-time with the specified amount subtracted, not nullDateTimeException - if the subtraction cannot be madeUnsupportedTemporalTypeException - if the unit is not supportedArithmeticException - if numeric overflow occurspublic LocalDateTime minusYears(long years)
LocalDateTime with the specified number of years subtracted. This method subtracts the specified amount from the years field in three steps:
For example, 2008-02-29 (leap year) minus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
years - the years to subtract, may be negativeLocalDateTime based on this date-time with the years subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusMonths(long months)
LocalDateTime with the specified number of months subtracted. This method subtracts the specified amount from the months field in three steps:
For example, 2007-03-31 minus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
months - the months to subtract, may be negativeLocalDateTime based on this date-time with the months subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusWeeks(long weeks)
LocalDateTime with the specified number of weeks subtracted. This method subtracts the specified amount in weeks from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-07 minus one week would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
weeks - the weeks to subtract, may be negativeLocalDateTime based on this date-time with the weeks subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusDays(long days)
LocalDateTime with the specified number of days subtracted. This method subtracts the specified amount from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-01 minus one day would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
days - the days to subtract, may be negativeLocalDateTime based on this date-time with the days subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusHours(long hours)
LocalDateTime with the specified number of hours subtracted. This instance is immutable and unaffected by this method call.
hours - the hours to subtract, may be negativeLocalDateTime based on this date-time with the hours subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusMinutes(long minutes)
LocalDateTime with the specified number of minutes subtracted. This instance is immutable and unaffected by this method call.
minutes - the minutes to subtract, may be negativeLocalDateTime based on this date-time with the minutes subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusSeconds(long seconds)
LocalDateTime with the specified number of seconds subtracted. This instance is immutable and unaffected by this method call.
seconds - the seconds to subtract, may be negativeLocalDateTime based on this date-time with the seconds subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDateTime minusNanos(long nanos)
LocalDateTime with the specified number of nanoseconds subtracted. This instance is immutable and unaffected by this method call.
nanos - the nanos to subtract, may be negativeLocalDateTime based on this date-time with the nanoseconds subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic <R> R query(TemporalQuery<R> 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 in interface ChronoLocalDateTime<LocalDate>query in interface TemporalAccessorR - the type of the resultquery - the query to invoke, not nullDateTimeException - if unable to query (defined by the query)ArithmeticException - if numeric overflow occurs (defined by the query)public Temporal 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 ChronoLocalDateTime<LocalDate>adjustInto in interface TemporalAdjustertemporal - the target object to be adjusted, not nullDateTimeException - if unable to make the adjustmentArithmeticException - if numeric overflow occurspublic long until(Temporal endExclusive, TemporalUnit 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.
until in interface TemporalendExclusive - the end date, exclusive, which is converted to a LocalDateTime, not nullunit - the unit to measure the amount in, not nullDateTimeException - if the amount cannot be calculated, or the end temporal cannot be converted to a LocalDateTimeUnsupportedTemporalTypeException - if the unit is not supportedArithmeticException - if numeric overflow occurspublic String format(DateTimeFormatter formatter)
This date-time will be passed to the formatter to produce a string.
format in interface ChronoLocalDateTime<LocalDate>formatter - the formatter to use, not nullDateTimeException - if an error occurs during printingpublic OffsetDateTime atOffset(ZoneOffset offset)
OffsetDateTime. This returns an OffsetDateTime formed from this date-time at the specified offset. All possible combinations of date-time and offset are valid.
offset - the offset to combine with, not nullpublic ZonedDateTime atZone(ZoneId zone)
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).
atZone in interface ChronoLocalDateTime<LocalDate>zone - the time-zone to use, not nullpublic int compareTo(ChronoLocalDateTime<?> other)
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(java.time.chrono.ChronoLocalDateTime<?>).
compareTo in interface Comparable<ChronoLocalDateTime<?>>compareTo in interface ChronoLocalDateTime<LocalDate>other - the other date-time to compare to, not nullpublic boolean isAfter(ChronoLocalDateTime<?> other)
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().
isAfter in interface ChronoLocalDateTime<LocalDate>other - the other date-time to compare to, not nullpublic boolean isBefore(ChronoLocalDateTime<?> other)
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().
isBefore in interface ChronoLocalDateTime<LocalDate>other - the other date-time to compare to, not nullpublic boolean isEqual(ChronoLocalDateTime<?> other)
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().
isEqual in interface ChronoLocalDateTime<LocalDate>other - the other date-time to compare to, not nullpublic boolean equals(Object obj)
Compares this LocalDateTime with another ensuring that the date-time is the same. Only objects of type LocalDateTime are compared, other types return false.
equals in interface ChronoLocalDateTime<LocalDate>equals in class Objectobj - the object to check, null returns falseObject.hashCode(), HashMappublic int hashCode()
hashCode in interface ChronoLocalDateTime<LocalDate>hashCode in class ObjectObject.equals(java.lang.Object), System.identityHashCode(java.lang.Object)public String toString()
String, such as 2007-12-03T10:15:30. The output will be one of the following ISO-8601 formats:
uuuu-MM-dd'T'HH:mmuuuu-MM-dd'T'HH:mm:ssuuuu-MM-dd'T'HH:mm:ss.SSSuuuu-MM-dd'T'HH:mm:ss.SSSSSSuuuu-MM-dd'T'HH:mm:ss.SSSSSSSSStoString in interface ChronoLocalDateTime<LocalDate>toString in class Object Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.