* {@code 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 {@code LocalTime}. *
* This class 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. *
* This is a value-based
* class; use of identity-sensitive operations (including reference equality
* ({@code ==}), identity hash code, or synchronization) on instances of
* {@code LocalTime} may have unpredictable results and should be avoided.
* The {@code equals} method should be used for comparisons.
* @implSpec This class is immutable and thread-safe.
* @since 1.8
*/
// @ts-ignore
class LocalTime extends java.lang.Object implements java.time.temporal.Temporal, java.time.temporal.TemporalAdjuster, java.lang.Comparable
* This will query the {@link Clock#systemDefaultZone() system clock} in the default
* time-zone to obtain the current time.
*
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
* @return the current time using the system clock and default time-zone, not null
*/
// @ts-ignore
public static now(): java.time.LocalTime
/**
* Obtains the current time from the system clock in the specified time-zone.
*
* This will query the {@link Clock#system(ZoneId) system clock} to obtain the current time.
* Specifying the time-zone avoids dependence on the default time-zone.
*
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
* @param zone the zone ID to use, not null
* @return the current time using the system clock, not null
*/
// @ts-ignore
public static now(zone: java.time.ZoneId): java.time.LocalTime
/**
* 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}.
* @param clock the clock to use, not null
* @return the current time, not null
*/
// @ts-ignore
public static now(clock: java.time.Clock): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from an hour and minute.
*
* This returns a {@code LocalTime} with the specified hour and minute.
* The second and nanosecond fields will be set to zero.
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
* @return the local time, not null
* @throws DateTimeException if the value of any field is out of range
*/
// @ts-ignore
public static of(hour: number /*int*/, minute: number /*int*/): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from an hour, minute and second.
*
* This returns a {@code LocalTime} with the specified hour, minute and second.
* The nanosecond field will be set to zero.
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
* @param second the second-of-minute to represent, from 0 to 59
* @return the local time, not null
* @throws DateTimeException if the value of any field is out of range
*/
// @ts-ignore
public static of(hour: number /*int*/, minute: number /*int*/, second: number /*int*/): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from an hour, minute, second and nanosecond.
*
* This returns a {@code LocalTime} with the specified hour, minute, second and nanosecond.
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
* @param second the second-of-minute to represent, from 0 to 59
* @param nanoOfSecond the nano-of-second to represent, from 0 to 999,999,999
* @return the local time, not null
* @throws DateTimeException if the value of any field is out of range
*/
// @ts-ignore
public static of(hour: number /*int*/, minute: number /*int*/, second: number /*int*/, nanoOfSecond: number /*int*/): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from a second-of-day value.
*
* This returns a {@code LocalTime} with the specified second-of-day.
* The nanosecond field will be set to zero.
* @param secondOfDay the second-of-day, from {#code 0} to {@code 24 * 60 * 60 - 1}
* @return the local time, not null
* @throws DateTimeException if the second-of-day value is invalid
*/
// @ts-ignore
public static ofSecondOfDay(secondOfDay: number /*long*/): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from a nanos-of-day value.
*
* This returns a {@code LocalTime} with the specified nanosecond-of-day.
* @param nanoOfDay the nano of day, from {#code 0} to {@code 24 * 60 * 60 * 1,000,000,000 - 1}
* @return the local time, not null
* @throws DateTimeException if the nanos of day value is invalid
*/
// @ts-ignore
public static ofNanoOfDay(nanoOfDay: number /*long*/): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from a temporal object.
*
* This obtains a local time based on the specified temporal.
* A {@code TemporalAccessor} represents an arbitrary set of date and time information,
* which this factory converts to an instance of {@code 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 {@link TemporalQuery}
* allowing it to be used as a query via method reference, {@code LocalTime::from}.
* @param temporal the temporal object to convert, not null
* @return the local time, not null
* @throws DateTimeException if unable to convert to a {#code LocalTime}
*/
// @ts-ignore
public static from(temporal: java.time.temporal.TemporalAccessor): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from a text string such as {@code 10:15}.
*
* The string must represent a valid time and is parsed using
* {@link java.time.format.DateTimeFormatter#ISO_LOCAL_TIME}.
* @param text the text to parse such as "10:15:30", not null
* @return the parsed local time, not null
* @throws DateTimeParseException if the text cannot be parsed
*/
// @ts-ignore
public static parse(text: java.lang.CharSequence): java.time.LocalTime
/**
* Obtains an instance of {@code LocalTime} from a text string using a specific formatter.
*
* The text is parsed using the formatter, returning a time.
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
* @return the parsed local time, not null
* @throws DateTimeParseException if the text cannot be parsed
*/
// @ts-ignore
public static parse(text: java.lang.CharSequence, formatter: java.time.format.DateTimeFormatter): java.time.LocalTime
/**
* 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},
* {@link #get(TemporalField) get} and {@link #with(TemporalField, long)}
* methods will throw an exception.
*
* If the field is a {@link ChronoField} then the query is implemented here.
* The supported fields are:
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)}
* passing {@code this} as the argument.
* Whether the field is supported is determined by the field.
* @param field the field to check, null returns false
* @return true if the field is supported on this time, false if not
*/
// @ts-ignore
public isSupported(field: java.time.temporal.TemporalField): boolean
/**
* Checks if the specified unit is supported.
*
* This checks if the specified unit can be added to, or subtracted from, this time.
* If false, then calling the {@link #plus(long, TemporalUnit)} and
* {@link #minus(long, TemporalUnit) minus} methods will throw an exception.
*
* If the unit is a {@link ChronoUnit} then the query is implemented here.
* The supported units are:
*
* If the unit is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)}
* passing {@code this} as the argument.
* Whether the unit is supported is determined by the unit.
* @param unit the unit to check, null returns false
* @return true if the unit can be added/subtracted, false if not
*/
// @ts-ignore
public isSupported(unit: java.time.temporal.TemporalUnit): boolean
/**
* 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 {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return
* appropriate range instances.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)}
* passing {@code this} as the argument.
* Whether the range can be obtained is determined by the field.
* @param field the field to query the range for, not null
* @return the range of valid values for the field, not null
* @throws DateTimeException if the range for the field cannot be obtained
* @throws UnsupportedTemporalTypeException if the field is not supported
*/
// @ts-ignore
public range(field: java.time.temporal.TemporalField): java.time.temporal.ValueRange
/**
* Gets the value of the specified field from this time as an {@code int}.
*
* This queries this time for the value of 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 {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return valid
* values based on this time, except {@code NANO_OF_DAY} and {@code MICRO_OF_DAY}
* which are too large to fit in an {@code int} and throw a {@code DateTimeException}.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
* passing {@code this} as the argument. Whether the value can be obtained,
* and what the value represents, is determined by the field.
* @param field the field to get, not null
* @return the value for the field
* @throws DateTimeException if a value for the field cannot be obtained or
* the value is outside the range of valid values for the field
* @throws UnsupportedTemporalTypeException if the field is not supported or
* the range of values exceeds an {#code int}
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public get(field: java.time.temporal.TemporalField): number /*int*/
/**
* Gets the value of the specified field from this time as a {@code long}.
*
* This queries this time for the value of 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 {@link ChronoField} then the query is implemented here.
* The {@link #isSupported(TemporalField) supported fields} will return valid
* values based on this time.
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)}
* passing {@code this} as the argument. Whether the value can be obtained,
* and what the value represents, is determined by the field.
* @param field the field to get, not null
* @return the value for the field
* @throws DateTimeException if a value for the field cannot be obtained
* @throws UnsupportedTemporalTypeException if the field is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public getLong(field: java.time.temporal.TemporalField): number /*long*/
/**
* Gets the hour-of-day field.
* @return the hour-of-day, from 0 to 23
*/
// @ts-ignore
public getHour(): number /*int*/
/**
* Gets the minute-of-hour field.
* @return the minute-of-hour, from 0 to 59
*/
// @ts-ignore
public getMinute(): number /*int*/
/**
* Gets the second-of-minute field.
* @return the second-of-minute, from 0 to 59
*/
// @ts-ignore
public getSecond(): number /*int*/
/**
* Gets the nano-of-second field.
* @return the nano-of-second, from 0 to 999,999,999
*/
// @ts-ignore
public getNano(): number /*int*/
/**
* Returns an adjusted copy of this time.
*
* This returns a {@code 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
* {@link TemporalAdjuster#adjustInto(Temporal)} method on the
* specified adjuster passing {@code this} as the argument.
*
* This instance is immutable and unaffected by this method call.
* @param adjuster the adjuster to use, not null
* @return a {#code LocalTime} based on {@code this} with the adjustment made, not null
* @throws DateTimeException if the adjustment cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public with(adjuster: java.time.temporal.TemporalAdjuster): java.time.LocalTime
/**
* Returns a copy of this time with the specified field set to a new value.
*
* This returns a {@code 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 {@link 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 {@code DateTimeException} will be thrown.
*
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.adjustInto(Temporal, long)}
* passing {@code 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.
* @param field the field to set in the result, not null
* @param newValue the new value of the field in the result
* @return a {#code LocalTime} based on {@code this} with the specified field set, not null
* @throws DateTimeException if the field cannot be set
* @throws UnsupportedTemporalTypeException if the field is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public with(field: java.time.temporal.TemporalField, newValue: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the hour-of-day altered.
*
* This instance is immutable and unaffected by this method call.
* @param hour the hour-of-day to set in the result, from 0 to 23
* @return a {#code LocalTime} based on this time with the requested hour, not null
* @throws DateTimeException if the hour value is invalid
*/
// @ts-ignore
public withHour(hour: number /*int*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the minute-of-hour altered.
*
* This instance is immutable and unaffected by this method call.
* @param minute the minute-of-hour to set in the result, from 0 to 59
* @return a {#code LocalTime} based on this time with the requested minute, not null
* @throws DateTimeException if the minute value is invalid
*/
// @ts-ignore
public withMinute(minute: number /*int*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the second-of-minute altered.
*
* This instance is immutable and unaffected by this method call.
* @param second the second-of-minute to set in the result, from 0 to 59
* @return a {#code LocalTime} based on this time with the requested second, not null
* @throws DateTimeException if the second value is invalid
*/
// @ts-ignore
public withSecond(second: number /*int*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the nano-of-second altered.
*
* This instance is immutable and unaffected by this method call.
* @param nanoOfSecond the nano-of-second to set in the result, from 0 to 999,999,999
* @return a {#code LocalTime} based on this time with the requested nanosecond, not null
* @throws DateTimeException if the nanos value is invalid
*/
// @ts-ignore
public withNano(nanoOfSecond: number /*int*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the time truncated.
*
* Truncation returns a copy of the original time with fields
* smaller than the specified unit set to zero.
* For example, truncating with the {@link 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 {@link ChronoUnit} and
* {@link ChronoUnit#DAYS DAYS}. Other units throw an exception.
*
* This instance is immutable and unaffected by this method call.
* @param unit the unit to truncate to, not null
* @return a {#code LocalTime} based on this time with the time truncated, not null
* @throws DateTimeException if unable to truncate
* @throws UnsupportedTemporalTypeException if the unit is not supported
*/
// @ts-ignore
public truncatedTo(unit: java.time.temporal.TemporalUnit): java.time.LocalTime
/**
* Returns a copy of this time with the specified amount added.
*
* This returns a {@code LocalTime}, based on this one, with the specified amount added.
* The amount is typically {@link Duration} but may be any other type implementing
* the {@link TemporalAmount} interface.
*
* The calculation is delegated to the amount object by calling
* {@link TemporalAmount#addTo(Temporal)}. The amount implementation is free
* to implement the addition in any way it wishes, however it typically
* calls back to {@link #plus(long, TemporalUnit)}. Consult the documentation
* of the amount implementation to determine if it can be successfully added.
*
* This instance is immutable and unaffected by this method call.
* @param amountToAdd the amount to add, not null
* @return a {#code LocalTime} based on this time with the addition made, not null
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public plus(amountToAdd: java.time.temporal.TemporalAmount): java.time.LocalTime
/**
* Returns a copy of this time with the specified amount added.
*
* This returns a {@code LocalTime}, based on this one, with the amount
* in terms of the unit added. If it is not possible to add the amount, because the
* unit is not supported or for some other reason, an exception is thrown.
*
* If the field is a {@link ChronoUnit} then the addition is implemented here.
* The supported fields behave as follows:
*
* All other {@code ChronoUnit} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* If the field is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.addTo(Temporal, long)}
* passing {@code this} as the argument. In this case, the unit determines
* whether and how to perform the addition.
*
* This instance is immutable and unaffected by this method call.
* @param amountToAdd the amount of the unit to add to the result, may be negative
* @param unit the unit of the amount to add, not null
* @return a {#code LocalTime} based on this time with the specified amount added, not null
* @throws DateTimeException if the addition cannot be made
* @throws UnsupportedTemporalTypeException if the unit is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public plus(amountToAdd: number /*long*/, unit: java.time.temporal.TemporalUnit): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param hoursToAdd the hours to add, may be negative
* @return a {#code LocalTime} based on this time with the hours added, not null
*/
// @ts-ignore
public plusHours(hoursToAdd: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param minutesToAdd the minutes to add, may be negative
* @return a {#code LocalTime} based on this time with the minutes added, not null
*/
// @ts-ignore
public plusMinutes(minutesToAdd: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param secondstoAdd the seconds to add, may be negative
* @return a {#code LocalTime} based on this time with the seconds added, not null
*/
// @ts-ignore
public plusSeconds(secondstoAdd: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param nanosToAdd the nanos to add, may be negative
* @return a {#code LocalTime} based on this time with the nanoseconds added, not null
*/
// @ts-ignore
public plusNanos(nanosToAdd: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this time with the specified amount subtracted.
*
* This returns a {@code LocalTime}, based on this one, with the specified amount subtracted.
* The amount is typically {@link Duration} but may be any other type implementing
* the {@link TemporalAmount} interface.
*
* The calculation is delegated to the amount object by calling
* {@link TemporalAmount#subtractFrom(Temporal)}. The amount implementation is free
* to implement the subtraction in any way it wishes, however it typically
* calls back to {@link #minus(long, TemporalUnit)}. Consult the documentation
* of the amount implementation to determine if it can be successfully subtracted.
*
* This instance is immutable and unaffected by this method call.
* @param amountToSubtract the amount to subtract, not null
* @return a {#code LocalTime} based on this time with the subtraction made, not null
* @throws DateTimeException if the subtraction cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public minus(amountToSubtract: java.time.temporal.TemporalAmount): java.time.LocalTime
/**
* Returns a copy of this time with the specified amount subtracted.
*
* This returns a {@code LocalTime}, based on this one, with the amount
* in terms of the unit subtracted. If it is not possible to subtract the amount,
* because the unit is not supported or for some other reason, an exception is thrown.
*
* This method is equivalent to {@link #plus(long, TemporalUnit)} with the amount negated.
* See that method for a full description of how addition, and thus subtraction, works.
*
* This instance is immutable and unaffected by this method call.
* @param amountToSubtract the amount of the unit to subtract from the result, may be negative
* @param unit the unit of the amount to subtract, not null
* @return a {#code LocalTime} based on this time with the specified amount subtracted, not null
* @throws DateTimeException if the subtraction cannot be made
* @throws UnsupportedTemporalTypeException if the unit is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public minus(amountToSubtract: number /*long*/, unit: java.time.temporal.TemporalUnit): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param hoursToSubtract the hours to subtract, may be negative
* @return a {#code LocalTime} based on this time with the hours subtracted, not null
*/
// @ts-ignore
public minusHours(hoursToSubtract: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param minutesToSubtract the minutes to subtract, may be negative
* @return a {#code LocalTime} based on this time with the minutes subtracted, not null
*/
// @ts-ignore
public minusMinutes(minutesToSubtract: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param secondsToSubtract the seconds to subtract, may be negative
* @return a {#code LocalTime} based on this time with the seconds subtracted, not null
*/
// @ts-ignore
public minusSeconds(secondsToSubtract: number /*long*/): java.time.LocalTime
/**
* Returns a copy of this {@code LocalTime} with the specified number of 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.
* @param nanosToSubtract the nanos to subtract, may be negative
* @return a {#code LocalTime} based on this time with the nanoseconds subtracted, not null
*/
// @ts-ignore
public minusNanos(nanosToSubtract: number /*long*/): java.time.LocalTime
/**
* Queries this time using the specified query.
*
* This queries this time using the specified query strategy object.
* The {@code 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 {@code this} as the argument.
* @param
* 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 {@link Temporal#with(TemporalField, long)}
* passing {@link ChronoField#NANO_OF_DAY} as the field.
*
* In most cases, it is clearer to reverse the calling pattern by using
* {@link Temporal#with(TemporalAdjuster)}:
*
* This instance is immutable and unaffected by this method call.
* @param temporal the target object to be adjusted, not null
* @return the adjusted object, not null
* @throws DateTimeException if unable to make the adjustment
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public adjustInto(temporal: java.time.temporal.Temporal): java.time.temporal.Temporal
/**
* Calculates the amount of time until another time in terms of the specified unit.
*
* This calculates the amount of time between two {@code LocalTime}
* objects in terms of a single {@code TemporalUnit}.
* The start and end points are {@code this} and the specified time.
* The result will be negative if the end is before the start.
* The {@code Temporal} passed to this method is converted to a
* {@code LocalTime} using {@link #from(TemporalAccessor)}.
* For example, the amount 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 amount in hours between 11:30 and 13:29 will only
* be one hour as it is one minute short of two hours.
*
* There are two equivalent ways of using this method.
* The first is to invoke this method.
* The second is to use {@link TemporalUnit#between(Temporal, Temporal)}:
*
* The calculation is implemented in this method for {@link ChronoUnit}.
* The units {@code NANOS}, {@code MICROS}, {@code MILLIS}, {@code SECONDS},
* {@code MINUTES}, {@code HOURS} and {@code HALF_DAYS} are supported.
* Other {@code ChronoUnit} values will throw an exception.
*
* If the unit is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.between(Temporal, Temporal)}
* passing {@code this} as the first argument and the converted input temporal
* as the second argument.
*
* This instance is immutable and unaffected by this method call.
* @param endExclusive the end time, exclusive, which is converted to a {#code LocalTime}, not null
* @param unit the unit to measure the amount in, not null
* @return the amount of time between this time and the end time
* @throws DateTimeException if the amount cannot be calculated, or the end
* temporal cannot be converted to a {#code LocalTime}
* @throws UnsupportedTemporalTypeException if the unit is not supported
* @throws ArithmeticException if numeric overflow occurs
*/
// @ts-ignore
public until(endExclusive: java.time.temporal.Temporal, unit: java.time.temporal.TemporalUnit): number /*long*/
/**
* Formats this time using the specified formatter.
*
* This time will be passed to the formatter to produce a string.
* @param formatter the formatter to use, not null
* @return the formatted time string, not null
* @throws DateTimeException if an error occurs during printing
*/
// @ts-ignore
public format(formatter: java.time.format.DateTimeFormatter): string
/**
* Combines this time with a date to create a {@code LocalDateTime}.
*
* This returns a {@code LocalDateTime} formed from this time at the specified date.
* All possible combinations of date and time are valid.
* @param date the date to combine with, not null
* @return the local date-time formed from this time and the specified date, not null
*/
// @ts-ignore
public atDate(date: java.time.LocalDate): java.time.LocalDateTime
/**
* Combines this time with an offset to create an {@code OffsetTime}.
*
* This returns an {@code OffsetTime} formed from this time at the specified offset.
* All possible combinations of time and offset are valid.
* @param offset the offset to combine with, not null
* @return the offset time formed from this time and the specified offset, not null
*/
// @ts-ignore
public atOffset(offset: java.time.ZoneOffset): java.time.OffsetTime
/**
* Extracts the time as seconds of day,
* from {@code 0} to {@code 24 * 60 * 60 - 1}.
* @return the second-of-day equivalent to this time
*/
// @ts-ignore
public toSecondOfDay(): number /*int*/
/**
* Extracts the time as nanos of day,
* from {@code 0} to {@code 24 * 60 * 60 * 1,000,000,000 - 1}.
* @return the nano of day equivalent to this time
*/
// @ts-ignore
public toNanoOfDay(): number /*long*/
/**
* Compares this time 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 {@link Comparable}.
* @param other the other time to compare to, not null
* @return the comparator value, negative if less, positive if greater
* @throws NullPointerException if {#code other} is null
*/
// @ts-ignore
public compareTo(other: java.time.LocalTime): number /*int*/
/**
* Checks if this time is after the specified time.
*
* The comparison is based on the time-line position of the time within a day.
* @param other the other time to compare to, not null
* @return true if this is after the specified time
* @throws NullPointerException if {#code other} is null
*/
// @ts-ignore
public isAfter(other: java.time.LocalTime): boolean
/**
* Checks if this time is before the specified time.
*
* The comparison is based on the time-line position of the time within a day.
* @param other the other time to compare to, not null
* @return true if this point is before the specified time
* @throws NullPointerException if {#code other} is null
*/
// @ts-ignore
public isBefore(other: java.time.LocalTime): boolean
/**
* 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 {@code LocalTime} are compared, other types return false.
* To compare the date of two {@code TemporalAccessor} instances, use
* {@link ChronoField#NANO_OF_DAY} as a comparator.
* @param obj the object to check, null returns false
* @return true if this is equal to the other time
*/
// @ts-ignore
public equals(obj: java.lang.Object | any): boolean
/**
* A hash code for this time.
* @return a suitable hash code
*/
// @ts-ignore
public hashCode(): number /*int*/
/**
* Outputs this time as a {@code String}, such as {@code 10:15}.
*
* The output will be one of the following ISO-8601 formats:
*
*
* All other {@code ChronoField} instances will return false.
*
*
* All other {@code ChronoUnit} instances will return false.
*
*
*
*
*
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisLocalTime.adjustInto(temporal);
* temporal = temporal.with(thisLocalTime);
*
*
* // these two lines are equivalent
* amount = start.until(end, MINUTES);
* amount = MINUTES.between(start, end);
*
* The choice should be made based on which makes the code more readable.
*
*
* 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 a string representation of this time, not null
*/
// @ts-ignore
public toString(): string
}
}
}