Home Reference Source
import {LocalDateTime} from 'js-joda/src/LocalDateTime.js'
public class | source

LocalDateTime

Extends:

TemporalAccessorTemporalChronoLocalDateTime → LocalDateTime

A date-time without a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30.

LocalDateTime is an immutable date-time object that represents a date-time, often viewed as year-month-day-hour-minute-second. Other date and time fields, such as day-of-year, day-of-week and week-of-year, can also be accessed. Time is represented to nanosecond precision. For example, the value '2nd October 2007 at 13:45.30.123456789' can be stored in a LocalDateTime.

This class does not store or represent a time-zone. Instead, it is a description of the date, as used for birthdays, combined with the local time as seen on a wall clock. It cannot represent an instant on the time-line without additional information such as an offset or time-zone.

The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.

Static properties of Class LocalTime

LocalDateTime.MIN

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.

LocalDateTime.MAX

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.

Static Method Summary

Static Public Methods
public static

Obtains an instance of LocalDateTime from a temporal object.

public static

now(clockOrZone: Clock | ZoneId): LocalDateTime

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

public static

function overloading for LocalDateTime.of

public static

Obtains an instance of LocalDateTime from a date and time.

public static

ofEpochSecond(epochSecond: number, nanoOfSecond: number | !ZoneOffset, offset: ZoneOffset): LocalDateTime

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

public static

Obtains an instance of LocalDateTime from an Instant and zone ID.

public static

ofNumbers(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime

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

public static

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

Method Summary

Public Methods
public

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

public

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

public

Compares this date-time to another date-time.

public

Gets the day-of-month field.

public

Gets the day-of-week field, which is an enum DayOfWeek.

public

Gets the day-of-year field.

public

equals(other: *): boolean

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

public

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

public

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

public

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

public

A hash code for this date-time.

public

Gets the hour-of-day field.

public

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

public

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

public

isEqual(other: *): boolean

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

public

Checks if the specified field is supported.

public

function overloading for LocalDateTime.minus

public

minus2(amountToSubtract: number, unit: TemporalUnit): LocalDateTime

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

Gets the minute-of-hour field.

public

Gets the month-of-year field using the Month enum.

public

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

public

Gets the nano-of-second field.

public

function overloading for LocalDateTime.plus

public

plus2(amountToAdd: number, unit: TemporalUnit): LocalDateTime

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

query(query: TemporalQuery): *

Queries this date-time using the specified query.

public

Gets the range of valid values for the specified field.

public

Gets the second-of-minute field.

public
public

Gets the LocalDate part of this date-time.

public

Gets the LocalTime part of this date-time.

public

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

public

Returns a copy of this LocalDateTime with the time truncated.

public

until(endExclusive: Temporal, unit: TemporalUnit): number

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

public

with(adjusterOrField: TemporalAdjuster | TemporalField, newValue: number): LocalDateTime

function overloading for LocalDateTime.with

public

with2(field: TemporalField, newValue: number): LocalDateTime

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

public

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

public

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

public

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

public

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

public

Returns a copy of this LocalDateTime with the month-of-year altered.

public

withNano(nanoOfSecond: number): LocalDateTime

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

public

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

public

Returns an adjusted copy of this date-time.

public

Returns a copy of this LocalDateTime with the year altered.

public

Gets the year field.

Inherited Summary

From class TemporalAccessor
public

Gets the value of the specified field as an int.

public

query(query: TemporalQuery): *

Queries this date-time.

public

Gets the range of valid values for the specified field.

From class ChronoLocalDateTime
public

adjustInto(temporal: *): *

public

chronology(): *

Gets the chronology of this date-time.

public

query(query: TemporalQuery): *

public

Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.

public

Converts this date-time to an Instant.

Static Public Methods

public static from(temporal: TemporalAccessor): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
temporal TemporalAccessor
  • nullable: false

the temporal object to convert, not null

Return:

LocalDateTime

{LocalDateTime} the local date-time, not null

Throw:

DateTimeException

if unable to convert to a LocalDateTime

public static now(clockOrZone: Clock | ZoneId): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
clockOrZone Clock | ZoneId

the zone ID or clock to use, if null Clock.systemDefaultZone() is used.

Return:

LocalDateTime

the current date-time using the system clock, not null

public static of(): LocalDateTime source

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.

Return:

LocalDateTime

public static ofDateAndTime(date: LocalDate, time: LocalTime): LocalDateTime source

Obtains an instance of LocalDateTime from a date and time.

Params:

NameTypeAttributeDescription
date LocalDate
  • nullable: false

the local date, not null

time LocalTime
  • nullable: false

the local time, not null

Return:

LocalDateTime

the local date-time, not null

public static ofEpochSecond(epochSecond: number, nanoOfSecond: number | !ZoneOffset, offset: ZoneOffset): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
epochSecond number

the number of seconds from the epoch of 1970-01-01T00:00:00Z

nanoOfSecond number | !ZoneOffset

the nanosecond within the second, from 0 to 999,999,999

offset ZoneOffset

the zone offset, not null if called with 3 arguments

Return:

LocalDateTime

the local date-time, not null

Throw:

DateTimeException

if the result exceeds the supported range

public static ofInstant(instant: Instant, zone: ZoneId): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
instant Instant
  • nullable: false

the instant to create the date-time from, not null

zone ZoneId
  • optional
  • default: ZoneId.systemDefault()
  • nullable: false

the time-zone, which may be an offset, defaults to ZoneId.systemDefault()

Return:

LocalDateTime

the local date-time, not null

Throw:

DateTimeException

if the result exceeds the supported range

public static ofNumbers(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
year number
  • optional
  • default: 0

the year to represent, from MIN_YEAR to MAX_YEAR

month number
  • optional
  • default: 0

the month-of-year to represent, from 1 to 12 or from a Month

dayOfMonth number
  • optional
  • default: 0

the day-of-month to represent, from 1 to 31

hour number
  • optional
  • default: 0

the hour-of-day to represent, from 0 to 23

minute number
  • optional
  • default: 0

the minute-of-hour to represent, from 0 to 59

second number
  • optional
  • default: 0

the second-of-minute to represent, from 0 to 59

nanoOfSecond number
  • optional
  • default: 0

the nano-of-second to represent, from 0 to 999,999,999

Return:

LocalDateTime

the local date-time, not null

Throw:

DateTimeException

if the value of any field is out of range

DateTimeException

if the day-of-month is invalid for the month-year

public static parse(text: string, formatter: DateTimeFormatter): LocalDateTime source

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

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

Params:

NameTypeAttributeDescription
text string
  • nullable: false

the text to parse, not null

formatter DateTimeFormatter
  • optional
  • default: DateTimeFormatter.ISO_LOCAL_DATE_TIME

the formatter to use, defaults to DateTimeFormatter.ISO_LOCAL_DATE_TIME

Return:

LocalDateTime

the parsed local date-time, not null

Throw:

DateTimeParseException

if the text cannot be parsed

Public Methods

public adjustInto(temporal: TemporalAdjuster): LocalDateTime source

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:

ChronoLocalDateTime#adjustInto

Params:

NameTypeAttributeDescription
temporal TemporalAdjuster

the target object to be adjusted, not null

Return:

LocalDateTime

the adjusted object, not null

Throw:

DateTimeException

if unable to make the adjustment

ArithmeticException

if numeric overflow occurs

public atZone(zone: ZoneId): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
zone ZoneId

the time-zone to use, not null

Return:

ZonedDateTime

the zoned date-time formed from this date-time, not null

public compareTo(other: LocalDateTime): number source

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.

Params:

NameTypeAttributeDescription
other LocalDateTime
  • nullable: false

the other date-time to compare to, not null

Return:

number

the comparator value, negative if less, positive if greater

public dayOfMonth(): number source

Gets the day-of-month field.

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

Return:

number

the day-of-month, from 1 to 31

public dayOfWeek(): DayOfWeek source

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.

Return:

DayOfWeek

the day-of-week, not null

public dayOfYear(): number source

Gets the day-of-year field.

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

Return:

number

the day-of-year, from 1 to 365, or 366 in a leap year

public equals(other: *): boolean source

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.

Params:

NameTypeAttributeDescription
other *

the object to check, null returns false

Return:

boolean

true if this is equal to the other date-time

public format(formatter: DateTimeFormatter): String source

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

Params:

NameTypeAttributeDescription
formatter DateTimeFormatter
  • nullable: false

the formatter to use, not null

Return:

String

the formatted date-time string, not null

Throw:

DateTimeException

if an error occurs during printing

public get(field: TemporalField): number source

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:

TemporalAccessor#get

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to get, not null

Return:

number

the value for the field

Throw:

DateTimeException

if a value for the field cannot be obtained

ArithmeticException

if numeric overflow occurs

public getLong(field: TemporalField): number source

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.

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to get, not null

Return:

number

the value for the field

Throw:

DateTimeException

if a value for the field cannot be obtained

ArithmeticException

if numeric overflow occurs

public hashCode(): number source

A hash code for this date-time.

Return:

number

a suitable hash code

public hour(): number source

Gets the hour-of-day field.

Return:

number

the hour-of-day, from 0 to 23

public isAfter(other: LocalDateTime): boolean source

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.

Params:

NameTypeAttributeDescription
other LocalDateTime

the other date-time to compare to, not null

Return:

boolean

true if this date-time is after the specified date-time

public isBefore(other: LocalDateTime): boolean source

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.

Params:

NameTypeAttributeDescription
other LocalDateTime

the other date-time to compare to, not null

Return:

boolean

true if this date-time is before the specified date-time

public isEqual(other: *): boolean source

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.

Params:

NameTypeAttributeDescription
other *

the other date-time to compare to, not null

Return:

boolean

true if this date-time is equal to the specified date-time

public isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean source

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.

Params:

NameTypeAttributeDescription
fieldOrUnit TemporalField | TemporalUnit

the field to check, null returns false

Return:

boolean

true if the field is supported on this date-time, false if not

public minus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime source

function overloading for LocalDateTime.minus

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

Params:

NameTypeAttributeDescription
amount TemporalAmount | number
  • nullable: false
unit TemporalUnit

Return:

LocalDateTime

public minus2(amountToSubtract: number, unit: TemporalUnit): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
amountToSubtract number

the amount of the unit to subtract from the result, may be negative

unit TemporalUnit

the unit of the period to subtract, not null

Return:

LocalDateTime

a LocalDateTime based on this date-time with the specified period subtracted, not null

Throw:

DateTimeException

if the unit cannot be added to this type

public minusDays(days: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
days number

the days to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the days subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusHours(hours: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
hours number

the hours to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the hours subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusMinutes(minutes: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
minutes number

the minutes to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the minutes subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusMonths(months: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
months number

the months to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the months subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusNanos(nanos: Number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
nanos Number

the nanos to subtract, may be negative

Return:

LocalDateTime

based on this date-time with the nanoseconds subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusSeconds(seconds: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
seconds number

the seconds to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the seconds subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusTemporalAmount(amount: TemporalAmount): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
amount TemporalAmount

the amount to subtract, not null

Return:

LocalDateTime

based on this date-time with the subtraction made, not null

Throw:

DateTimeException

if the subtraction cannot be made

ArithmeticException

if numeric overflow occurs

public minusWeeks(weeks: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
weeks number

the weeks to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the weeks subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minusYears(years: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
years number

the years to subtract, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the years subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public minute(): number source

Gets the minute-of-hour field.

Return:

number

the minute-of-hour, from 0 to 59

public month(): Month source

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.

Return:

Month

the month-of-year, not null

See:

public monthValue(): number source

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.

Return:

number

the month-of-year, from 1 to 12

See:

public nano(): number source

Gets the nano-of-second field.

Return:

number

the nano-of-second, from 0 to 999,999,999

public plus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime source

function overloading for LocalDateTime.plus

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

Params:

NameTypeAttributeDescription
amount TemporalAmount | number
  • nullable: false
unit TemporalUnit

Return:

LocalDateTime

public plus2(amountToAdd: number, unit: TemporalUnit): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
amountToAdd number

the amount of the unit to add to the result, may be negative

unit TemporalUnit
  • nullable: false

the unit of the period to add, not null

Return:

LocalDateTime

a LocalDateTime based on this date-time with the specified period added, not null

Throw:

DateTimeException

if the unit cannot be added to this type

public plusDays(days: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
days number

the days to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the days added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusHours(hours: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
hours number

the hours to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the hours added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusMinutes(minutes: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
minutes number

the minutes to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the minutes added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusMonths(months: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
months number

the months to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the months added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusNanos(nanos: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
nanos number

the nanos to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the nanoseconds added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusSeconds(seconds: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
seconds number

the seconds to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the seconds added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusTemporalAmount(amount: TemporalAmount): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
amount TemporalAmount

the amount to add, not null

Return:

LocalDateTime

based on this date-time with the addition made, not null

Throw:

DateTimeException

if the addition cannot be made

ArithmeticException

if numeric overflow occurs

public plusWeeks(weeks: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
weeks number

the weeks to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the weeks added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public plusYears(years: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
years number

the years to add, may be negative

Return:

LocalDateTime

a LocalDateTime based on this date-time with the years added, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public query(query: TemporalQuery): * source

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:

ChronoLocalDateTime#query

Params:

NameTypeAttributeDescription
query TemporalQuery

the query to invoke, not null

Return:

*

the query result, null may be returned (defined by the query)

Throw:

DateTimeException

if unable to query (defined by the query)

ArithmeticException

if numeric overflow occurs (defined by the query)

public range(field: TemporalField): ValueRange source

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:

TemporalAccessor#range

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to query the range for, not null

Return:

ValueRange

the range of valid values for the field, not null

Throw:

DateTimeException

if the range for the field cannot be obtained

public second(): number source

Gets the second-of-minute field.

Return:

number

the second-of-minute, from 0 to 59

public toJSON(): string source

Return:

string

same as LocalDateTime.toString

public toLocalDate(): LocalDate source

Gets the LocalDate part of this date-time.

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

Return:

LocalDate

the date part of this date-time, not null

public toLocalTime(): LocalTime source

Gets the LocalTime part of this date-time.

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

Return:

LocalTime

the time part of this date-time, not null

public toString(): string source

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.

Return:

string

a string representation of this date-time, not null

public truncatedTo(unit: TemporalUnit): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
unit TemporalUnit

the unit to truncate to, not null

Return:

LocalDateTime

a LocalDateTime based on this date-time with the time truncated, not null

Throw:

DateTimeException

if unable to truncate

public until(endExclusive: Temporal, unit: TemporalUnit): number source

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.

Params:

NameTypeAttributeDescription
endExclusive Temporal

the end date-time, which is converted to a LocalDateTime, not null

unit TemporalUnit

the unit to measure the period in, not null

Return:

number

the amount of the period between this date-time and the end date-time

Throw:

DateTimeException

if the period cannot be calculated

ArithmeticException

if numeric overflow occurs

public with(adjusterOrField: TemporalAdjuster | TemporalField, newValue: number): LocalDateTime source

function overloading for LocalDateTime.with

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

Params:

NameTypeAttributeDescription
adjusterOrField TemporalAdjuster | TemporalField
  • nullable: false
newValue number

only require if first argument is a TemporalField

Return:

LocalDateTime

public with2(field: TemporalField, newValue: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
field TemporalField

the field to set in the result, not null

newValue number

the new value of the field in the result

Return:

LocalDateTime

a LocalDateTime based on this with the specified field set, not null

Throw:

DateTimeException

if the field cannot be set

ArithmeticException

if numeric overflow occurs

public withDayOfMonth(dayOfMonth: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
dayOfMonth number

the day-of-month to set in the result, from 1 to 28-31

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested day, not null

Throw:

DateTimeException

if the day-of-month value is invalid

DateTimeException

if the day-of-month is invalid for the month-year

public withDayOfYear(dayOfYear: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
dayOfYear number

the day-of-year to set in the result, from 1 to 365-366

Return:

LocalDateTime

a LocalDateTime based on this date with the requested day, not null

Throw:

DateTimeException

if the day-of-year value is invalid

DateTimeException

if the day-of-year is invalid for the year

public withHour(hour: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
hour number

the hour-of-day to set in the result, from 0 to 23

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested hour, not null

Throw:

DateTimeException

if the hour value is invalid

public withMinute(minute: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
minute number

the minute-of-hour to set in the result, from 0 to 59

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested minute, not null

Throw:

DateTimeException

if the minute value is invalid

public withMonth(month: number | Month): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
month number | Month
  • nullable: false

the month-of-year to set in the result, from 1 (January) to 12 (December)

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested month, not null

Throw:

DateTimeException

if the month-of-year value is invalid

public withNano(nanoOfSecond: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
nanoOfSecond number

the nano-of-second to set in the result, from 0 to 999,999,999

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested nanosecond, not null

Throw:

DateTimeException

if the nano value is invalid

public withSecond(second: number): LocalDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
second number

the second-of-minute to set in the result, from 0 to 59

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested second, not null

Throw:

DateTimeException

if the second value is invalid

public withTemporalAdjuster(adjuster: TemporalAdjuster): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
adjuster TemporalAdjuster

the adjuster to use, not null

Return:

LocalDateTime

a LocalDateTime based on this with the adjustment made, not null

Throw:

DateTimeException

if the adjustment cannot be made

ArithmeticException

if numeric overflow occurs

public withYear(year: number): LocalDateTime source

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.

Params:

NameTypeAttributeDescription
year number

the year to set in the result, from MIN_YEAR to MAX_YEAR

Return:

LocalDateTime

a LocalDateTime based on this date-time with the requested year, not null

Throw:

DateTimeException

if the year value is invalid

public year(): number source

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

Return:

number

the year, from MIN_YEAR to MAX_YEAR