LocalDateTime

Obtains an instance of LocalDateTime from a temporal object.

A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of LocalDateTime.

The conversion extracts and combines LocalDate and LocalTime.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, LocalDateTime::from.

Throw:

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

If the argument is an instance of 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.

If the argument is an instance of ZoneId this will query the system clock (see Clock#system) to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone.

If nor argument is applied, the system default time zone is used 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.

function overloading for LocalDateTime.of

if called with 2 arguments and first argument is an instance of LocalDate and second is an instance of LocalTime, then LocalDateTime.ofDateAndTime is executed.

Otherwise LocalDateTime.ofNumbers is executed.

Obtains an instance of LocalDateTime from a date and time.

Obtains an instance of LocalDateTime using seconds from the epoch of 1970-01-01T00:00:00Z.

This allows the 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.

Throw:

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.

Throw:

Obtains an instance of LocalDateTime from year, month, day, hour, minute, second and nanosecond.

The day must be valid for the year and month, otherwise an exception will be thrown.

Throw:

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

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

Throw:

Constructor.

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 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:

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

Override:

Throw:

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

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.

Gets the day-of-month field.

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

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, use DayOfWeek#getValue.

Additional information can be obtained from the DayOfWeek. This includes textual names of the values.

Gets the day-of-year field.

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

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.

Outputs this date-time as a string using the formatter.

Throw:

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

This queries this date-time for the value for 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 (see isSupported) will return valid values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY, EPOCH_DAY and EPOCH_MONTH which are too large to fit in an int and throw a DateTimeException. All other ChronoField instances will throw a DateTimeException.

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

Override:

Throw:

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

This queries this date-time for the value for 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 (see isSupported) will return valid values based on this date-time. All other ChronoField instances will throw a DateTimeException.

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

Throw:

A hash code for this date-time.

Gets the hour-of-day field.

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, but is the same approach as DATE_TIME_COMPARATOR.

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, but is the same approach as DATE_TIME_COMPARATOR.

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, but is the same approach as DATE_TIME_COMPARATOR.

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 LocalDateTime.range range and LocalDateTime.get get methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields are:

• ChronoField.NANO_OF_SECOND
• ChronoField.NANO_OF_DAY
• ChronoField.MICRO_OF_SECOND
• ChronoField.MICRO_OF_DAY
• ChronoField.MILLI_OF_SECOND
• ChronoField.MILLI_OF_DAY
• ChronoField.SECOND_OF_MINUTE
• ChronoField.SECOND_OF_DAY
• ChronoField.MINUTE_OF_HOUR
• ChronoField.MINUTE_OF_DAY
• ChronoField.HOUR_OF_AMPM
• ChronoField.CLOCK_HOUR_OF_AMPM
• ChronoField.HOUR_OF_DAY
• ChronoField.CLOCK_HOUR_OF_DAY
• ChronoField.AMPM_OF_DAY
• ChronoField.DAY_OF_WEEK
• ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH
• ChronoField.ALIGNED_DAY_OF_WEEK_IN_YEAR
• ChronoField.DAY_OF_MONTH
• ChronoField.DAY_OF_YEAR
• ChronoField.EPOCH_DAY
• ChronoField.ALIGNED_WEEK_OF_MONTH
• ChronoField.ALIGNED_WEEK_OF_YEAR
• ChronoField.MONTH_OF_YEAR
• ChronoField.EPOCH_MONTH
• ChronoField.YEAR_OF_ERA
• ChronoField.YEAR
• ChronoField.ERA

All other ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy passing this as the argument. Whether the field is supported is determined by the field.

function overloading for LocalDateTime.minus

if called with 1 argument LocalDateTime.minusTemporalAmount is applied, otherwise LocalDateTime.minus2

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

This method returns a new date-time based on this date-time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in days subtracted.

This method subtracts the specified amount from 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, 2009-01-01 minus one day would result in 2008-12-31.

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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-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.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This method returns a new date-time based on this time with the specified period subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to minus.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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 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.

Throw:

Gets the minute-of-hour field.

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, use Month#getValue.

See:

• #getMonthValue()

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.

See:

• #getMonth()

Gets the nano-of-second field.

function overloading for LocalDateTime.plus

if called with 1 argument LocalDateTime.plusTemporalAmount is applied, otherwise LocalDateTime.plus2

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

This method returns a new date-time based on this date-time with the specified period added. This can be used to add any period that is defined by a unit, for example to add years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This method returns a new date-time based on this time with the specified period added. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to plus.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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.

Throw:

Returns a copy of this LocalDateTime with the specified period in 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.

Throw:

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 method on the specified query passing this as the argument.

Override:

Throw:

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 (see isSupported) will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.

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

Override:

Throw:

Gets the second-of-minute field.

Gets the LocalDate part of this date-time.

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

Gets the LocalTime part of this date-time.

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

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:

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

The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.

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 ChronoUnit#MINUTES will set the second-of-minute and nano-of-second field to zero.

The unit must have a duration (see TemporalUnit#getDuration) that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and ChronoUnit#DAYS. Other units throw an exception.

This instance is immutable and unaffected by this method call.

Throw:

Calculates the period between this date-time and another date-time in terms of the specified unit.

This calculates the period between two date-times in terms of a single unit. 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 must be a LocalDateTime. For example, the period 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 period 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.

This method operates in association with TemporalUnit#between. The result of this method is a long representing the amount of the specified unit. By contrast, the result of between is an object that can be used directly in addition/subtraction:

  long period = start.until(end, MONTHS);   // this method
  dateTime.plus(MONTHS.between(start, end));      // use in plus/minus

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 passing this as the first argument and the input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Throw:

function overloading for LocalDateTime.with

if called with 1 argument, LocalDateTime.withTemporalAdjuster is applied, otherwise LocalDateTime.with2.

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

This returns a new 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 (see isSupported) will behave as in LocalDate#with or LocalTime#with. All other ChronoField instances will throw a DateTimeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto 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.

Throw:

Returns a copy of this LocalDateTime with the day-of-month altered. If the resulting LocalDateTime 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.

Throw:

Returns a copy of this LocalDateTime with the day-of-year altered. If the resulting LocalDateTime is invalid, an exception is thrown.

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

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

This instance is immutable and unaffected by this method call.

Throw:

Returns an adjusted copy of this date-time.

This returns a new 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 org.threeten.bp.Month.;
 import static org.threeten.bp.temporal.Adjusters.;

 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 method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

Throw:

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.

Throw:

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