import {LocalTime} from '@js-joda/root/packages/core/src/LocalTime.js'

public class | source

LocalTime

Extends:

TemporalAccessor → Temporal → LocalTime

A time without time-zone in the ISO-8601 calendar system, such as 10:15:30.

LocalTime is an immutable date-time object that represents a time, often viewed as hour-minute-second. Time is represented to nanosecond precision. For example, the value '13:45.30.123456789' can be stored in a LocalTime.

It does not store or represent a date or time-zone. Instead, it is a description of 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. This API assumes that all calendar systems use the same representation, this class, for time-of-day.

Static properties of Class LocalTime

LocalTime.MIN

The minimum supported LocalTime, '00:00'. This is the time of midnight at the start of the day.

LocalTime.MAX

The maximum supported LocalTime, '23:59:59.999999999'. This is the time just before midnight at the end of the day.

LocalTime.MIDNIGHT

The time of midnight at the start of the day, '00:00'.

LocalTime.NOON

The time of noon in the middle of the day, '12:00'.

LocalTime.HOURS_PER_DAY

Hours per day.

LocalTime.MINUTES_PER_HOUR

Minutes per hour.

LocalTime.MINUTES_PER_DAY

Minutes per day.

LocalTime.SECONDS_PER_MINUTE

Seconds per minute.

LocalTime.SECONDS_PER_HOUR

Seconds per hour.

LocalTime.SECONDS_PER_DAY

Seconds per day.

LocalTime.MILLIS_PER_DAY

Milliseconds per day.

LocalTime.MICROS_PER_DAY

Microseconds per day.

LocalTime.NANOS_PER_SECOND

Nanos per second.

LocalTime.NANOS_PER_MINUTE

Nanos per minute.

LocalTime.NANOS_PER_HOUR

Nanos per hour.

LocalTime.NANOS_PER_DAY

Nanos per day.

Static Method Summary

Static Public Methods
public static	from(temporal: TemporalAccessor): LocalTime Obtains an instance of LocalTime from a temporal object.
public static	now(clockOrZone: Clock \| ZoneId): LocalTime Obtains the current time from the specified clock.
public static	of(hour: number, minute: number, second: number, nanoOfSecond: number): LocalTime Obtains an instance of LocalTime from an hour, minute, second and nanosecond.
public static	ofInstant(instant: Instant, zone: ZoneId): LocalTime obtain a LocalTime from an Instant in the specified time-zone or, if null in the system default time-zone
public static	ofNanoOfDay(nanoOfDay: number): LocalTime Obtains an instance of LocalTime from a nanos-of-day value.
public static	ofSecondOfDay(secondOfDay: number, nanoOfSecond: number): LocalTime Obtains an instance of LocalTime from a second-of-day value, with associated nanos of second.
public static	parse(text: String, formatter: DateTimeFormatter): LocalTime Obtains an instance of LocalTime from a text string using a specific formatter.

Method Summary

Public Methods
public	adjustInto(temporal: TemporalAdjuster): Temporal Adjusts the specified temporal object to have the same time as this object.
public	atDate(date: LocalDate): LocalDateTime Combines this time with a date to create a LocalDateTime.
public	atOffset(offset: OffsetTime): OffsetTime Combines this time with an offset to create an OffsetTime.
public	compareTo(other: LocalTime): number Compares this LocalTime to another time.
public	equals(other: *): boolean Checks if this time is equal to another time.
public	format(formatter: DateTimeFormatter): string Outputs this time as a string using the formatter.
public	get(field: ChronoField): number Gets the value of the specified field from this time as an `int`.
public	getLong(field: ChronoField): number Gets the value of the specified field from this time as a `long`.
public	hashCode(): number A hash code for this time.
public	hour(): number Gets the hour-of-day field.
public	isAfter(other: LocalTime): boolean Checks if this LocalTime is after the specified time.
public	isBefore(other: LocalTime): boolean Checks if this LocalTime is before the specified time.
public	isSupported(fieldOrUnit: ChronoField \| ChronoUnit): boolean Checks if the specified field is supported.
public	minusHours(hoursToSubtract: number): LocalTime Returns a copy of this LocalTime with the specified period in hours subtracted.
public	minusMinutes(minutesToSubtract: number): LocalTime Returns a copy of this LocalTime with the specified period in minutes subtracted.
public	minusNanos(nanosToSubtract: number): LocalTime Returns a copy of this LocalTime with the specified period in nanoseconds subtracted.
public	minusSeconds(secondsToSubtract: number): LocalTime Returns a copy of this LocalTime with the specified period in seconds subtracted.
public	minute(): number Gets the minute-of-hour field.
public	nano(): number Gets the nano-of-second field.
public	plusHours(hoursToAdd: number): LocalTime Returns a copy of this LocalTime with the specified period in hours added.
public	plusMinutes(minutesToAdd: number): LocalTime Returns a copy of this LocalTime with the specified period in minutes added.
public	plusNanos(nanosToAdd: number): LocalTime Returns a copy of this LocalTime with the specified period in nanoseconds added.
public	plusSeconds(secondsToAdd: number): LocalTime Returns a copy of this LocalTime with the specified period in seconds added.
public	query(query: TemporalQuery): * Queries this time using the specified query.
public	range(field: ChronoField): ValueRange Gets the range of valid values for the specified field.
public	second(): number Gets the second-of-minute field.
public	toJSON(): string
public	toNanoOfDay(): number Extracts the time as nanos of day, from `0` to `24 * 60 * 60 * 1,000,000,000 - 1`.
public	toSecondOfDay(): number Extracts the time as seconds of day, from `0` to `24 * 60 * 60 - 1`.
public	toString(): string Outputs this time as a string, such as `10:15`.
public	truncatedTo(unit: ChronoUnit): LocalTime Returns a copy of this LocalTime with the time truncated.
public	until(endExclusive: TemporalAccessor, unit: TemporalUnit): number Calculates the period between this time and another time in terms of the specified unit.
public	withHour(hour: number): LocalTime Returns a copy of this LocalTime with the hour-of-day value altered.
public	withMinute(minute: number): LocalTime Returns a copy of this LocalTime with the minute-of-hour value altered.
public	withNano(nanoOfSecond: number): LocalTime Returns a copy of this LocalTime with the nano-of-second value altered.
public	withSecond(second: number): LocalTime Returns a copy of this LocalTime with the second-of-minute value altered.

Inherited Summary

From class TemporalAccessor
public	get(field: TemporalField): number Gets the value of the specified field as an `int`.
public	getLong(field: *)
public	isSupported(field: *)
public	query(query: TemporalQuery): * Queries this date-time.
public	range(field: TemporalField): ValueRange Gets the range of valid values for the specified field.

From class Temporal
public	isSupported(fieldOrUnit: TemporalUnit): boolean Checks if the specified unit is supported.
public	minus(amount: TemporalAmount \| number, unit: TemporalUnit): Temporal function overloading for Temporal.plus
public	plus(amount: TemporalAmount \| number, unit: TemporalUnit): Temporal function overloading for Temporal.plus
public	until(endTemporal: Temporal, unit: TemporalUnit): number Calculates the period between this temporal and another temporal in terms of the specified unit.
public	with(adjusterOrField: TemporalAdjuster \| TemporalField, newValue: number): Temporal function overloading for Temporal.with

Static Public Methods

public static from(temporal: TemporalAccessor): LocalTime source

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

The conversion uses the TemporalQueries#localTime query, which relies on extracting ChronoField#NANO_OF_DAY.

This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, LocalTime::from.

Params:

Name	Type	Attribute	Description
temporal	TemporalAccessor	nullable: false	the temporal object to convert, not null

Return:

LocalTime

the local time, not null

Throw:

DateTimeException

if unable to convert to a LocalTime

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

Obtains the current time from the specified clock. If no argument is specified the system default clock is queried, if a zone-id is passed a system clock with the specified zone is queried.

This will query the specified clock to obtain the current time. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

Params:

Name	Type	Attribute	Description
clockOrZone	Clock \| ZoneId		the zone ID or clock to use, if null Clock.systemDefaultZone() is used.

Return:

LocalTime

the current time using the system clock, not null

public static of(hour: number, minute: number, second: number, nanoOfSecond: number): LocalTime source

Obtains an instance of LocalTime from an hour, minute, second and nanosecond.

This factory may return a cached value, but applications must not rely on this.

Params:

Name	Type	Attribute	Description
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:

LocalTime

the local time, not null

Throw:

DateTimeException

if the value of any field is out of range

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

obtain a LocalTime from an Instant in the specified time-zone or, if null in the system default time-zone

Params:

Name	Type	Attribute	Description
instant	Instant	nullable: false
zone	ZoneId	optional default: ZoneId.systemDefault()	, defaults to ZoneId.systemDefault()

Return:

LocalTime

the current date, not null

public static ofNanoOfDay(nanoOfDay: number): LocalTime source

Obtains an instance of LocalTime from a nanos-of-day value.

This factory may return a cached value, but applications must not rely on this.

Params:

Name	Type	Attribute	Description
nanoOfDay	number	optional default: 0	the nano of day, from `0` to `24 * 60 * 60 * 1,000,000,000 - 1`

Return:

LocalTime

the local time, not null

Throw:

DateTimeException

if the nanos of day value is invalid

public static ofSecondOfDay(secondOfDay: number, nanoOfSecond: number): LocalTime source

Obtains an instance of LocalTime from a second-of-day value, with associated nanos of second.

This factory may return a cached value, but applications must not rely on this.

Params:

Name	Type	Attribute	Description
secondOfDay	number	optional default: 0	the second-of-day, from `0` to `24 * 60 * 60 - 1`
nanoOfSecond	number	optional default: 0	the nano-of-second, from `0` to `999,999,999`

Return:

LocalTime

the local time, not null

Throw:

DateTimeException

if the either input value is invalid

public static parse(text: String, formatter: DateTimeFormatter): LocalTime source

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

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

Params:

Name	Type	Attribute	Description
text	String	nullable: false	the text to parse, not null
formatter	DateTimeFormatter	optional default: DateTimeFormatter.ISO_LOCAL_TIME	the formatter to use, default is DateTimeFormatter.ISO_LOCAL_TIME

Return:

LocalTime

the parsed local time, not null

Throw:

DateTimeParseException

if the text cannot be parsed

Public Methods

public adjustInto(temporal: TemporalAdjuster): Temporal source

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

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

The adjustment is equivalent to using Temporal.with passing ChronoField.NANO_OF_DAY as the field.

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 = thisLocalTime.adjustInto(temporal);
  temporal = temporal.with(thisLocalTime);

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
temporal	TemporalAdjuster		the target object to be adjusted, not null

Return:

Temporal

the adjusted object, not null

Throw:

DateTimeException	if unable to make the adjustment
ArithmeticException	if numeric overflow occurs

public atDate(date: LocalDate): LocalDateTime source

Combines this time with a date to create a LocalDateTime.

This returns a LocalDateTime formed from this time at the specified date. All possible combinations of date and time are valid.

Params:

Name	Type	Attribute	Description
date	LocalDate		the date to combine with, not null

Return:

LocalDateTime

the local date-time formed from this time and the specified date, not null

public atOffset(offset: OffsetTime): OffsetTime source

Combines this time with an offset to create an OffsetTime.

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

Params:

Name	Type	Attribute	Description
offset	OffsetTime		the offset to combine with, not null

Return:

OffsetTime

the offset time formed from this time and the specified offset, not null

public compareTo(other: LocalTime): number source

Compares this LocalTime to another time.

The comparison is based on the time-line position of the local times within a day. It is 'consistent with equals', as defined by Comparable.

Params:

Name	Type	Attribute	Description
other	LocalTime		the other time to compare to, not null

Return:

number

the comparator value, negative if less, positive if greater

Throw:

NullPointerException

if other is null

public equals(other: *): boolean source

Checks if this time is equal to another time.

The comparison is based on the time-line position of the time within a day.

Only objects of type LocalTime are compared, other types return false. To compare the date of two TemporalAccessor instances, use ChronoField#NANO_OF_DAY as a comparator.

Params:

Name	Type	Attribute	Description
other	*		the object to check, null returns false

Return:

boolean

true if this is equal to the other time

public format(formatter: DateTimeFormatter): string source

Outputs this time as a string using the formatter.

Params:

Name	Type	Attribute	Description
formatter	DateTimeFormatter		the formatter to use, not null

Return:

string

the formatted time string, not null

Throw:

DateTimeException

if an error occurs during printing

public get(field: ChronoField): number source

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

This queries this 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 time, except ChronoField.NANO_OF_DAY and ChronoField.MICRO_OF_DAY 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:

Name	Type	Attribute	Description
field	ChronoField		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: ChronoField): number source

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

This queries this 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 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.from passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Override:

TemporalAccessor#getLong

Params:

Name	Type	Attribute	Description
field	ChronoField		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 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: LocalTime): boolean source

Checks if this LocalTime is after the specified time.

The comparison is based on the time-line position of the time within a day.

Params:

Name	Type	Attribute	Description
other	LocalTime		the other time to compare to, not null

Return:

boolean

true if this is after the specified time

Throw:

NullPointerException

if other is null

public isBefore(other: LocalTime): boolean source

Checks if this LocalTime is before the specified time.

The comparison is based on the time-line position of the time within a day.

Params:

Name	Type	Attribute	Description
other	LocalTime		the other time to compare to, not null

Return:

boolean

true if this point is before the specified time

Throw:

NullPointerException

if other is null

public isSupported(fieldOrUnit: ChronoField | ChronoUnit): boolean source

Checks if the specified field is supported.

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

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.

Override:

Temporal#isSupported

Params:

Name	Type	Attribute	Description
fieldOrUnit	ChronoField \| ChronoUnit		the field to check, null returns false

Return:

boolean

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

public minusHours(hoursToSubtract: number): LocalTime source

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

This subtracts the specified number of hours from this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
hoursToSubtract	number		the hours to subtract, may be negative

Return:

LocalTime

a LocalTime based on this time with the hours subtracted, not null

public minusMinutes(minutesToSubtract: number): LocalTime source

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

This subtracts the specified number of minutes from this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
minutesToSubtract	number		the minutes to subtract, may be negative

Return:

LocalTime

a LocalTime based on this time with the minutes subtracted, not null

public minusNanos(nanosToSubtract: number): LocalTime source

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

This subtracts the specified number of nanoseconds from this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
nanosToSubtract	number		the nanos to subtract, may be negative

Return:

LocalTime

a LocalTime based on this time with the nanoseconds subtracted, not null

public minusSeconds(secondsToSubtract: number): LocalTime source

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

This subtracts the specified number of seconds from this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
secondsToSubtract	number		the seconds to subtract, may be negative

Return:

LocalTime

a LocalTime based on this time with the seconds subtracted, not null

public minute(): number source

Gets the minute-of-hour field.

Return:

number

the minute-of-hour, from 0 to 59

public nano(): number source

Gets the nano-of-second field.

Return:

number

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

public plusHours(hoursToAdd: number): LocalTime source

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

This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
hoursToAdd	number		the hours to add, may be negative

Return:

LocalTime

a LocalTime based on this time with the hours added, not null

public plusMinutes(minutesToAdd: number): LocalTime source

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

This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
minutesToAdd	number		the minutes to add, may be negative

Return:

LocalTime

a LocalTime based on this time with the minutes added, not null

public plusNanos(nanosToAdd: number): LocalTime source

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

This adds the specified number of nanoseconds to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
nanosToAdd	number		the nanos to add, may be negative

Return:

LocalTime

a LocalTime based on this time with the nanoseconds added, not null

public plusSeconds(secondsToAdd: number): LocalTime source

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

This adds the specified number of seconds to this time, returning a new time. The calculation wraps around midnight.

This instance is immutable and unaffected by this method call.

Params:

Name	Type	Attribute	Description
secondsToAdd	number		the seconds to add, may be negative

Return:

LocalTime

a LocalTime based on this time with the seconds added, not null

public query(query: TemporalQuery): * source

Queries this time using the specified query.

This queries this 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:

TemporalAccessor#query

Params:

Name	Type	Attribute	Description
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: ChronoField): 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 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:

Name	Type	Attribute	Description
field	ChronoField		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 LocalTime.toString

public toNanoOfDay(): number source

Extracts the time as nanos of day, from 0 to 24 * 60 * 60 * 1,000,000,000 - 1.

Return:

number

the nano of day equivalent to this time

public toSecondOfDay(): number source

Extracts the time as seconds of day, from 0 to 24 * 60 * 60 - 1.

Return:

number

the second-of-day equivalent to this time

public toString(): string source

Outputs this time as a string, such as 10:15.

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

HH:mm
HH:mm:ss
HH:mm:ss.SSS
HH:mm:ss.SSSSSS
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 time, not null

public truncatedTo(unit: ChronoUnit): LocalTime source

Returns a copy of this LocalTime with the time truncated.

Truncating the time returns a copy of the original time with fields smaller than the specified unit set to zero. For example, truncating with the ChronoUnit.MINUTES minutes unit 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:

Name	Type	Attribute	Description
unit	ChronoUnit	nullable: false	the unit to truncate to, not null

Return:

LocalTime

a LocalTime based on this time with the time truncated, not null

Throw:

DateTimeException

if unable to truncate

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

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

This calculates the period between two times in terms of a single unit. The start and end points are this and the specified time. The result will be negative if the end is before the start. The Temporal passed to this method must be a LocalTime. For example, the period in hours between two times can be calculated using startTime.until.

The calculation returns a whole number, representing the number of complete units between the two times. For example, the period in hours between 11:30 and 13:29 will only be one hour as it is one minute short of two hours.

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, HOURS);   // this method
  dateTime.plus(HOURS.between(start, end));      // use in plus/minus

The calculation is implemented in this method for ChronoUnit. The units ChronoUnit.NANOS, ChronoUnit.MICROS, ChronoUnit.MILLIS, ChronoUnit.SECONDS, ChronoUnit.MINUTES, ChronoUnit.HOURS and ChronoUnit.HALF_DAYS 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.

Override:

Temporal#until

Params:

Name	Type	Attribute	Description
endExclusive	TemporalAccessor		the end time, which is converted to a LocalTime, not null
unit	TemporalUnit		the unit to measure the period in, not null