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

LocalTime

Extends:

TemporalAccessorTemporal → 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

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

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

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

public

Combines this time with a date to create a LocalDateTime.

public

Compares this LocalTime to another time.

public

equals(other: *): boolean

Checks if this time is equal to another time.

public

format(formatter: DateTineFormatter): string

Outputs this time as a string using the formatter.

public

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

public

Gets the value of the specified field from this time as a 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

Checks if the specified field is supported.

public

function overloading for LocalDate.minus

public

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

function overloading for LocalDate.plus

public

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

public

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

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

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

Gets the range of valid values for the specified field.

public

Gets the second-of-minute field.

public
public

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

public

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

public

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

public

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

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

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

public

Returns an adjusted copy of this time.

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.

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:

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

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

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

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

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

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

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

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

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

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

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

Params:

NameTypeAttributeDescription
formatter DateTineFormatter

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:

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

Params:

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

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

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

Params:

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

NameTypeAttributeDescription
amount TemporalAmount | number
  • nullable: false
unit ChronoUnit

only required if called with 2 arguments

Return:

LocalTime

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amount TemporalAmount

the amount to subtract, not null

Return:

LocalTime

a LocalTime based on this time with the subtraction made, not null

Throw:

DateTimeException

if the subtraction cannot be made

ArithmeticException

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:

NameTypeAttributeDescription
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

Return:

LocalTime

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

Throw:

DateTimeException

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:

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

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

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

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

NameTypeAttributeDescription
amount TemporalAmount | number
  • nullable: false
unit ChronoUnit

only required if called with 2 arguments

Return:

LocalTime

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amount TemporalAmount

the amount to add, not null

Return:

LocalTime

a LocalTime based on this time with the addition made, not null

Throw:

DateTimeException

if the addition cannot be made

ArithmeticException

if numeric overflow occurs

public plus2(amountToAdd: number, unit: TemporalUnit): 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:

NameTypeAttributeDescription
amountToAdd number

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

unit TemporalUnit

the unit of the period to add, not null

Return:

LocalTime

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

Throw:

DateTimeException

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:

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

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

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

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

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

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

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

Params:

NameTypeAttributeDescription
endExclusive TemporalAccessor

the end time, which is converted to a LocalTime, not null

unit TemporalUnit

the unit to measure the period in, not null

Return:

number

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

Throw:

DateTimeException

if the period cannot be calculated

ArithmeticException

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:

NameTypeAttributeDescription
adjusterOrField TemporalAdjuster | ChronoField
  • nullable: false
newValue number

only required if called with 2 arguments

Return:

LocalTime

public with2(field: TemporalField, 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:

  • ChronoField.NANO_OF_SECOND - Returns a LocalTime with the specified nano-of-second. The hour, minute and second will be unchanged.
  • ChronoField.NANO_OF_DAY - Returns a LocalTime with the specified nano-of-day. This completely replaces the time and is equivalent to ofNanoOfDay.
  • ChronoField.MICRO_OF_SECOND - Returns a LocalTime with the nano-of-second replaced by the specified micro-of-second multiplied by 1,000. The hour, minute and second will be unchanged.
  • ChronoField.MICRO_OF_DAY - Returns a LocalTime with the specified micro-of-day. This completely replaces the time and is equivalent to using ofNanoOfDay with the micro-of-day multiplied by 1,000.
  • ChronoField.MILLI_OF_SECOND - Returns a LocalTime with the nano-of-second replaced by the specified milli-of-second multiplied by 1,000,000. The hour, minute and second will be unchanged.
  • ChronoField.MILLI_OF_DAY - Returns a LocalTime with the specified milli-of-day. This completely replaces the time and is equivalent to using ofNanoOfDay with the milli-of-day multiplied by 1,000,000.
  • ChronoField.SECOND_OF_MINUTE - Returns a LocalTime with the specified second-of-minute. The hour, minute and nano-of-second will be unchanged.
  • ChronoField.SECOND_OF_DAY - Returns a LocalTime with the specified second-of-day. The nano-of-second will be unchanged.
  • ChronoField.MINUTE_OF_HOUR - Returns a LocalTime with the specified minute-of-hour. The hour, second-of-minute and nano-of-second will be unchanged.
  • ChronoField.MINUTE_OF_DAY - Returns a LocalTime with the specified minute-of-day. The second-of-minute and nano-of-second will be unchanged.
  • ChronoField.HOUR_OF_AMPM - Returns a LocalTime with the specified hour-of-am-pm. The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.
  • ChronoField.CLOCK_HOUR_OF_AMPM - Returns a LocalTime with the specified clock-hour-of-am-pm. The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.
  • ChronoField.HOUR_OF_DAY - Returns a LocalTime with the specified hour-of-day. The minute-of-hour, second-of-minute and nano-of-second will be unchanged.
  • ChronoField.CLOCK_HOUR_OF_DAY - Returns a LocalTime with the specified clock-hour-of-day. The minute-of-hour, second-of-minute and nano-of-second will be unchanged.
  • ChronoField.AMPM_OF_DAY - Returns a LocalTime with the specified AM/PM. The hour-of-am-pm, minute-of-hour, second-of-minute and nano-of-second will be unchanged.

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:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to set in the result, not null

newValue number

the new value of the field in the result

Return:

LocalTime

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

Throw:

DateTimeException

if the field cannot be set

ArithmeticException

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:

NameTypeAttributeDescription
hour number
  • optional
  • default: 0

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

Return:

LocalTime

a LocalTime based on this time with the requested hour, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
minute number
  • optional
  • default: 0

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

Return:

LocalTime

a LocalTime based on this time with the requested minute, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
nanoOfSecond number
  • optional
  • default: 0

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

Return:

LocalTime

a LocalTime based on this time with the requested nanosecond, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
second number
  • optional
  • default: 0

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

Return:

LocalTime

a LocalTime based on this time with the requested second, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
adjuster TemporalAdjuster

the adjuster to use, not null

Return:

LocalTime

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

Throw:

DateTimeException

if the adjustment cannot be made

ArithmeticException

if numeric overflow occurs