public final class LocalTime extends java.lang.Object implements Temporal, TemporalAdjuster, java.lang.Comparable<LocalTime>, java.io.Serializable
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.
Modifier and Type | Field and Description |
---|---|
static LocalTime |
MAX
The minimum supported
LocalTime , '23:59:59.999999999'. |
static LocalTime |
MIDNIGHT
The time of midnight at the start of the day, '00:00'.
|
static LocalTime |
MIN
The minimum supported
LocalTime , '00:00'. |
static LocalTime |
NOON
The time of noon in the middle of the day, '12:00'.
|
Modifier and Type | Method and Description |
---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have the same time as this object.
|
LocalDateTime |
atDate(LocalDate date)
Returns a local date-time formed from this time at the specified date.
|
OffsetTime |
atOffset(ZoneOffset offset)
Returns an offset time formed from this time and the specified offset.
|
int |
compareTo(LocalTime other)
Compares this
LocalTime to another time. |
boolean |
equals(java.lang.Object obj)
Checks if this time is equal to another time.
|
static LocalTime |
from(TemporalAccessor temporal)
Obtains an instance of
LocalTime from a temporal object. |
int |
get(TemporalField field)
Gets the value of the specified field from this time as an
int . |
int |
getHour()
Gets the hour-of-day field.
|
long |
getLong(TemporalField field)
Gets the value of the specified field from this time as a
long . |
int |
getMinute()
Gets the minute-of-hour field.
|
int |
getNano()
Gets the nano-of-second field.
|
int |
getSecond()
Gets the second-of-minute field.
|
int |
hashCode()
A hash code for this time.
|
boolean |
isAfter(LocalTime other)
Checks if this
LocalTime is after the specified time. |
boolean |
isBefore(LocalTime other)
Checks if this
LocalTime is before the specified time. |
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
LocalTime |
minus(long amountToSubtract,
TemporalUnit unit)
Returns a copy of this time with the specified period subtracted.
|
LocalTime |
minus(TemporalSubtractor subtractor)
Returns a copy of this time with the specified period subtracted.
|
LocalTime |
minusHours(long hoursToSubtract)
Returns a copy of this
LocalTime with the specified period in hours subtracted. |
LocalTime |
minusMinutes(long minutesToSubtract)
Returns a copy of this
LocalTime with the specified period in minutes subtracted. |
LocalTime |
minusNanos(long nanosToSubtract)
Returns a copy of this
LocalTime with the specified period in nanoseconds subtracted. |
LocalTime |
minusSeconds(long secondsToSubtract)
Returns a copy of this
LocalTime with the specified period in seconds subtracted. |
static LocalTime |
now()
Obtains the current time from the system clock in the default time-zone.
|
static LocalTime |
now(Clock clock)
Obtains the current time from the specified clock.
|
static LocalTime |
now(ZoneId zone)
Obtains the current time from the system clock in the specified time-zone.
|
static LocalTime |
of(int hour,
int minute)
Obtains an instance of
LocalTime from an hour and minute. |
static LocalTime |
of(int hour,
int minute,
int second)
Obtains an instance of
LocalTime from an hour, minute and second. |
static LocalTime |
of(int hour,
int minute,
int second,
int nanoOfSecond)
Obtains an instance of
LocalTime from an hour, minute, second and nanosecond. |
static LocalTime |
ofNanoOfDay(long nanoOfDay)
Obtains an instance of
LocalTime from a nanos-of-day value. |
static LocalTime |
ofSecondOfDay(long secondOfDay)
Obtains an instance of
LocalTime from a second-of-day value. |
static LocalTime |
ofSecondOfDay(long secondOfDay,
int nanoOfSecond)
Obtains an instance of
LocalTime from a second-of-day value, with
associated nanos of second. |
static LocalTime |
parse(java.lang.CharSequence text)
Obtains an instance of
LocalTime from a text string such as 10:15 . |
static LocalTime |
parse(java.lang.CharSequence text,
DateTimeFormatter formatter)
Obtains an instance of
LocalTime from a text string using a specific formatter. |
long |
periodUntil(Temporal endTime,
TemporalUnit unit)
Calculates the period between this time and another time in
terms of the specified unit.
|
LocalTime |
plus(long amountToAdd,
TemporalUnit unit)
Returns a copy of this time with the specified period added.
|
LocalTime |
plus(TemporalAdder adder)
Returns a copy of this date with the specified period added.
|
LocalTime |
plusHours(long hoursToAdd)
Returns a copy of this
LocalTime with the specified period in hours added. |
LocalTime |
plusMinutes(long minutesToAdd)
Returns a copy of this
LocalTime with the specified period in minutes added. |
LocalTime |
plusNanos(long nanosToAdd)
Returns a copy of this
LocalTime with the specified period in nanoseconds added. |
LocalTime |
plusSeconds(long secondstoAdd)
Returns a copy of this
LocalTime with the specified period in seconds added. |
<R> R |
query(TemporalQuery<R> query)
Queries this time using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
long |
toNanoOfDay()
Extracts the time as nanos of day,
from
0 to 24 * 60 * 60 * 1,000,000,000 - 1 . |
int |
toSecondOfDay()
Extracts the time as seconds of day,
from
0 to 24 * 60 * 60 - 1 . |
java.lang.String |
toString()
Outputs this time as a
String , such as 10:15 . |
java.lang.String |
toString(DateTimeFormatter formatter)
Outputs this time as a
String using the formatter. |
LocalTime |
truncatedTo(TemporalUnit unit)
Returns a copy of this
LocalTime with the time truncated. |
LocalTime |
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this time.
|
LocalTime |
with(TemporalField field,
long newValue)
Returns a copy of this time with the specified field set to a new value.
|
LocalTime |
withHour(int hour)
Returns a copy of this
LocalTime with the hour-of-day value altered. |
LocalTime |
withMinute(int minute)
Returns a copy of this
LocalTime with the minute-of-hour value altered. |
LocalTime |
withNano(int nanoOfSecond)
Returns a copy of this
LocalTime with the nano-of-second value altered. |
LocalTime |
withSecond(int second)
Returns a copy of this
LocalTime with the second-of-minute value altered. |
public static final LocalTime MIN
LocalTime
, '00:00'.
This is the time of midnight at the start of the day.public static final LocalTime MAX
LocalTime
, '23:59:59.999999999'.
This is the time just before midnight at the end of the day.public static final LocalTime MIDNIGHT
public static final LocalTime NOON
public static LocalTime now()
This will query the 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.
public static LocalTime now(ZoneId zone)
This will query the 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.
zone
- the zone ID to use, not nullpublic static LocalTime now(Clock 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 dependency injection
.
clock
- the clock to use, not nullpublic static LocalTime of(int hour, int minute)
LocalTime
from an hour and minute.
The second and nanosecond fields will be set to zero by this factory method.
This factory may return a cached value, but applications must not rely on this.
hour
- the hour-of-day to represent, from 0 to 23minute
- the minute-of-hour to represent, from 0 to 59DateTimeException
- if the value of any field is out of rangepublic static LocalTime of(int hour, int minute, int second)
LocalTime
from an hour, minute and second.
The nanosecond field will be set to zero by this factory method.
This factory may return a cached value, but applications must not rely on this.
hour
- the hour-of-day to represent, from 0 to 23minute
- the minute-of-hour to represent, from 0 to 59second
- the second-of-minute to represent, from 0 to 59DateTimeException
- if the value of any field is out of rangepublic static LocalTime of(int hour, int minute, int second, int nanoOfSecond)
LocalTime
from an hour, minute, second and nanosecond.
This factory may return a cached value, but applications must not rely on this.
hour
- the hour-of-day to represent, from 0 to 23minute
- the minute-of-hour to represent, from 0 to 59second
- the second-of-minute to represent, from 0 to 59nanoOfSecond
- the nano-of-second to represent, from 0 to 999,999,999DateTimeException
- if the value of any field is out of rangepublic static LocalTime ofSecondOfDay(long secondOfDay)
LocalTime
from a second-of-day value.
This factory may return a cached value, but applications must not rely on this.
secondOfDay
- the second-of-day, from 0
to 24 * 60 * 60 - 1
DateTimeException
- if the second-of-day value is invalidpublic static LocalTime ofSecondOfDay(long secondOfDay, int nanoOfSecond)
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.
secondOfDay
- the second-of-day, from 0
to 24 * 60 * 60 - 1
nanoOfSecond
- the nano-of-second, from 0 to 999,999,999DateTimeException
- if the either input value is invalidpublic static LocalTime ofNanoOfDay(long nanoOfDay)
LocalTime
from a nanos-of-day value.
This factory may return a cached value, but applications must not rely on this.
nanoOfDay
- the nano of day, from 0
to 24 * 60 * 60 * 1,000,000,000 - 1
DateTimeException
- if the nanos of day value is invalidpublic static LocalTime from(TemporalAccessor temporal)
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 extracts the 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
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to a LocalTime
public static LocalTime parse(java.lang.CharSequence text)
LocalTime
from a text string such as 10:15
.
The string must represent a valid time and is parsed using
DateTimeFormatters.isoLocalTime()
.
text
- the text to parse such as "10:15:30", not nullDateTimeParseException
- if the text cannot be parsedpublic static LocalTime parse(java.lang.CharSequence text, DateTimeFormatter formatter)
LocalTime
from a text string using a specific formatter.
The text is parsed using the formatter, returning a time.
text
- the text to parse, not nullformatter
- the formatter to use, not nullDateTimeParseException
- if the text cannot be parsedpublic boolean isSupported(TemporalField field)
This checks if this time can be queried for the specified field.
If false, then calling the range
and
get
methods will throw an exception.
If the field is a ChronoField
then the query is implemented here.
The supported fields are:
NANO_OF_SECOND
NANO_OF_DAY
MICRO_OF_SECOND
MICRO_OF_DAY
MILLI_OF_SECOND
MILLI_OF_DAY
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR_OF_AMPM
CLOCK_HOUR_OF_AMPM
HOUR_OF_DAY
CLOCK_HOUR_OF_DAY
AMPM_OF_DAY
ChronoField
instances will return false.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doIsSupported(TemporalAccessor)
passing this
as the argument.
Whether the field is supported is determined by the field.
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic ValueRange range(TemporalField 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
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.doRange(TemporalAccessor)
passing this
as the argument.
Whether the range can be obtained is determined by the field.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedpublic int get(TemporalField field)
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
will return valid
values based on this time, except NANO_OF_DAY
and 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.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic long getLong(TemporalField field)
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
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.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic int getHour()
public int getMinute()
public int getSecond()
public int getNano()
public LocalTime with(TemporalAdjuster adjuster)
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(Temporal)
method on the
specified adjuster passing this
as the argument.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
adjuster
- the adjuster to use, not nullLocalTime
based on this
with the adjustment made, not nullDateTimeException
- if the adjustment cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic LocalTime with(TemporalField field, long newValue)
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:
NANO_OF_SECOND
-
Returns a LocalTime
with the specified nano-of-second.
The hour, minute and second will be unchanged.
NANO_OF_DAY
-
Returns a LocalTime
with the specified nano-of-day.
This completely replaces the time and is equivalent to ofNanoOfDay(long)
.
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.
MICRO_OF_DAY
-
Returns a LocalTime
with the specified micro-of-day.
This completely replaces the time and is equivalent to using ofNanoOfDay(long)
with the micro-of-day multiplied by 1,000.
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.
MILLI_OF_DAY
-
Returns a LocalTime
with the specified milli-of-day.
This completely replaces the time and is equivalent to using ofNanoOfDay(long)
with the milli-of-day multiplied by 1,000,000.
SECOND_OF_MINUTE
-
Returns a LocalTime
with the specified second-of-minute.
The hour, minute and nano-of-second will be unchanged.
SECOND_OF_DAY
-
Returns a LocalTime
with the specified second-of-day.
The nano-of-second will be unchanged.
MINUTE_OF_HOUR
-
Returns a LocalTime
with the specified minute-of-hour.
The hour, second-of-minute and nano-of-second will be unchanged.
MINUTE_OF_DAY
-
Returns a LocalTime
with the specified minute-of-day.
The second-of-minute and nano-of-second will be unchanged.
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.
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.
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.
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.
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.doWith(Temporal, long)
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.
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultLocalTime
based on this
with the specified field set, not nullDateTimeException
- if the field cannot be setjava.lang.ArithmeticException
- if numeric overflow occurspublic LocalTime withHour(int hour)
LocalTime
with the hour-of-day value altered.
This instance is immutable and unaffected by this method call.
hour
- the hour-of-day to set in the result, from 0 to 23LocalTime
based on this time with the requested hour, not nullDateTimeException
- if the hour value is invalidpublic LocalTime withMinute(int minute)
LocalTime
with the minute-of-hour value altered.
This instance is immutable and unaffected by this method call.
minute
- the minute-of-hour to set in the result, from 0 to 59LocalTime
based on this time with the requested minute, not nullDateTimeException
- if the minute value is invalidpublic LocalTime withSecond(int second)
LocalTime
with the second-of-minute value altered.
This instance is immutable and unaffected by this method call.
second
- the second-of-minute to set in the result, from 0 to 59LocalTime
based on this time with the requested second, not nullDateTimeException
- if the second value is invalidpublic LocalTime withNano(int nanoOfSecond)
LocalTime
with the nano-of-second value altered.
This instance is immutable and unaffected by this method call.
nanoOfSecond
- the nano-of-second to set in the result, from 0 to 999,999,999LocalTime
based on this time with the requested nanosecond, not nullDateTimeException
- if the nanos value is invalidpublic LocalTime truncatedTo(TemporalUnit unit)
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 minutes
unit
will set the second-of-minute and nano-of-second field to zero.
Not all units are accepted. The days
unit and time
units with an exact duration can be used, other units throw an exception.
This instance is immutable and unaffected by this method call.
unit
- the unit to truncate to, not nullLocalTime
based on this time with the time truncated, not nullDateTimeException
- if unable to truncatepublic LocalTime plus(TemporalAdder adder)
This method returns a new time based on this time with the specified period added.
The adder is typically Period
but may be any other type implementing
the TemporalAdder
interface.
The calculation is delegated to the specified adjuster, which typically calls
back to plus(long, TemporalUnit)
.
This instance is immutable and unaffected by this method call.
plus
in interface Temporal
adder
- the adder to use, not nullLocalTime
based on this time with the addition made, not nullDateTimeException
- if the addition cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic LocalTime plus(long amountToAdd, TemporalUnit unit)
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.
plus
in interface Temporal
amountToAdd
- the amount of the unit to add to the result, may be negativeunit
- the unit of the period to add, not nullLocalTime
based on this time with the specified period added, not nullDateTimeException
- if the unit cannot be added to this typepublic LocalTime plusHours(long hoursToAdd)
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.
hoursToAdd
- the hours to add, may be negativeLocalTime
based on this time with the hours added, not nullpublic LocalTime plusMinutes(long minutesToAdd)
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.
minutesToAdd
- the minutes to add, may be negativeLocalTime
based on this time with the minutes added, not nullpublic LocalTime plusSeconds(long secondstoAdd)
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.
secondstoAdd
- the seconds to add, may be negativeLocalTime
based on this time with the seconds added, not nullpublic LocalTime plusNanos(long nanosToAdd)
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.
nanosToAdd
- the nanos to add, may be negativeLocalTime
based on this time with the nanoseconds added, not nullpublic LocalTime minus(TemporalSubtractor subtractor)
This method returns a new time based on this time with the specified period subtracted.
The subtractor is typically Period
but may be any other type implementing
the TemporalSubtractor
interface.
The calculation is delegated to the specified adjuster, which typically calls
back to minus(long, TemporalUnit)
.
This instance is immutable and unaffected by this method call.
minus
in interface Temporal
subtractor
- the subtractor to use, not nullLocalTime
based on this time with the subtraction made, not nullDateTimeException
- if the subtraction cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic LocalTime minus(long amountToSubtract, TemporalUnit unit)
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.
minus
in interface Temporal
amountToSubtract
- the amount of the unit to subtract from the result, may be negativeunit
- the unit of the period to subtract, not nullLocalTime
based on this time with the specified period subtracted, not nullDateTimeException
- if the unit cannot be added to this typepublic LocalTime minusHours(long hoursToSubtract)
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.
hoursToSubtract
- the hours to subtract, may be negativeLocalTime
based on this time with the hours subtracted, not nullpublic LocalTime minusMinutes(long minutesToSubtract)
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.
minutesToSubtract
- the minutes to subtract, may be negativeLocalTime
based on this time with the minutes subtracted, not nullpublic LocalTime minusSeconds(long secondsToSubtract)
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.
secondsToSubtract
- the seconds to subtract, may be negativeLocalTime
based on this time with the seconds subtracted, not nullpublic LocalTime minusNanos(long nanosToSubtract)
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.
nanosToSubtract
- the nanos to subtract, may be negativeLocalTime
based on this time with the nanoseconds subtracted, not nullpublic <R> R query(TemporalQuery<R> 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(TemporalAccessor)
method on the
specified query passing this
as the argument.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)java.lang.ArithmeticException
- if numeric overflow occurs (defined by the query)public Temporal adjustInto(Temporal temporal)
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(TemporalField, long)
passing ChronoField.NANO_OF_DAY
as the field.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.with(TemporalAdjuster)
:
// 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.
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentjava.lang.ArithmeticException
- if numeric overflow occurspublic long periodUntil(Temporal endTime, TemporalUnit 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.periodUntil(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(R, R)
.
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.periodUntil(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 NANOS
, MICROS
, MILLIS
, SECONDS
,
MINUTES
, HOURS
and 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(Temporal, Temporal)
passing this
as the first argument and the input temporal as
the second argument.
This instance is immutable and unaffected by this method call.
periodUntil
in interface Temporal
endTime
- the end time, which must be a LocalTime
, not nullunit
- the unit to measure the period in, not nullDateTimeException
- if the period cannot be calculatedjava.lang.ArithmeticException
- if numeric overflow occurspublic LocalDateTime atDate(LocalDate date)
This combines this time with the specified date to form a LocalDateTime
.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
date
- the date to combine with, not nullpublic OffsetTime atOffset(ZoneOffset offset)
This combines this time with the specified offset to form an OffsetTime
.
All possible combinations of time and offset are valid.
This instance is immutable and unaffected by this method call.
offset
- the offset to combine with, not nullpublic int toSecondOfDay()
0
to 24 * 60 * 60 - 1
.public long toNanoOfDay()
0
to 24 * 60 * 60 * 1,000,000,000 - 1
.public int compareTo(LocalTime other)
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
.
compareTo
in interface java.lang.Comparable<LocalTime>
other
- the other time to compare to, not nulljava.lang.NullPointerException
- if other
is nullpublic boolean isAfter(LocalTime other)
LocalTime
is after the specified time.
The comparison is based on the time-line position of the time within a day.
other
- the other time to compare to, not nulljava.lang.NullPointerException
- if other
is nullpublic boolean isBefore(LocalTime other)
LocalTime
is before the specified time.
The comparison is based on the time-line position of the time within a day.
other
- the other time to compare to, not nulljava.lang.NullPointerException
- if other
is nullpublic boolean equals(java.lang.Object obj)
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.
equals
in class java.lang.Object
obj
- the object to check, null returns falseObject.hashCode()
,
HashMap
public int hashCode()
hashCode
in class java.lang.Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public java.lang.String toString()
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.
toString
in class java.lang.Object
public java.lang.String toString(DateTimeFormatter formatter)
String
using the formatter.
This time will be passed to the formatter
print method
.
formatter
- the formatter to use, not nullDateTimeException
- if an error occurs during printing