LocalDateTime

A date-time without a time-zone _in the ISO-8601 calendar system, such as {@code 2007-12-03T10:15:30}. !(p) {@code 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 {@code LocalDateTime}. !(p) 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. !(p) 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.

!(p) This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a> class; use of identity-sensitive operations (including reference equality ({@code ==}), identity hash code, or synchronization) on instances of {@code LocalDateTime} may have unpredictable results and should be avoided. The {@code equals} method should be used for comparisons.

@implSpec This class is immutable and thread-safe.

@since 1.8

final

class LocalDateTime : Temporal , TemporalAdjuster , ChronoLocalDateTime!(LocalDate) {

static LocalDateTime MIN();

static LocalDateTime MAX();

static LocalDateTime now();

static LocalDateTime now(ZoneId zone);

static LocalDateTime now(Clock clock);

static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute);

static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second);

static LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond);

static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute);

static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second);

static LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond);

static LocalDateTime of(LocalDate date, LocalTime time);

static LocalDateTime ofInstant(Instant instant, ZoneId zone);

static LocalDateTime ofEpochSecond(long epochSecond, int nanoOfSecond, ZoneOffset offset);

static LocalDateTime from(TemporalAccessor temporal);

bool isSupported(TemporalField field);

bool isSupported(TemporalUnit unit);

bool super_isSupported(TemporalUnit unit);

ValueRange range(TemporalField field);

int get(TemporalField field);

int super_get(TemporalField field);

long getLong(TemporalField field);

LocalDate toLocalDate();

int getYear();

int getMonthValue();

Month getMonth();

int getDayOfMonth();

int getDayOfYear();

DayOfWeek getDayOfWeek();

LocalTime toLocalTime();

int getHour();

int getMinute();

int getSecond();

int getMillisecond();

int getNano();

LocalDateTime _with(TemporalAdjuster adjuster);

LocalDateTime _with(TemporalField field, long newValue);

LocalDateTime withYear(int year);

LocalDateTime withMonth(int month);

LocalDateTime withDayOfMonth(int dayOfMonth);

LocalDateTime withDayOfYear(int dayOfYear);

LocalDateTime withHour(int hour);

LocalDateTime withMinute(int minute);

LocalDateTime withSecond(int second);

LocalDateTime withNano(int nanoOfSecond);

LocalDateTime truncatedTo(TemporalUnit unit);

LocalDateTime plus(TemporalAmount amountToAdd);

LocalDateTime plus(long amountToAdd, TemporalUnit unit);

LocalDateTime plusYears(long years);

LocalDateTime plusMonths(long months);

LocalDateTime plusWeeks(long weeks);

LocalDateTime plusDays(long days);

LocalDateTime plusHours(long hours);

LocalDateTime plusMinutes(long minutes);

LocalDateTime plusSeconds(long seconds);

LocalDateTime plusMilliseconds(long milliseconds);

LocalDateTime plusNanos(long nanos);

LocalDateTime minus(TemporalAmount amountToSubtract);

LocalDateTime minus(long amountToSubtract, TemporalUnit unit);

LocalDateTime minusYears(long years);

LocalDateTime minusMonths(long months);

LocalDateTime minusWeeks(long weeks);

LocalDateTime minusDays(long days);

LocalDateTime minusHours(long hours);

LocalDateTime minusMinutes(long minutes);

LocalDateTime minusSeconds(long seconds);

LocalDateTime minusMilliseconds(long milliseconds);

LocalDateTime minusNanos(long nanos);

R query(TemporalQuery!(R) query);

R super_query(TemporalQuery!(R) query);

Temporal adjustInto(Temporal temporal);

Temporal super_adjustInto(Temporal temporal);

long until(Temporal endExclusive, TemporalUnit unit);

OffsetDateTime atOffset(ZoneOffset offset);

ZonedDateTime atZone(ZoneId zone);

int compareTo(ChronoLocalDateTime!(ChronoLocalDate) other);

int super_compareTo(ChronoLocalDateTime!(ChronoLocalDate) other);

int opCmp(LocalDateTime other);

int opCmp(ChronoLocalDateTime!(ChronoLocalDate) other);

bool isAfter(ChronoLocalDateTime!(ChronoLocalDate) other);

bool super_isAfter(ChronoLocalDateTime!(ChronoLocalDate) other);

bool isAfter(LocalDateTime other);

bool isBefore(ChronoLocalDateTime!(ChronoLocalDate) other);

bool super_isBefore(ChronoLocalDateTime!(ChronoLocalDate) other);

bool isBefore(LocalDateTime other);

bool isEqual(ChronoLocalDateTime!(ChronoLocalDate) other);

bool super_isEqual(ChronoLocalDateTime!(ChronoLocalDate) other);

bool opEquals(Object obj);

size_t toHash();

string toString();

void writeExternal(DataOutput _out);

static LocalDateTime readExternal(DataInput _in);

Chronology getChronology();

Instant toInstant(ZoneOffset offset);

long toEpochSecond(ZoneOffset offset);

long toEpochMilli();

static LocalDateTime ofEpochMilli(long v);

static LocalDateTime ofEpochMilli(long v, ZoneId zoneId);

}

Members

Functions

_with LocalDateTime _with(TemporalAdjuster adjuster): Returns an adjusted copy of this date-time. !(p) This returns a {@code 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. !(p) 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. !(p) A selection of common adjustments is provided _in {@link hunt.time.temporal.TemporalAdjusters TemporalAdjusters}. These include finding the "last day of the month" and "next Wednesday". Key date-time classes also implement the {@code TemporalAdjuster} interface, such as {@link Month} and {@link hunt.time.MonthDay MonthDay}. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years. !(p) For example this code returns a date on the last day of July: !(pre) import hunt.time.Month.*; import hunt.time.temporal.TemporalAdjusters.*;
_with LocalDateTime _with(TemporalField field, long newValue): Returns a copy of this date-time with the specified field set to a new value. !(p) This returns a {@code 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. !(p) 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. !(p) If the field is a {@link ChronoField} then the adjustment is implemented here. The {@link #isSupported(TemporalField) supported fields} will behave as per the matching method on {@link LocalDate#_with(TemporalField, long) LocalDate} or {@link LocalTime#_with(TemporalField, long) LocalTime}. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.adjustInto(Temporal, long)} passing {@code this} as the argument. In this case, the field determines whether and how to adjust the instant. !(p) This instance is immutable and unaffected by this method call.
adjustInto Temporal adjustInto(Temporal temporal): Adjusts the specified temporal object to have the same date and time as this object. !(p) 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. !(p) The adjustment is equivalent to using {@link Temporal#_with(TemporalField, long)} twice, passing {@link ChronoField#EPOCH_DAY} and {@link ChronoField#NANO_OF_DAY} as the fields. !(p) In most cases, it is clearer to reverse the calling pattern by using {@link Temporal#_with(TemporalAdjuster)}: !(pre) // these two lines are equivalent, but the second approach is recommended temporal = thisLocalDateTime.adjustInto(temporal); temporal = temporal._with(thisLocalDateTime); </pre> !(p) This instance is immutable and unaffected by this method call.
atOffset OffsetDateTime atOffset(ZoneOffset offset): Combines this date-time with an offset to create an {@code OffsetDateTime}. !(p) This returns an {@code OffsetDateTime} formed from this date-time at the specified offset. All possible combinations of date-time and offset are valid.
atZone ZonedDateTime atZone(ZoneId zone): Combines this date-time with a time-zone to create a {@code ZonedDateTime}. !(p) This returns a {@code 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. !(p) 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 {@link ZoneRules rules} of the zone ID. !(p) 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". !(p) 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". !(p) To obtain the later offset during an overlap, call {@link ZonedDateTime#withLaterOffsetAtOverlap()} on the result of this method. To throw an exception when there is a gap or overlap, use {@link ZonedDateTime#ofStrict(LocalDateTime, ZoneOffset, ZoneId)}.
compareTo int compareTo(ChronoLocalDateTime!(ChronoLocalDate) other): Compares this date-time to another date-time. !(p) The comparison is primarily based on the date-time, from earliest to latest. It is "consistent with equals", as defined by {@link Comparable}. !(p) If all the date-times being compared are instances of {@code 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 {@link ChronoLocalDateTime#compareTo}.
get int get(TemporalField field): Gets the value of the specified field from this date-time as an {@code int}. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this date-time, except {@code NANO_OF_DAY}, {@code MICRO_OF_DAY}, {@code EPOCH_DAY} and {@code PROLEPTIC_MONTH} which are too large to fit _in an {@code int} and throw an {@code UnsupportedTemporalTypeException}. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
getChronology Chronology getChronology(): Undocumented in source. Be warned that the author may not have intended to support it.
getDayOfMonth int getDayOfMonth(): Gets the day-of-month field. !(p) This method returns the primitive {@code int} value for the day-of-month.
getDayOfWeek DayOfWeek getDayOfWeek(): Gets the day-of-week field, which is an enum {@code DayOfWeek}. !(p) This method returns the enum {@link DayOfWeek} for the day-of-week. This avoids confusion as to what {@code int} values mean. If you need access to the primitive {@code int} value then the enum provides the {@link DayOfWeek#getValue() int value}. !(p) Additional information can be obtained from the {@code DayOfWeek}. This includes textual names of the values.
getDayOfYear int getDayOfYear(): Gets the day-of-year field. !(p) This method returns the primitive {@code int} value for the day-of-year.
getHour int getHour(): Gets the hour-of-day field.
getLong long getLong(TemporalField field): Gets the value of the specified field from this date-time as a {@code long}. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this date-time. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
getMillisecond int getMillisecond(): Undocumented in source. Be warned that the author may not have intended to support it.
getMinute int getMinute(): Gets the minute-of-hour field.
getMonth Month getMonth(): Gets the month-of-year field using the {@code Month} enum. !(p) This method returns the enum {@link Month} for the month. This avoids confusion as to what {@code int} values mean. If you need access to the primitive {@code int} value then the enum provides the {@link Month#getValue() int value}.
getMonthValue int getMonthValue(): Gets the month-of-year field from 1 to 12. !(p) This method returns the month as an {@code int} from 1 to 12. Application code is frequently clearer if the enum {@link Month} is used by calling {@link #getMonth()}.
getNano int getNano(): Gets the nano-of-second field.
getSecond int getSecond(): Gets the second-of-minute field.
getYear int getYear(): Gets the year field. !(p) This method returns the primitive {@code int} value for the year. !(p) The year returned by this method is proleptic as per {@code get(YEAR)}. To obtain the year-of-era, use {@code get(YEAR_OF_ERA)}.
isAfter bool isAfter(ChronoLocalDateTime!(ChronoLocalDate) other): Checks if this date-time is after the specified date-time. !(p) This checks to see if this date-time represents a point on the local time-line after the other date-time. !(pre) 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 </pre> !(p) 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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as {@link ChronoLocalDateTime#timeLineOrder()}.
isAfter bool isAfter(LocalDateTime other): Undocumented in source. Be warned that the author may not have intended to support it.
isBefore bool isBefore(ChronoLocalDateTime!(ChronoLocalDate) other): Checks if this date-time is before the specified date-time. !(p) This checks to see if this date-time represents a point on the local time-line before the other date-time. !(pre) 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 </pre> !(p) 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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as {@link ChronoLocalDateTime#timeLineOrder()}.
isBefore bool isBefore(LocalDateTime other): Undocumented in source. Be warned that the author may not have intended to support it.
isEqual bool isEqual(ChronoLocalDateTime!(ChronoLocalDate) other): Checks if this date-time is equal to the specified date-time. !(p) This checks to see if this date-time represents the same point on the local time-line as the other date-time. !(pre) 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 </pre> !(p) 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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as {@link ChronoLocalDateTime#timeLineOrder()}.
isSupported bool isSupported(TemporalField field): Checks if the specified field is supported. !(p) This checks if this date-time can be queried for the specified field. If false, then calling the {@link #range(TemporalField) range}, {@link #get(TemporalField) get} and {@link #_with(TemporalField, long)} methods will throw an exception. !(p) If the field is a {@link ChronoField} then the query is implemented here. The supported fields are: !(ul) !(li){@code NANO_OF_SECOND} !(li){@code NANO_OF_DAY} !(li){@code MICRO_OF_SECOND} !(li){@code MICRO_OF_DAY} !(li){@code MILLI_OF_SECOND} !(li){@code MILLI_OF_DAY} !(li){@code SECOND_OF_MINUTE} !(li){@code SECOND_OF_DAY} !(li){@code MINUTE_OF_HOUR} !(li){@code MINUTE_OF_DAY} !(li){@code HOUR_OF_AMPM} !(li){@code CLOCK_HOUR_OF_AMPM} !(li){@code HOUR_OF_DAY} !(li){@code CLOCK_HOUR_OF_DAY} !(li){@code AMPM_OF_DAY} !(li){@code DAY_OF_WEEK} !(li){@code ALIGNED_DAY_OF_WEEK_IN_MONTH} !(li){@code ALIGNED_DAY_OF_WEEK_IN_YEAR} !(li){@code DAY_OF_MONTH} !(li){@code DAY_OF_YEAR} !(li){@code EPOCH_DAY} !(li){@code ALIGNED_WEEK_OF_MONTH} !(li){@code ALIGNED_WEEK_OF_YEAR} !(li){@code MONTH_OF_YEAR} !(li){@code PROLEPTIC_MONTH} !(li){@code YEAR_OF_ERA} !(li){@code YEAR} !(li){@code ERA} </ul> All other {@code ChronoField} instances will return false. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the field is supported is determined by the field.
isSupported bool isSupported(TemporalUnit unit): Checks if the specified unit is supported. !(p) This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the {@link #plus(long, TemporalUnit)} and {@link #minus(long, TemporalUnit) minus} methods will throw an exception. !(p) If the unit is a {@link ChronoUnit} then the query is implemented here. The supported units are: !(ul) !(li){@code NANOS} !(li){@code MICROS} !(li){@code MILLIS} !(li){@code SECONDS} !(li){@code MINUTES} !(li){@code HOURS} !(li){@code HALF_DAYS} !(li){@code DAYS} !(li){@code WEEKS} !(li){@code MONTHS} !(li){@code YEARS} !(li){@code DECADES} !(li){@code CENTURIES} !(li){@code MILLENNIA} !(li){@code ERAS} </ul> All other {@code ChronoUnit} instances will return false. !(p) If the unit is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)} passing {@code this} as the argument. Whether the unit is supported is determined by the unit.
minus LocalDateTime minus(TemporalAmount amountToSubtract): Returns a copy of this date-time with the specified amount subtracted. !(p) This returns a {@code LocalDateTime}, based on this one, with the specified amount subtracted. The amount is typically {@link Period} or {@link Duration} but may be any other type implementing the {@link TemporalAmount} interface. !(p) The calculation is delegated to the amount object by calling {@link TemporalAmount#subtractFrom(Temporal)}. The amount implementation is free to implement the subtraction _in any way it wishes, however it typically calls back to {@link #minus(long, TemporalUnit)}. Consult the documentation of the amount implementation to determine if it can be successfully subtracted. !(p) This instance is immutable and unaffected by this method call.
minus LocalDateTime minus(long amountToSubtract, TemporalUnit unit): Returns a copy of this date-time with the specified amount subtracted. !(p) This returns a {@code 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. !(p) This method is equivalent to {@link #plus(long, TemporalUnit)} with the amount negated. See that method for a full description of how addition, and thus subtraction, works. !(p) This instance is immutable and unaffected by this method call.
minusDays LocalDateTime minusDays(long days): Returns a copy of this {@code LocalDateTime} with the specified number of days subtracted. !(p) 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. !(p) For example, 2009-01-01 minus one day would result _in 2008-12-31. !(p) This instance is immutable and unaffected by this method call.
minusHours LocalDateTime minusHours(long hours): Returns a copy of this {@code LocalDateTime} with the specified number of hours subtracted. !(p) This instance is immutable and unaffected by this method call.
minusMilliseconds LocalDateTime minusMilliseconds(long milliseconds): Undocumented in source. Be warned that the author may not have intended to support it.
minusMinutes LocalDateTime minusMinutes(long minutes): Returns a copy of this {@code LocalDateTime} with the specified number of minutes subtracted. !(p) This instance is immutable and unaffected by this method call.
minusMonths LocalDateTime minusMonths(long months): Returns a copy of this {@code LocalDateTime} with the specified number of months subtracted. !(p) This method subtracts the specified amount from the months field _in three steps: !(ol) !(li)Subtract the input months from the month-of-year field</li> !(li)Check if the resulting date would be invalid</li> !(li)Adjust the day-of-month to the last valid day if necessary</li> </ol> !(p) For example, 2007-03-31 minus one month would result _in the invalid date 2007-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead. !(p) This instance is immutable and unaffected by this method call.
minusNanos LocalDateTime minusNanos(long nanos): Returns a copy of this {@code LocalDateTime} with the specified number of nanoseconds subtracted. !(p) This instance is immutable and unaffected by this method call.
minusSeconds LocalDateTime minusSeconds(long seconds): Returns a copy of this {@code LocalDateTime} with the specified number of seconds subtracted. !(p) This instance is immutable and unaffected by this method call.
minusWeeks LocalDateTime minusWeeks(long weeks): Returns a copy of this {@code LocalDateTime} with the specified number of weeks subtracted. !(p) 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. !(p) For example, 2009-01-07 minus one week would result _in 2008-12-31. !(p) This instance is immutable and unaffected by this method call.
minusYears LocalDateTime minusYears(long years): Returns a copy of this {@code LocalDateTime} with the specified number of years subtracted. !(p) This method subtracts the specified amount from the years field _in three steps: !(ol) !(li)Subtract the input years from the year field</li> !(li)Check if the resulting date would be invalid</li> !(li)Adjust the day-of-month to the last valid day if necessary</li> </ol> !(p) For example, 2008-02-29 (leap year) minus one year would result _in the invalid date 2007-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead. !(p) This instance is immutable and unaffected by this method call.
opCmp int opCmp(LocalDateTime other): Undocumented in source. Be warned that the author may not have intended to support it.
opCmp int opCmp(ChronoLocalDateTime!(ChronoLocalDate) other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Object obj): Checks if this date-time is equal to another date-time. !(p) Compares this {@code LocalDateTime} with another ensuring that the date-time is the same. Only objects of type {@code LocalDateTime} are compared, other types return false.
plus LocalDateTime plus(TemporalAmount amountToAdd): Returns a copy of this date-time with the specified amount added. !(p) This returns a {@code LocalDateTime}, based on this one, with the specified amount added. The amount is typically {@link Period} or {@link Duration} but may be any other type implementing the {@link TemporalAmount} interface. !(p) The calculation is delegated to the amount object by calling {@link TemporalAmount#addTo(Temporal)}. The amount implementation is free to implement the addition _in any way it wishes, however it typically calls back to {@link #plus(long, TemporalUnit)}. Consult the documentation of the amount implementation to determine if it can be successfully added. !(p) This instance is immutable and unaffected by this method call.
plus LocalDateTime plus(long amountToAdd, TemporalUnit unit): Returns a copy of this date-time with the specified amount added. !(p) This returns a {@code 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. !(p) If the field is a {@link ChronoUnit} then the addition is implemented here. Date units are added as per {@link LocalDate#plus(long, TemporalUnit)}. Time units are added as per {@link LocalTime#plus(long, TemporalUnit)} with any overflow _in days added equivalent to using {@link #plusDays(long)}. !(p) If the field is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.addTo(Temporal, long)} passing {@code this} as the argument. In this case, the unit determines whether and how to perform the addition. !(p) This instance is immutable and unaffected by this method call.
plusDays LocalDateTime plusDays(long days): Returns a copy of this {@code LocalDateTime} with the specified number of days added. !(p) 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. !(p) For example, 2008-12-31 plus one day would result _in 2009-01-01. !(p) This instance is immutable and unaffected by this method call.
plusHours LocalDateTime plusHours(long hours): Returns a copy of this {@code LocalDateTime} with the specified number of hours added. !(p) This instance is immutable and unaffected by this method call.
plusMilliseconds LocalDateTime plusMilliseconds(long milliseconds): Undocumented in source. Be warned that the author may not have intended to support it.
plusMinutes LocalDateTime plusMinutes(long minutes): Returns a copy of this {@code LocalDateTime} with the specified number of minutes added. !(p) This instance is immutable and unaffected by this method call.
plusMonths LocalDateTime plusMonths(long months): Returns a copy of this {@code LocalDateTime} with the specified number of months added. !(p) This method adds the specified amount to the months field _in three steps: !(ol) !(li)Add the input months to the month-of-year field</li> !(li)Check if the resulting date would be invalid</li> !(li)Adjust the day-of-month to the last valid day if necessary</li> </ol> !(p) 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. !(p) This instance is immutable and unaffected by this method call.
plusNanos LocalDateTime plusNanos(long nanos): Returns a copy of this {@code LocalDateTime} with the specified number of nanoseconds added. !(p) This instance is immutable and unaffected by this method call.
plusSeconds LocalDateTime plusSeconds(long seconds): Returns a copy of this {@code LocalDateTime} with the specified number of seconds added. !(p) This instance is immutable and unaffected by this method call.
plusWeeks LocalDateTime plusWeeks(long weeks): Returns a copy of this {@code LocalDateTime} with the specified number of weeks added. !(p) 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. !(p) For example, 2008-12-31 plus one week would result _in 2009-01-07. !(p) This instance is immutable and unaffected by this method call.
plusYears LocalDateTime plusYears(long years): Returns a copy of this {@code LocalDateTime} with the specified number of years added. !(p) This method adds the specified amount to the years field _in three steps: !(ol) !(li)Add the input years to the year field</li> !(li)Check if the resulting date would be invalid</li> !(li)Adjust the day-of-month to the last valid day if necessary</li> </ol> !(p) 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. !(p) This instance is immutable and unaffected by this method call.
query R query(TemporalQuery!(R) query): Queries this date-time using the specified query. !(p) This queries this date-time using the specified query strategy object. The {@code 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. !(p) The result of this method is obtained by invoking the {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the specified query passing {@code this} as the argument.
range ValueRange range(TemporalField field): Gets the range of valid values for the specified field. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return appropriate range instances. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the range can be obtained is determined by the field.
super_adjustInto Temporal super_adjustInto(Temporal temporal): Undocumented in source. Be warned that the author may not have intended to support it.
super_compareTo int super_compareTo(ChronoLocalDateTime!(ChronoLocalDate) other): Undocumented in source. Be warned that the author may not have intended to support it.
super_get int super_get(TemporalField field): Undocumented in source. Be warned that the author may not have intended to support it.
super_isAfter bool super_isAfter(ChronoLocalDateTime!(ChronoLocalDate) other): Undocumented in source. Be warned that the author may not have intended to support it.
super_isBefore bool super_isBefore(ChronoLocalDateTime!(ChronoLocalDate) other): Undocumented in source. Be warned that the author may not have intended to support it.
super_isEqual bool super_isEqual(ChronoLocalDateTime!(ChronoLocalDate) other): Undocumented in source. Be warned that the author may not have intended to support it.
super_isSupported bool super_isSupported(TemporalUnit unit): Undocumented in source. Be warned that the author may not have intended to support it.
super_query R super_query(TemporalQuery!(R) query): Undocumented in source. Be warned that the author may not have intended to support it.
toEpochMilli long toEpochMilli(): Undocumented in source. Be warned that the author may not have intended to support it.
toEpochSecond long toEpochSecond(ZoneOffset offset): Undocumented in source. Be warned that the author may not have intended to support it.
toHash size_t toHash(): A hash code for this date-time.
toInstant Instant toInstant(ZoneOffset offset): Undocumented in source. Be warned that the author may not have intended to support it.
toLocalDate LocalDate toLocalDate(): Gets the {@code LocalDate} part of this date-time. !(p) This returns a {@code LocalDate} with the same year, month and day as this date-time.
toLocalTime LocalTime toLocalTime(): Gets the {@code LocalTime} part of this date-time. !(p) This returns a {@code LocalTime} with the same hour, minute, second and nanosecond as this date-time.
toString string toString(): Outputs this date-time as a {@code string}, such as {@code 2007-12-03T10:15:30}. !(p) The output will be one of the following ISO-8601 formats: !(ul) !(li){@code uuuu-MM-dd'T'HH:mm}</li> !(li){@code uuuu-MM-dd'T'HH:mm:ss}</li> !(li){@code uuuu-MM-dd'T'HH:mm:ss.SSS}</li> !(li){@code uuuu-MM-dd'T'HH:mm:ss.SSSSSS}</li> !(li){@code uuuu-MM-dd'T'HH:mm:ss.SSSSSSSSS}</li> </ul> The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.
truncatedTo LocalDateTime truncatedTo(TemporalUnit unit): Returns a copy of this {@code LocalDateTime} with the time truncated. !(p) Truncation returns a copy of the original date-time with fields smaller than the specified unit set to zero. For example, truncating with the {@link ChronoUnit#MINUTES minutes} unit will set the second-of-minute and nano-of-second field to zero. !(p) The unit must have a {@linkplain TemporalUnit#getDuration() duration} that divides into the length of a standard day without remainder. This includes all supplied time units on {@link ChronoUnit} and {@link ChronoUnit#DAYS DAYS}. Other units throw an exception. !(p) This instance is immutable and unaffected by this method call.
until long until(Temporal endExclusive, TemporalUnit unit): Calculates the amount of time until another date-time _in terms of the specified unit. !(p) This calculates the amount of time between two {@code LocalDateTime} objects _in terms of a single {@code TemporalUnit}. The start and end points are {@code this} and the specified date-time. The result will be negative if the end is before the start. The {@code Temporal} passed to this method is converted to a {@code LocalDateTime} using {@link #from(TemporalAccessor)}. For example, the amount _in days between two date-times can be calculated using {@code startDateTime.until(endDateTime, DAYS)}. !(p) 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. !(p) There are two equivalent ways of using this method. The first is to invoke this method. The second is to use {@link TemporalUnit#between(Temporal, Temporal)}: !(pre) // these two lines are equivalent amount = start.until(end, MONTHS); amount = MONTHS.between(start, end); </pre> The choice should be made based on which makes the code more readable. !(p) The calculation is implemented _in this method for {@link ChronoUnit}. The units {@code NANOS}, {@code MICROS}, {@code MILLIS}, {@code SECONDS}, {@code MINUTES}, {@code HOURS} and {@code HALF_DAYS}, {@code DAYS}, {@code WEEKS}, {@code MONTHS}, {@code YEARS}, {@code DECADES}, {@code CENTURIES}, {@code MILLENNIA} and {@code ERAS} are supported. Other {@code ChronoUnit} values will throw an exception. !(p) If the unit is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.between(Temporal, Temporal)} passing {@code this} as the first argument and the converted input temporal as the second argument. !(p) This instance is immutable and unaffected by this method call.
withDayOfMonth LocalDateTime withDayOfMonth(int dayOfMonth): Returns a copy of this {@code LocalDateTime} with the day-of-month altered. !(p) 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. !(p) This instance is immutable and unaffected by this method call.
withDayOfYear LocalDateTime withDayOfYear(int dayOfYear): Returns a copy of this {@code LocalDateTime} with the day-of-year altered. !(p) If the resulting date-time is invalid, an exception is thrown. !(p) This instance is immutable and unaffected by this method call.
withHour LocalDateTime withHour(int hour): Returns a copy of this {@code LocalDateTime} with the hour-of-day altered. !(p) This instance is immutable and unaffected by this method call.
withMinute LocalDateTime withMinute(int minute): Returns a copy of this {@code LocalDateTime} with the minute-of-hour altered. !(p) This instance is immutable and unaffected by this method call.
withMonth LocalDateTime withMonth(int month): Returns a copy of this {@code LocalDateTime} with the month-of-year altered. !(p) 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. !(p) This instance is immutable and unaffected by this method call.
withNano LocalDateTime withNano(int nanoOfSecond): Returns a copy of this {@code LocalDateTime} with the nano-of-second altered. !(p) This instance is immutable and unaffected by this method call.
withSecond LocalDateTime withSecond(int second): Returns a copy of this {@code LocalDateTime} with the second-of-minute altered. !(p) This instance is immutable and unaffected by this method call.
withYear LocalDateTime withYear(int year): Returns a copy of this {@code LocalDateTime} with the year altered. !(p) 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. !(p) This instance is immutable and unaffected by this method call.
writeExternal void writeExternal(DataOutput _out): Defend against malicious streams.

Static functions

MAX LocalDateTime MAX(): The maximum supported {@code 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 {@link LocalDate#MAX} and {@link LocalTime#MAX}. This could be used by an application as a "far future" date-time.
MIN LocalDateTime MIN(): The minimum supported {@code LocalDateTime}, '-999999999-01-01T00:00:00'. This is the local date-time of midnight at the start of the minimum date. This combines {@link LocalDate#MIN} and {@link LocalTime#MIN}. This could be used by an application as a "far past" date-time.
from LocalDateTime from(TemporalAccessor temporal): Obtains an instance of {@code LocalDateTime} from a temporal object. !(p) This obtains a local date-time based on the specified temporal. A {@code TemporalAccessor} represents an arbitrary set of date and time information, which this factory converts to an instance of {@code LocalDateTime}. !(p) The conversion extracts and combines the {@code LocalDate} and the {@code LocalTime} from the temporal object. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects. !(p) This method matches the signature of the functional interface {@link TemporalQuery} allowing it to be used as a query via method reference, {@code LocalDateTime.from}.
now LocalDateTime now(): Obtains the current date-time from the system clock _in the default time-zone. !(p) This will query the {@link Clock#systemDefaultZone() system clock} _in the default time-zone to obtain the current date-time. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
now LocalDateTime now(ZoneId zone): Obtains the current date-time from the system clock _in the specified time-zone. !(p) This will query the {@link Clock#system(ZoneId) system clock} to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
now LocalDateTime now(Clock clock): Obtains the current date-time from the specified clock. !(p) 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 {@link Clock dependency injection}.
of LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute): Obtains an instance of {@code LocalDateTime} from year, month, day, hour and minute, setting the second and nanosecond to zero. !(p) This returns a {@code 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.
of LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second): Obtains an instance of {@code LocalDateTime} from year, month, day, hour, minute and second, setting the nanosecond to zero. !(p) This returns a {@code 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.
of LocalDateTime of(int year, Month month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond): Obtains an instance of {@code LocalDateTime} from year, month, day, hour, minute, second and nanosecond. !(p) This returns a {@code 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.
of LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute): Obtains an instance of {@code LocalDateTime} from year, month, day, hour and minute, setting the second and nanosecond to zero. !(p) This returns a {@code 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.
of LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second): Obtains an instance of {@code LocalDateTime} from year, month, day, hour, minute and second, setting the nanosecond to zero. !(p) This returns a {@code 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.
of LocalDateTime of(int year, int month, int dayOfMonth, int hour, int minute, int second, int nanoOfSecond): Obtains an instance of {@code LocalDateTime} from year, month, day, hour, minute, second and nanosecond. !(p) This returns a {@code 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.
of LocalDateTime of(LocalDate date, LocalTime time): Obtains an instance of {@code LocalDateTime} from a date and time.
ofEpochMilli LocalDateTime ofEpochMilli(long v): Undocumented in source. Be warned that the author may not have intended to support it.
ofEpochMilli LocalDateTime ofEpochMilli(long v, ZoneId zoneId): Undocumented in source. Be warned that the author may not have intended to support it.
ofEpochSecond LocalDateTime ofEpochSecond(long epochSecond, int nanoOfSecond, ZoneOffset offset): Obtains an instance of {@code LocalDateTime} using seconds from the epoch of 1970-01-01T00:00:00Z. !(p) This allows the {@link ChronoField#INSTANT_SECONDS epoch-second} field to be converted to a local date-time. This is primarily intended for low-level conversions rather than general application usage.
ofInstant LocalDateTime ofInstant(Instant instant, ZoneId zone): Obtains an instance of {@code LocalDateTime} from an {@code Instant} and zone ID. !(p) 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.
readExternal LocalDateTime readExternal(DataInput _in): Undocumented in source. Be warned that the author may not have intended to support it.

Inherited Members

From Temporal

isSupported bool isSupported(TemporalUnit unit): Checks if the specified unit is supported. !(p) This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the {@link #plus(long, TemporalUnit)} and {@link #minus(long, TemporalUnit) minus} methods will throw an exception.
isSupported bool isSupported(TemporalField field): Undocumented in source.
_with Temporal _with(TemporalAdjuster adjuster): Returns an adjusted object of the same type as this object with the adjustment made. !(p) 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 {@link hunt.time.temporal.TemporalAdjusters 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. !(p) Some example code indicating how and why this method is used: !(pre) 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 </pre>
_with Temporal _with(TemporalField field, long newValue): Returns an object of the same type as this object with the specified field altered. !(p) This returns a new object based on this one with the value for the specified field changed. For example, on a {@code 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. !(p) 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.
plus Temporal plus(TemporalAmount amount): Returns an object of the same type as this object with an amount added. !(p) This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a {@link hunt.time.Period} but may be any other type implementing the {@link TemporalAmount} interface, such as {@link hunt.time.Duration}. !(p) Some example code indicating how and why this method is used: !(pre) 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 </pre> !(p) Note that calling {@code plus} followed by {@code minus} is not guaranteed to return the same date-time.
plus Temporal plus(long amountToAdd, TemporalUnit unit): Returns an object of the same type as this object with the specified period added. !(p) This method returns a new object based on this one with the specified period added. For example, on a {@code 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. !(p) 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.
minus Temporal minus(TemporalAmount amount): Returns an object of the same type as this object with an amount subtracted. !(p) This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a {@link hunt.time.Period} but may be any other type implementing the {@link TemporalAmount} interface, such as {@link hunt.time.Duration}. !(p) Some example code indicating how and why this method is used: !(pre) 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 </pre> !(p) Note that calling {@code plus} followed by {@code minus} is not guaranteed to return the same date-time.
minus Temporal minus(long amountToSubtract, TemporalUnit unit): Returns an object of the same type as this object with the specified period subtracted. !(p) This method returns a new object based on this one with the specified period subtracted. For example, on a {@code 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. !(p) 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.
until long until(Temporal endExclusive, TemporalUnit unit): Calculates the amount of time until another temporal _in terms of the specified unit. !(p) This calculates the amount of time between two temporal objects _in terms of a single {@code TemporalUnit}. The start and end points are {@code this} and the specified temporal. The end point is converted to be of the same type as the start point if different. The result will be negative if the end is before the start. For example, the amount _in hours between two temporal objects can be calculated using {@code startTime.until(endTime, HOURS)}. !(p) The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the amount _in hours between the times 11:30 and 13:29 will only be one hour as it is one minute short of two hours. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link TemporalUnit#between(Temporal, Temporal)}: !(pre) // these two lines are equivalent temporal = start.until(end, unit); temporal = unit.between(start, end); </pre> The choice should be made based on which makes the code more readable. !(p) For example, this method allows the number of days between two dates to be calculated: !(pre) long daysBetween = start.until(end, DAYS); // or alternatively long daysBetween = DAYS.between(start, end); </pre>

From TemporalAdjuster

adjustInto Temporal adjustInto(Temporal temporal): Adjusts the specified temporal object. !(p) This adjusts the specified temporal object using the logic encapsulated _in the implementing class. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link Temporal#_with(TemporalAdjuster)}: !(pre) // these two lines are equivalent, but the second approach is recommended temporal = thisAdjuster.adjustInto(temporal); temporal = temporal._with(thisAdjuster); </pre> It is recommended to use the second approach, {@code _with(TemporalAdjuster)}, as it is a lot clearer to read _in code.

Meta

Source

See Implementation

hunt time LocalDateTime classes

LocalDateTime