LocalDateTime

adjustInto

fun adjustInto(temporal: Temporal!): Temporal!

Adjusts the specified temporal object to have the same date and time as this object.

This returns a temporal object of the same observable type as the input with the date and time changed to be the same as this.

The adjustment is equivalent to using Temporal#with(TemporalField, long) twice, passing ChronoField#EPOCH_DAY and ChronoField#NANO_OF_DAY as the fields.

In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster):

// these two lines are equivalent, but the second approach is recommended
    temporal = thisLocalDateTime.adjustInto(temporal);
    temporal = temporal.with(thisLocalDateTime);
  

This instance is immutable and unaffected by this method call.

atOffset

fun atOffset(offset: ZoneOffset!): OffsetDateTime!

Combines this date-time with an offset to create an OffsetDateTime.

This returns an OffsetDateTime formed from this date-time at the specified offset. All possible combinations of date-time and offset are valid.

atZone

fun atZone(zone: ZoneId!): ZonedDateTime!

Combines this date-time with a time-zone to create a ZonedDateTime.

This returns a ZonedDateTime formed from this date-time at the specified time-zone. The result will match this date-time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, where clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".

In the case of a gap, where clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

To obtain the later offset during an overlap, call ZonedDateTime#withLaterOffsetAtOverlap() on the result of this method. To throw an exception when there is a gap or overlap, use ZonedDateTime#ofStrict(LocalDateTime, ZoneOffset, ZoneId).

compareTo

fun compareTo(other: ChronoLocalDateTime<*>!): Int

Compares this date-time to another date-time.

The comparison is primarily based on the date-time, from earliest to latest. It is "consistent with equals", as defined by Comparable.

If all the date-times being compared are instances of LocalDateTime, then the comparison will be entirely based on the date-time. If some dates being compared are in different chronologies, then the chronology is also considered, see ChronoLocalDateTime#compareTo.

equals

fun equals(other: Any?): Boolean

Checks if this date-time is equal to another date-time.

Compares this LocalDateTime with another ensuring that the date-time is the same. Only objects of type LocalDateTime are compared, other types return false.

format

fun format(formatter: DateTimeFormatter!): String!

Formats this date-time using the specified formatter.

This date-time will be passed to the formatter to produce a string.

from

static fun from(temporal: TemporalAccessor!): LocalDateTime!

Obtains an instance of 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.

get

fun get(field: TemporalField!): Int

Gets the value of the specified field from this date-time as an int.

This queries this date-time for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY, EPOCH_DAY and PROLEPTIC_MONTH which are too large to fit in an int and throw an UnsupportedTemporalTypeException. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getDayOfMonth

fun getDayOfMonth(): Int

Gets the day-of-month field.

This method returns the primitive int value for the day-of-month.

getDayOfWeek

fun getDayOfWeek(): DayOfWeek!

Gets the day-of-week field, which is an enum 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.

getDayOfYear

fun getDayOfYear(): Int

Gets the day-of-year field.

This method returns the primitive int value for the day-of-year.

getHour

fun getHour(): Int

Gets the hour-of-day field.

getLong

fun getLong(field: TemporalField!): Long

Gets the value of the specified field from this date-time as a long.

This queries this date-time for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getMinute

fun getMinute(): Int

Gets the minute-of-hour field.

getMonth

fun getMonth(): Month!

Gets the month-of-year field using the 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

fun getMonthValue(): Int

Gets the month-of-year field from 1 to 12.

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().

getNano

fun getNano(): Int

Gets the nano-of-second field.

getSecond

fun getSecond(): Int

Gets the second-of-minute field.

getYear

fun getYear(): Int

Gets the year field.

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).

hashCode

fun hashCode(): Int

A hash code for this date-time.

isAfter

fun isAfter(other: ChronoLocalDateTime<*>!): Boolean

Checks if this date-time is after the specified date-time.

This checks to see if this date-time represents a point on the local time-line after the other date-time.

LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00);
    LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00);
    a.isAfter(b) == false
    a.isAfter(a) == false
    b.isAfter(a) == true
  

This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in compareTo(java.time.chrono.ChronoLocalDateTime), but is the same approach as ChronoLocalDateTime#timeLineOrder().

isBefore

fun isBefore(other: ChronoLocalDateTime<*>!): Boolean

Checks if this date-time is before the specified date-time.

This checks to see if this date-time represents a point on the local time-line before the other date-time.

LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00);
    LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00);
    a.isBefore(b) == true
    a.isBefore(a) == false
    b.isBefore(a) == false
  

This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in compareTo(java.time.chrono.ChronoLocalDateTime), but is the same approach as ChronoLocalDateTime#timeLineOrder().

isEqual

fun isEqual(other: ChronoLocalDateTime<*>!): Boolean

Checks if this date-time is equal to the specified date-time.

This checks to see if this date-time represents the same point on the local time-line as the other date-time.

LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00);
    LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00);
    a.isEqual(b) == false
    a.isEqual(a) == true
    b.isEqual(a) == false
  

This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in compareTo(java.time.chrono.ChronoLocalDateTime), but is the same approach as ChronoLocalDateTime#timeLineOrder().

isSupported

fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if this date-time can be queried for the specified field. If false, then calling the range, get and with(java.time.temporal.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

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

fun isSupported(unit: TemporalUnit!): Boolean

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the plus(long,java.time.temporal.TemporalUnit) and minus methods will throw an exception.

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

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.

minus

fun minus(amountToSubtract: TemporalAmount!): LocalDateTime!

Returns a copy of this date-time with the specified amount subtracted.

This returns a LocalDateTime, based on this one, with the specified amount subtracted. The amount is typically Period or Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long,java.time.temporal.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

fun minus(
    amountToSubtract: Long, 
    unit: TemporalUnit!
): LocalDateTime!

Returns a copy of this date-time with the specified amount subtracted.

This returns a LocalDateTime, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.

This method is equivalent to plus(long,java.time.temporal.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.

minusDays

fun minusDays(days: Long): LocalDateTime!

Returns a copy of this 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.

minusHours

fun minusHours(hours: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of hours subtracted.

This instance is immutable and unaffected by this method call.

minusMinutes

fun minusMinutes(minutes: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of minutes subtracted.

This instance is immutable and unaffected by this method call.

minusMonths

fun minusMonths(months: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of months subtracted.

This method subtracts the specified amount from the months field in three steps:

1. Subtract the input months from the month-of-year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

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.

This instance is immutable and unaffected by this method call.

minusNanos

fun minusNanos(nanos: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of nanoseconds subtracted.

This instance is immutable and unaffected by this method call.

minusSeconds

fun minusSeconds(seconds: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of seconds subtracted.

This instance is immutable and unaffected by this method call.

minusWeeks

fun minusWeeks(weeks: Long): LocalDateTime!

Returns a copy of this 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.

minusYears

fun minusYears(years: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of years subtracted.

This method subtracts the specified amount from the years field in three steps:

1. Subtract the input years from the year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

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.

This instance is immutable and unaffected by this method call.

now

static fun now(): LocalDateTime!

Obtains the current date-time from the system clock in the default time-zone.

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.

now

static fun now(zone: ZoneId!): LocalDateTime!

Obtains the current date-time from the system clock in the specified time-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.

now

static fun now(clock: Clock!): LocalDateTime!

Obtains the current date-time from the specified 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.

of

static fun of(
    year: Int, 
    month: Month!, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    year: Int, 
    month: Month!, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int, 
    second: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    year: Int, 
    month: Month!, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int, 
    second: Int, 
    nanoOfSecond: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    year: Int, 
    month: Int, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    year: Int, 
    month: Int, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int, 
    second: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    year: Int, 
    month: Int, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int, 
    second: Int, 
    nanoOfSecond: Int
): LocalDateTime!

Obtains an instance of 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.

of

static fun of(
    date: LocalDate!, 
    time: LocalTime!
): LocalDateTime!

Obtains an instance of LocalDateTime from a date and time.

ofEpochSecond

static fun ofEpochSecond(
    epochSecond: Long, 
    nanoOfSecond: Int, 
    offset: ZoneOffset!
): LocalDateTime!

Obtains an instance of 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.

ofInstant

static fun ofInstant(
    instant: Instant!, 
    zone: ZoneId!
): LocalDateTime!

Obtains an instance of 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.

parse

static fun parse(text: CharSequence!): LocalDateTime!

Obtains an instance of LocalDateTime from a text string such as 2007-12-03T10:15:30.

The string must represent a valid date-time and is parsed using java.time.format.DateTimeFormatter#ISO_LOCAL_DATE_TIME.

parse

static fun parse(
    text: CharSequence!, 
    formatter: DateTimeFormatter!
): LocalDateTime!

Obtains an instance of LocalDateTime from a text string using a specific formatter.

The text is parsed using the formatter, returning a date-time.

plus

fun plus(amountToAdd: TemporalAmount!): LocalDateTime!

Returns a copy of this date-time with the specified amount added.

This returns a LocalDateTime, based on this one, with the specified amount added. The amount is typically Period or Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long,java.time.temporal.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

fun plus(
    amountToAdd: Long, 
    unit: TemporalUnit!
): LocalDateTime!

Returns a copy of this date-time with the specified amount added.

This returns a LocalDateTime, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.

If the field is a ChronoUnit then the addition is implemented here. Date units are added as per LocalDate#plus(long, TemporalUnit). Time units are added as per LocalTime#plus(long, TemporalUnit) with any overflow in days added equivalent to using plusDays(long).

If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the argument. In this case, the unit determines whether and how to perform the addition.

This instance is immutable and unaffected by this method call.

plusDays

fun plusDays(days: Long): LocalDateTime!

Returns a copy of this 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.

plusHours

fun plusHours(hours: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of hours added.

This instance is immutable and unaffected by this method call.

plusMinutes

fun plusMinutes(minutes: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of minutes added.

This instance is immutable and unaffected by this method call.

plusMonths

fun plusMonths(months: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of months added.

This method adds the specified amount to the months field in three steps:

1. Add the input months to the month-of-year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

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.

plusNanos

fun plusNanos(nanos: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of nanoseconds added.

This instance is immutable and unaffected by this method call.

plusSeconds

fun plusSeconds(seconds: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of seconds added.

This instance is immutable and unaffected by this method call.

plusWeeks

fun plusWeeks(weeks: Long): LocalDateTime!

Returns a copy of this 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.

plusYears

fun plusYears(years: Long): LocalDateTime!

Returns a copy of this LocalDateTime with the specified number of years added.

This method adds the specified amount to the years field in three steps:

1. Add the input years to the year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

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.

query

fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this date-time using the specified query.

This queries this date-time using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

range

fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This date-time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

toLocalDate

fun toLocalDate(): LocalDate!

Gets the LocalDate part of this date-time.

This returns a LocalDate with the same year, month and day as this date-time.

toLocalTime

fun toLocalTime(): LocalTime!

Gets the LocalTime part of this date-time.

This returns a LocalTime with the same hour, minute, second and nanosecond as this date-time.

toString

fun toString(): String

Outputs this date-time as a String, such as 2007-12-03T10:15:30.

The output will be one of the following ISO-8601 formats:

• uuuu-MM-dd'T'HH:mm
• uuuu-MM-dd'T'HH:mm:ss
• uuuu-MM-dd'T'HH:mm:ss.SSS
• uuuu-MM-dd'T'HH:mm:ss.SSSSSS
• uuuu-MM-dd'T'HH:mm:ss.SSSSSSSSS

truncatedTo

fun truncatedTo(unit: TemporalUnit!): LocalDateTime!

Returns a copy of this 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.

until

fun until(
    endExclusive: Temporal!, 
    unit: TemporalUnit!
): Long

Calculates the amount of time until another date-time in terms of the specified unit.

This calculates the amount of time between two LocalDateTime objects in terms of a single TemporalUnit. The start and end points are this and the specified date-time. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a LocalDateTime using #from(java.time.temporal.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 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.

with

fun with(adjuster: TemporalAdjuster!): LocalDateTime!

Returns an adjusted copy of this date-time.

This returns a LocalDateTime, based on this one, with the date-time adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month.

A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". Key date-time classes also implement the TemporalAdjuster interface, such as Month and MonthDay. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

For example this code returns a date on the last day of July:

import static java.time.Month.*;
   import static java.time.temporal.TemporalAdjusters.*;
 
   result = localDateTime.with(JULY).with(lastDayOfMonth());
  

The classes LocalDate and LocalTime implement TemporalAdjuster, thus this method can be used to change the date, time or offset:

result = localDateTime.with(date);
   result = localDateTime.with(time);
  

The result of this method is obtained by invoking the TemporalAdjuster#adjustInto(Temporal) method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

with

fun with(
    field: TemporalField!, 
    newValue: Long
): LocalDateTime!

Returns a copy of this date-time with the specified field set to a new value.

This returns a LocalDateTime, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the year, month or day-of-month. If it is not possible to set the value, because the field is not supported or for some other reason, an exception is thrown.

In some cases, changing the specified field can cause the resulting date-time to become invalid, such as changing the month from 31st January to February would make the day-of-month invalid. In cases like this, the field is responsible for resolving the date. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

If the field is a ChronoField then the adjustment is implemented here. The supported fields will behave as per the matching method on LocalDate or LocalTime. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long) passing this as the argument. In this case, the field determines whether and how to adjust the instant.

This instance is immutable and unaffected by this method call.

withDayOfMonth

fun withDayOfMonth(dayOfMonth: Int): LocalDateTime!

Returns a copy of this 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.

withDayOfYear

fun withDayOfYear(dayOfYear: Int): LocalDateTime!

Returns a copy of this 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.

withHour

fun withHour(hour: Int): LocalDateTime!

Returns a copy of this LocalDateTime with the hour-of-day altered.

This instance is immutable and unaffected by this method call.

withMinute

fun withMinute(minute: Int): LocalDateTime!

Returns a copy of this LocalDateTime with the minute-of-hour altered.

This instance is immutable and unaffected by this method call.

withMonth

fun withMonth(month: Int): LocalDateTime!

Returns a copy of this 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.

withNano

fun withNano(nanoOfSecond: Int): LocalDateTime!

Returns a copy of this LocalDateTime with the nano-of-second altered.

This instance is immutable and unaffected by this method call.

withSecond

fun withSecond(second: Int): LocalDateTime!

Returns a copy of this LocalDateTime with the second-of-minute altered.

This instance is immutable and unaffected by this method call.

withYear

fun withYear(year: Int): LocalDateTime!

Returns a copy of this 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.

MAX

static val MAX: LocalDateTime!

The maximum supported 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.

MIN

static val MIN: LocalDateTime!

The minimum supported 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.