LocalTime
Extends:
A time without time-zone in the ISO-8601 calendar system, such as {@code 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 |
Obtains the current time from the specified clock. |
|
public static |
Obtains an instance of LocalTime from an hour, minute, second and nanosecond. |
|
public static |
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 |
Obtains an instance of LocalTime from a text string using a specific formatter. |
Constructor Summary
Public Constructor | ||
public |
constructor(hour: number, minute: number, second: number, nanoOfSecond: number) Constructor, previously validated. |
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 |
Compares this LocalTime to another time. |
|
public |
equals(other: *): * Checks if this time is equal to another time. |
|
public |
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 {@code int}. |
|
public |
getLong(field: ChronoField): number Gets the value of the specified field from this time as a {@code long}. |
|
public |
A hash code for this time. |
|
public |
Gets the hour-of-day field. |
|
public |
Checks if this LocalTime is after the specified time. |
|
public |
Checks if this LocalTime is before the specified time. |
|
public |
isSupported(fieldOrUnit: ChronoField | ChronoUnit): boolean Checks if the specified field is supported. |
|
public |
minus(amount: TemporalAmount | number, unit: ChronoUnit): LocalTime function overloading for LocalDate.minus |
|
public |
minus1(amount: TemporalAmount): LocalTime Returns a copy of this time with the specified period subtracted. |
|
public |
minus2(amountToSubtract: number, unit: ChronoUnit): LocalTime Returns a copy of this time with the specified period subtracted. |
|
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 |
Gets the minute-of-hour field. |
|
public |
Gets the nano-of-second field. |
|
public |
plus(amount: TemporalAmount | number, unit: ChronoUnit): LocalTime function overloading for LocalDate.plus |
|
public |
plus1(amount: TemporalAmount): LocalTime Returns a copy of this date with the specified period added. |
|
public |
plus2(amountToAdd: number, unit: ChronoUnit): LocalTime Returns a copy of this time with the specified period added. |
|
public |
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 |
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 |
Gets the second-of-minute field. |
|
public |
Extracts the time as nanos of day, from {@code 0} to {@code 24 60 60 * 1,000,000,000 - 1}. |
|
public |
Extracts the time as seconds of day, from {@code 0} to {@code 24 60 60 - 1}. |
|
public |
Outputs this time as a String, such as {@code 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 |
with(adjusterOrField: TemporalAdjuster | ChronoField, newValue: number): LocalTime function overloading for LocalDate.with |
|
public |
with2(field: ChronoField, newValue: number): LocalTime Returns a copy of this time with the specified field set to a new value. |
|
public |
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 |
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. |
|
public |
withTemporalAdjuster(adjuster: TemporalAdjuster): LocalTime Returns an adjusted copy of this time. |
Inherited Summary
From class TemporalAccessor | ||
public |
get(field: TemporalField): number Gets the value of the specified field as an {@code int}. |
|
public |
query(query: TemporalQuery): * Queries this date-time. |
|
public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
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 {@link TemporalQueries#localTime()} query, which relies on extracting the {@link ChronoField#NANO_OF_DAY NANO_OF_DAY} field.
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 |
|
the temporal object to convert, not null |
Throw:
if unable to convert to a LocalTime |
public static now(clock: Clock): LocalTime source
Obtains the current time from the specified clock.
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 {@link Clock dependency injection}.
Params:
Name | Type | Attribute | Description |
clock | Clock |
|
the clock to use, 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 |
|
the hour-of-day to represent, from 0 to 23 |
minute | number |
|
the minute-of-hour to represent, from 0 to 59 |
second | number |
|
the second-of-minute to represent, from 0 to 59 |
nanoOfSecond | number |
|
the nano-of-second to represent, from 0 to 999,999,999 |
Throw:
if the value of any field is out of range |
public static ofInstant(instant: Instant, zone: ZoneId): LocalDate source
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 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 |
|
the nano of day, from {@code 0} to {@code 24 60 60 * 1,000,000,000 - 1} |
Throw:
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.
Throw:
if the either input value is invalid |
Public Constructors
public constructor(hour: number, minute: number, second: number, nanoOfSecond: number) source
Constructor, previously validated.
Params:
Name | Type | Attribute | Description |
hour | number |
|
the hour-of-day to represent, validated from 0 to 23 |
minute | number |
|
the minute-of-hour to represent, validated from 0 to 59 |
second | number |
|
the second-of-minute to represent, validated from 0 to 59 |
nanoOfSecond | number |
|
the nano-of-second to represent, validated from 0 to 999,999,999 |
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 |
Throw:
if unable to make the adjustment |
|
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 |
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 |
Throw:
if {@code other} is null |
public equals(other: *): * 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: DateTineFormatter): string source
Outputs this time as a String using the formatter.
This time will be passed to the formatter {@link DateTimeFormatter#format(TemporalAccessor) print method}.
Params:
Name | Type | Attribute | Description |
formatter | DateTineFormatter | the formatter to use, not null |
Throw:
if an error occurs during printing |
public get(field: ChronoField): number source
Gets the value of the specified field from this time as an {@code 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 {@link #isSupported(TemporalField) supported fields} 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 {@code 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#getParams:
Name | Type | Attribute | Description |
field | ChronoField | the field to get, not null |
Throw:
if a value for the field cannot be obtained |
|
if numeric overflow occurs |
public getLong(field: ChronoField): number source
Gets the value of the specified field from this time as a {@code 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 {@link #isSupported(TemporalField) supported fields} 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.
Params:
Name | Type | Attribute | Description |
field | ChronoField | the field to get, not null |
Throw:
if a value for the field cannot be obtained |
|
if numeric overflow occurs |
public isAfter(other: LocalTime): * 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:
if {@code other} is null |
public isBefore(other: LocalTime): * 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:
if {@code 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 the {@link #range(TemporalField) range} and {@link #get(TemporalField) get} methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The supported fields are:
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:
Name | Type | Attribute | Description |
fieldOrUnit | ChronoField | ChronoUnit | the field to check, null returns false |
public minus(amount: TemporalAmount | number, unit: ChronoUnit): LocalTime source
function overloading for LocalDate.minus
if called with 1 (or less) arguments LocalTime.minus1 is called. Otherwise LocalTime.minus2 is called.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | number |
|
|
unit | ChronoUnit | only required if called with 2 arguments |
public minus1(amount: TemporalAmount): LocalTime source
Returns a copy of this time with the specified period subtracted.
This method returns a new 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 {@link #minus(long, TemporalUnit)}.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | the amount to subtract, not null |
Throw:
if the subtraction cannot be made |
|
if numeric overflow occurs |
public minus2(amountToSubtract: number, unit: ChronoUnit): LocalTime source
Returns a copy of this time with the specified period subtracted.
This method returns a new time based on this time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract hours, minutes or seconds. 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:
Name | Type | Attribute | Description |
amountToSubtract | number | the amount of the unit to subtract from the result, may be negative |
|
unit | ChronoUnit | the unit of the period to subtract, not null |
Throw:
if the unit cannot be added to this type |
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 |
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 |
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 |
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 |
public plus(amount: TemporalAmount | number, unit: ChronoUnit): LocalTime source
function overloading for LocalDate.plus
if called with 1 (or less) arguments LocalTime.plus1 is called. Otherwise LocalTime.plus2 is called.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | number |
|
|
unit | ChronoUnit | only required if called with 2 arguments |
public plus1(amount: TemporalAmount): LocalTime source
Returns a copy of this date with the specified period added.
This method returns a new 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 {@link #plus(long, TemporalUnit)}.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | the amount to add, not null |
Throw:
if the addition cannot be made |
|
if numeric overflow occurs |
public plus2(amountToAdd: number, unit: ChronoUnit): LocalTime source
Returns a copy of this time with the specified period added.
This method returns a new time based on this time with the specified period added. This can be used to add any period that is defined by a unit, for example to add hours, minutes or seconds. 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:
Name | Type | Attribute | Description |
amountToAdd | number | the amount of the unit to add to the result, may be negative |
|
unit | ChronoUnit | the unit of the period to add, not null |
Throw:
if the unit cannot be added to this type |
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 |
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 |
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 |
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 |
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 {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the specified query passing this as the argument.
Override:
TemporalAccessor#queryParams:
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:
if unable to query (defined by the query) |
|
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 {@link #isSupported(TemporalField) supported fields} 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 {@code TemporalField.rangeRefinedBy(TemporalAccessor)} passing this as the argument. Whether the range can be obtained is determined by the field.
Override:
TemporalAccessor#rangeParams:
Name | Type | Attribute | Description |
field | ChronoField | the field to query the range for, not null |
Throw:
if the range for the field cannot be obtained |
public toNanoOfDay(): number source
Extracts the time as nanos of day, from {@code 0} to {@code 24 60 60 * 1,000,000,000 - 1}.
public toSecondOfDay(): number source
Extracts the time as seconds of day, from {@code 0} to {@code 24 60 60 - 1}.
public toString(): string source
Outputs this time as a String, such as {@code 10:15}.
The output will be one of the following ISO-8601 formats:
- {@code HH:mm}
- {@code HH:mm:ss}
- {@code HH:mm:ss.SSS}
- {@code HH:mm:ss.SSSSSS}
- {@code 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.
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 {@linkplain TemporalUnit#getDuration() duration} 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 |
|
the unit to truncate to, not null |
Throw:
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 {@code startTime.until(endTime, HOURS)}.
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 {@code long} representing the amount of the specified unit. By contrast, the result of {@code 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.
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 |
Throw:
if the period cannot be calculated |
|
if numeric overflow occurs |
public with(adjusterOrField: TemporalAdjuster | ChronoField, newValue: number): LocalTime source
function overloading for LocalDate.with
if called with 1 (or less) arguments LocalTime.withTemporalAdjuster is called. Otherwise LocalTime.with2 is called.
Params:
Name | Type | Attribute | Description |
adjusterOrField | TemporalAdjuster | ChronoField |
|
|
newValue | number | only required if called with 2 arguments |
public with2(field: ChronoField, newValue: number): LocalTime source
Returns a copy of this time with the specified field set to a new value.
This returns a new LocalTime, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the hour, minute or second. If it is not possible to set 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 adjustment is implemented here. The supported fields behave as follows:
In all cases, if the new value is outside the valid range of values for the field then a DateTimeException will be thrown.
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:
Name | Type | Attribute | Description |
field | ChronoField |
|
the field to set in the result, not null |
newValue | number | the new value of the field in the result |
Throw:
if the field cannot be set |
|
if numeric overflow occurs |
public withHour(hour: number): LocalTime source
Returns a copy of this LocalTime with the hour-of-day value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
hour | number |
|
the hour-of-day to set in the result, from 0 to 23 |
Throw:
if the hour value is invalid |
public withMinute(minute: number): LocalTime source
Returns a copy of this LocalTime with the minute-of-hour value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
minute | number |
|
the minute-of-hour to set in the result, from 0 to 59 |
Throw:
if the minute value is invalid |
public withNano(nanoOfSecond: number): LocalTime source
Returns a copy of this LocalTime with the nano-of-second value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
nanoOfSecond | number |
|
the nano-of-second to set in the result, from 0 to 999,999,999 |
Throw:
if the nanos value is invalid |
public withSecond(second: number): LocalTime source
Returns a copy of this LocalTime with the second-of-minute value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
second | number |
|
the second-of-minute to set in the result, from 0 to 59 |
Throw:
if the second value is invalid |
public withTemporalAdjuster(adjuster: TemporalAdjuster): LocalTime source
Returns an adjusted copy of this time.
This returns a new LocalTime, based on this one, with the 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 hour field. A more complex adjuster might set the time to the last hour of the day.
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:
Name | Type | Attribute | Description |
adjuster | TemporalAdjuster | the adjuster to use, not null |
Throw:
if the adjustment cannot be made |
|
if numeric overflow occurs |