public final class LocalTime extends Objectimplements Temporal , TemporalAdjuster , Comparable <LocalTime >, 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.
This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of LocalTime may have unpredictable results and should be avoided. The equals method should be used for comparisons.
| Modifier and Type | Field and Description |
|---|---|
static LocalTime |
MAX
The maximum 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
Adjusts the specified temporal object to have the same time as this object.
|
LocalDateTime |
atDate(LocalDate
Combines this time with a date to create a
LocalDateTime.
|
OffsetTime |
atOffset(ZoneOffset
Combines this time with an offset to create an
OffsetTime.
|
int |
compareTo(LocalTime
Compares this
LocalTime to another time.
|
boolean |
equals(Object
Checks if this time is equal to another time.
|
String |
format(DateTimeFormatter
Formats this time using the specified formatter.
|
static LocalTime |
from(TemporalAccessor
Obtains an instance of
LocalTime from a temporal object.
|
int |
get(TemporalField
Gets the value of the specified field from this time as an
int.
|
int |
getHour()
Gets the hour-of-day field.
|
long |
getLong(TemporalField
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
Checks if this
LocalTime is after the specified time.
|
boolean |
isBefore(LocalTime
Checks if this
LocalTime is before the specified time.
|
boolean |
isSupported(TemporalField
Checks if the specified field is supported.
|
boolean |
isSupported(TemporalUnit
Checks if the specified unit is supported.
|
LocalTime |
minus(long amountToSubtract, TemporalUnit
Returns a copy of this time with the specified amount subtracted.
|
LocalTime |
minus(TemporalAmount
Returns a copy of this time with the specified amount 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
Obtains the current time from the specified clock.
|
static LocalTime |
now(ZoneId
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 |
parse(CharSequence
Obtains an instance of
LocalTime from a text string such as
10:15.
|
static LocalTime |
parse(CharSequence
Obtains an instance of
LocalTime from a text string using a specific formatter.
|
LocalTime |
plus(long amountToAdd, TemporalUnit
Returns a copy of this time with the specified amount added.
|
LocalTime |
plus(TemporalAmount
Returns a copy of this time with the specified amount 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
Queries this time using the specified query.
|
ValueRange |
range(TemporalField
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.
|
String |
toString()
Outputs this time as a
String, such as
10:15.
|
LocalTime |
truncatedTo(TemporalUnit
Returns a copy of this
LocalTime with the time truncated.
|
long |
until(Temporal
Calculates the amount of time until another time in terms of the specified unit.
|
LocalTime |
with(TemporalAdjuster
Returns an adjusted copy of this time.
|
LocalTime |
with(TemporalField
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 LocalTimeMIN
LocalTime, '00:00'. This is the time of midnight at the start of the day.
public static final LocalTimeMAX
LocalTime, '23:59:59.999999999'. This is the time just before midnight at the end of the day.
public static final LocalTimeMIDNIGHT
public static final LocalTimeNOON
public static LocalTimenow()
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 LocalTimenow(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 null
public static LocalTimenow(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 null
public static LocalTimeof(int hour, int minute)
LocalTime from an hour and minute.
This returns a LocalTime with the specified hour and minute. The second and nanosecond fields will be set to zero.
hour - the hour-of-day to represent, from 0 to 23
minute - the minute-of-hour to represent, from 0 to 59
DateTimeException - if the value of any field is out of range
public static LocalTimeof(int hour, int minute, int second)
LocalTime from an hour, minute and second.
This returns a LocalTime with the specified hour, minute and second. The nanosecond field will be set to zero.
hour - the hour-of-day to represent, from 0 to 23
minute - the minute-of-hour to represent, from 0 to 59
second - the second-of-minute to represent, from 0 to 59
DateTimeException - if the value of any field is out of range
public static LocalTimeof(int hour, int minute, int second, int nanoOfSecond)
LocalTime from an hour, minute, second and nanosecond.
This returns a LocalTime with the specified hour, minute, second and nanosecond.
hour - the hour-of-day to represent, from 0 to 23
minute - the minute-of-hour to represent, from 0 to 59
second - the second-of-minute to represent, from 0 to 59
nanoOfSecond - the nano-of-second to represent, from 0 to 999,999,999
DateTimeException - if the value of any field is out of range
public static LocalTimeofSecondOfDay(long secondOfDay)
LocalTime from a second-of-day value.
This returns a LocalTime with the specified second-of-day. The nanosecond field will be set to zero.
secondOfDay - the second-of-day, from
0 to
24 * 60 * 60 - 1
DateTimeException - if the second-of-day value is invalid
public static LocalTimeofNanoOfDay(long nanoOfDay)
LocalTime from a nanos-of-day value.
This returns a LocalTime with the specified nanosecond-of-day.
nanoOfDay - the nano of day, from
0 to
24 * 60 * 60 * 1,000,000,000 - 1
DateTimeException - if the nanos of day value is invalid
public static LocalTimefrom(TemporalAccessor temporal)
LocalTime from a temporal object.
This obtains a local time based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of LocalTime.
The conversion uses the TemporalQueries query, which relies on extracting 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 null
DateTimeException - if unable to convert to a
LocalTime
public static LocalTimeparse(CharSequence text)
LocalTime from a text string such as
10:15.
The string must represent a valid time and is parsed using DateTimeFormatter.
text - the text to parse such as "10:15:30", not null
DateTimeParseException - if the text cannot be parsed
public static LocalTimeparse(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 null
formatter - the formatter to use, not null
DateTimeParseException - if the text cannot be parsed
public boolean isSupported(TemporalFieldfield)
This checks if this time can be queried for the specified field. If false, then calling the range, get and with(TemporalField, long) 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.isSupportedBy(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 false
public boolean isSupported(TemporalUnitunit)
This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the plus(long, TemporalUnit) and minus methods will throw an exception.
If the unit is a ChronoUnit then the query is implemented here. The supported units are:
NANOS MICROS MILLIS SECONDS MINUTES HOURS HALF_DAYS ChronoUnit instances will return false.
If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument. Whether the unit is supported is determined by the unit.
isSupported in interface
Temporal
unit - the unit to check, null returns false
public ValueRangerange(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 an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(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 null
DateTimeException - if the range for the field cannot be obtained
UnsupportedTemporalTypeException - if the field is not supported
public int get(TemporalFieldfield)
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 an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(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 null
DateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the field
UnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an
int
ArithmeticException - if numeric overflow occurs
public long getLong(TemporalFieldfield)
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 an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(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 null
DateTimeException - if a value for the field cannot be obtained
UnsupportedTemporalTypeException - if the field is not supported
ArithmeticException - if numeric overflow occurs
public int getHour()
public int getMinute()
public int getSecond()
public int getNano()
public LocalTimewith(TemporalAdjuster adjuster)
This returns a 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 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 null
LocalTime based on
this with the adjustment made, not null
DateTimeException - if the adjustment cannot be made
ArithmeticException - if numeric overflow occurs
public LocalTimewith(TemporalField field, long newValue)
This returns a 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 an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(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 null
newValue - the new value of the field in the result
LocalTime based on
this with the specified field set, not null
DateTimeException - if the field cannot be set
UnsupportedTemporalTypeException - if the field is not supported
ArithmeticException - if numeric overflow occurs
public LocalTimewithHour(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 23
LocalTime based on this time with the requested hour, not null
DateTimeException - if the hour value is invalid
public LocalTimewithMinute(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 59
LocalTime based on this time with the requested minute, not null
DateTimeException - if the minute value is invalid
public LocalTimewithSecond(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 59
LocalTime based on this time with the requested second, not null
DateTimeException - if the second value is invalid
public LocalTimewithNano(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,999
LocalTime based on this time with the requested nanosecond, not null
DateTimeException - if the nanos value is invalid
public LocalTimetruncatedTo(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.
The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.
This instance is immutable and unaffected by this method call.
unit - the unit to truncate to, not null
LocalTime based on this time with the time truncated, not null
DateTimeException - if unable to truncate
UnsupportedTemporalTypeException - if the unit is not supported
public LocalTimeplus(TemporalAmount amountToAdd)
This returns a LocalTime, based on this one, with the specified amount added. The amount is typically Duration but may be any other type implementing the TemporalAmount interface.
The calculation is delegated to the amount object by calling TemporalAmount. The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to 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.
plus in interface
Temporal
amountToAdd - the amount to add, not null
LocalTime based on this time with the addition made, not null
DateTimeException - if the addition cannot be made
ArithmeticException - if numeric overflow occurs
public LocalTimeplus(long amountToAdd, TemporalUnit unit)
This returns a 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 ChronoUnit then the addition is implemented here. The supported fields behave as follows:
NANOS - Returns a LocalTime with the specified number of nanoseconds added. This is equivalent to plusNanos(long). MICROS - Returns a LocalTime with the specified number of microseconds added. This is equivalent to plusNanos(long) with the amount multiplied by 1,000. MILLIS - Returns a LocalTime with the specified number of milliseconds added. This is equivalent to plusNanos(long) with the amount multiplied by 1,000,000. SECONDS - Returns a LocalTime with the specified number of seconds added. This is equivalent to plusSeconds(long). MINUTES - Returns a LocalTime with the specified number of minutes added. This is equivalent to plusMinutes(long). HOURS - Returns a LocalTime with the specified number of hours added. This is equivalent to plusHours(long). HALF_DAYS - Returns a LocalTime with the specified number of half-days added. This is equivalent to plusHours(long) with the amount multiplied by 12. All other ChronoUnit instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing 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.
plus in interface
Temporal
amountToAdd - the amount of the unit to add to the result, may be negative
unit - the unit of the amount to add, not null
LocalTime based on this time with the specified amount added, not null
DateTimeException - if the addition cannot be made
UnsupportedTemporalTypeException - if the unit is not supported
ArithmeticException - if numeric overflow occurs
public LocalTimeplusHours(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 negative
LocalTime based on this time with the hours added, not null
public LocalTimeplusMinutes(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 negative
LocalTime based on this time with the minutes added, not null
public LocalTimeplusSeconds(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 negative
LocalTime based on this time with the seconds added, not null
public LocalTimeplusNanos(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 negative
LocalTime based on this time with the nanoseconds added, not null
public LocalTimeminus(TemporalAmount amountToSubtract)
This returns a LocalTime, based on this one, with the specified amount subtracted. The amount is typically Duration but may be any other type implementing the TemporalAmount interface.
The calculation is delegated to the amount object by calling TemporalAmount. The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to 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.
minus in interface
Temporal
amountToSubtract - the amount to subtract, not null
LocalTime based on this time with the subtraction made, not null
DateTimeException - if the subtraction cannot be made
ArithmeticException - if numeric overflow occurs
public LocalTimeminus(long amountToSubtract, TemporalUnit unit)
This returns a 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 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.
minus in interface
Temporal
amountToSubtract - the amount of the unit to subtract from the result, may be negative
unit - the unit of the amount to subtract, not null
LocalTime based on this time with the specified amount subtracted, not null
DateTimeException - if the subtraction cannot be made
UnsupportedTemporalTypeException - if the unit is not supported
ArithmeticException - if numeric overflow occurs
public LocalTimeminusHours(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 negative
LocalTime based on this time with the hours subtracted, not null
public LocalTimeminusMinutes(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 negative
LocalTime based on this time with the minutes subtracted, not null
public LocalTimeminusSeconds(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 negative
LocalTime based on this time with the seconds subtracted, not null
public LocalTimeminusNanos(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 negative
LocalTime based on this time with the nanoseconds subtracted, not null
public <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 method on the specified query passing this as the argument.
query in interface
TemporalAccessor
R - the type of the result
query - the query to invoke, not null
DateTimeException - if unable to query (defined by the query)
ArithmeticException - if numeric overflow occurs (defined by the query)
public TemporaladjustInto(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 passing ChronoField as the field.
In most cases, it is clearer to reverse the calling pattern by using Temporal:
// 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 null
DateTimeException - if unable to make the adjustment
ArithmeticException - if numeric overflow occurs
public long until(TemporalendExclusive, TemporalUnit unit)
This calculates the amount of time between two LocalTime objects in terms of a single TemporalUnit. 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 is converted to a LocalTime using from(TemporalAccessor). For example, the amount in hours between two times can be calculated using 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 TemporalUnit:
// 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 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 converted input temporal as the second argument.
This instance is immutable and unaffected by this method call.
until in interface
Temporal
endExclusive - the end time, exclusive, which is converted to a
LocalTime, not null
unit - the unit to measure the amount in, not null
DateTimeException - if the amount cannot be calculated, or the end temporal cannot be converted to a
LocalTime
UnsupportedTemporalTypeException - if the unit is not supported
ArithmeticException - if numeric overflow occurs
public Stringformat(DateTimeFormatter formatter)
This time will be passed to the formatter to produce a string.
formatter - the formatter to use, not null
DateTimeException - if an error occurs during printing
public LocalDateTimeatDate(LocalDate date)
LocalDateTime.
This returns a LocalDateTime formed from this time at the specified date. All possible combinations of date and time are valid.
date - the date to combine with, not null
public OffsetTimeatOffset(ZoneOffset offset)
OffsetTime.
This returns an OffsetTime formed from this time at the specified offset. All possible combinations of time and offset are valid.
offset - the offset to combine with, not null
public int toSecondOfDay()
0 to
24 * 60 * 60 - 1.
public long toNanoOfDay()
0 to
24 * 60 * 60 * 1,000,000,000 - 1.
public int compareTo(LocalTimeother)
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
Comparable<LocalTime>
other - the other time to compare to, not null
NullPointerException - if
other is null
public boolean isAfter(LocalTimeother)
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 null
NullPointerException - if
other is null
public boolean isBefore(LocalTimeother)
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 null
NullPointerException - if
other is null
public boolean equals(Objectobj)
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 as a comparator.
equals in class
Object
obj - the object to check, null returns false
Object.hashCode() ,
HashMap
public int hashCode()
hashCode in class
Object
Object.equals(java.lang.Object) ,
System.identityHashCode(java.lang.Object)
public StringtoString()
String, such as
10:15.
The output will be one of the following ISO-8601 formats:
HH:mmHH:mm:ssHH:mm:ss.SSSHH:mm:ss.SSSSSSHH:mm:ss.SSSSSSSSS