Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Fields](https://developer.android.com/reference/java/time/LocalTime#lfields) \| [Methods](https://developer.android.com/reference/java/time/LocalTime#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/time/LocalTime#inhmethods) # LocalTime ` public final class LocalTime ` ` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/lang/Comparable, https://developer.android.com/reference/java/io/Serializable, https://developer.android.com/reference/java/time/temporal/Temporal, https://developer.android.com/reference/java/time/temporal/TemporalAdjuster ` |---|---| | [java.lang.Object](https://developer.android.com/reference/java/lang/Object) || | ↳ | java.time.LocalTime |
*** ** * ** *** A time without a time-zone in the ISO-8601 calendar system, such as `10:15:30`. `LocalTime` is an immutable date-time object that represents a time, often viewed as hour-minute-second. Time is represented to nanosecond precision. For example, the value "13:45.30.123456789" can be stored in a `LocalTime`. 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](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/doc-files/ValueBased.html) class; programmers should treat instances that are [equal](https://developer.android.com/reference/java/time/LocalTime#equals(java.lang.Object)) as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail. The `equals` method should be used for comparisons. ## Summary | ### Fields || |---|---| | ` public static final https://developer.android.com/reference/java/time/LocalTime` | `https://developer.android.com/reference/java/time/LocalTime#MAX` The maximum supported `LocalTime`, '23:59:59.999999999'. | | ` public static final https://developer.android.com/reference/java/time/LocalTime` | `https://developer.android.com/reference/java/time/LocalTime#MIDNIGHT` The time of midnight at the start of the day, '00:00'. | | ` public static final https://developer.android.com/reference/java/time/LocalTime` | `https://developer.android.com/reference/java/time/LocalTime#MIN` The minimum supported `LocalTime`, '00:00'. | | ` public static final https://developer.android.com/reference/java/time/LocalTime` | `https://developer.android.com/reference/java/time/LocalTime#NOON` The time of noon in the middle of the day, '12:00'. | | ### Public methods || |---|---| | ` https://developer.android.com/reference/java/time/temporal/Temporal` | ` https://developer.android.com/reference/java/time/LocalTime#adjustInto(java.time.temporal.Temporal)(https://developer.android.com/reference/java/time/temporal/Temporal temporal) ` Adjusts the specified temporal object to have the same time as this object. | | ` https://developer.android.com/reference/java/time/LocalDateTime` | ` https://developer.android.com/reference/java/time/LocalTime#atDate(java.time.LocalDate)(https://developer.android.com/reference/java/time/LocalDate date) ` Combines this time with a date to create a `LocalDateTime`. | | ` https://developer.android.com/reference/java/time/OffsetTime` | ` https://developer.android.com/reference/java/time/LocalTime#atOffset(java.time.ZoneOffset)(https://developer.android.com/reference/java/time/ZoneOffset offset) ` Combines this time with an offset to create an `OffsetTime`. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#compareTo(java.time.LocalTime)(https://developer.android.com/reference/java/time/LocalTime other) ` Compares this time to another time. | | ` boolean` | ` https://developer.android.com/reference/java/time/LocalTime#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Checks if this time is equal to another time. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/time/LocalTime#format(java.time.format.DateTimeFormatter)(https://developer.android.com/reference/java/time/format/DateTimeFormatter formatter) ` Formats this time using the specified formatter. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#from(java.time.temporal.TemporalAccessor)(https://developer.android.com/reference/java/time/temporal/TemporalAccessor temporal) ` Obtains an instance of `LocalTime` from a temporal object. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#get(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the value of the specified field from this time as an `int`. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#getHour()() ` Gets the hour-of-day field. | | ` long` | ` https://developer.android.com/reference/java/time/LocalTime#getLong(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the value of the specified field from this time as a `long`. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#getMinute()() ` Gets the minute-of-hour field. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#getNano()() ` Gets the nano-of-second field. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#getSecond()() ` Gets the second-of-minute field. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#hashCode()() ` A hash code for this time. | | ` boolean` | ` https://developer.android.com/reference/java/time/LocalTime#isAfter(java.time.LocalTime)(https://developer.android.com/reference/java/time/LocalTime other) ` Checks if this time is after the specified time. | | ` boolean` | ` https://developer.android.com/reference/java/time/LocalTime#isBefore(java.time.LocalTime)(https://developer.android.com/reference/java/time/LocalTime other) ` Checks if this time is before the specified time. | | ` boolean` | ` https://developer.android.com/reference/java/time/LocalTime#isSupported(java.time.temporal.TemporalUnit)(https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Checks if the specified unit is supported. | | ` boolean` | ` https://developer.android.com/reference/java/time/LocalTime#isSupported(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Checks if the specified field is supported. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minus(java.time.temporal.TemporalAmount)(https://developer.android.com/reference/java/time/temporal/TemporalAmount amountToSubtract) ` Returns a copy of this time with the specified amount subtracted. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minus(long,%20java.time.temporal.TemporalUnit)(long amountToSubtract, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Returns a copy of this time with the specified amount subtracted. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minusHours(long)(long hoursToSubtract) ` Returns a copy of this `LocalTime` with the specified number of hours subtracted. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minusMinutes(long)(long minutesToSubtract) ` Returns a copy of this `LocalTime` with the specified number of minutes subtracted. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minusNanos(long)(long nanosToSubtract) ` Returns a copy of this `LocalTime` with the specified number of nanoseconds subtracted. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#minusSeconds(long)(long secondsToSubtract) ` Returns a copy of this `LocalTime` with the specified number of seconds subtracted. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#now(java.time.ZoneId)(https://developer.android.com/reference/java/time/ZoneId zone) ` Obtains the current time from the system clock in the specified time-zone. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#now()() ` Obtains the current time from the system clock in the default time-zone. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#now(java.time.Clock)(https://developer.android.com/reference/java/time/Clock clock) ` Obtains the current time from the specified clock. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#of(int,%20int,%20int)(int hour, int minute, int second) ` Obtains an instance of `LocalTime` from an hour, minute and second. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#of(int,%20int,%20int,%20int)(int hour, int minute, int second, int nanoOfSecond) ` Obtains an instance of `LocalTime` from an hour, minute, second and nanosecond. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#of(int,%20int)(int hour, int minute) ` Obtains an instance of `LocalTime` from an hour and minute. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#ofInstant(java.time.Instant,%20java.time.ZoneId)(https://developer.android.com/reference/java/time/Instant instant, https://developer.android.com/reference/java/time/ZoneId zone) ` Obtains an instance of `LocalTime` from an `Instant` and zone ID. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#ofNanoOfDay(long)(long nanoOfDay) ` Obtains an instance of `LocalTime` from a nanos-of-day value. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#ofSecondOfDay(long)(long secondOfDay) ` Obtains an instance of `LocalTime` from a second-of-day value. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#parse(java.lang.CharSequence,%20java.time.format.DateTimeFormatter)(https://developer.android.com/reference/java/lang/CharSequence text, https://developer.android.com/reference/java/time/format/DateTimeFormatter formatter) ` Obtains an instance of `LocalTime` from a text string using a specific formatter. | | ` static https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#parse(java.lang.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence text) ` Obtains an instance of `LocalTime` from a text string such as `10:15`. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plus(java.time.temporal.TemporalAmount)(https://developer.android.com/reference/java/time/temporal/TemporalAmount amountToAdd) ` Returns a copy of this time with the specified amount added. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plus(long,%20java.time.temporal.TemporalUnit)(long amountToAdd, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Returns a copy of this time with the specified amount added. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plusHours(long)(long hoursToAdd) ` Returns a copy of this `LocalTime` with the specified number of hours added. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plusMinutes(long)(long minutesToAdd) ` Returns a copy of this `LocalTime` with the specified number of minutes added. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plusNanos(long)(long nanosToAdd) ` Returns a copy of this `LocalTime` with the specified number of nanoseconds added. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#plusSeconds(long)(long secondstoAdd) ` Returns a copy of this `LocalTime` with the specified number of seconds added. | | ` R` | ` https://developer.android.com/reference/java/time/LocalTime#query(java.time.temporal.TemporalQuery)(https://developer.android.com/reference/java/time/temporal/TemporalQuery query) ` Queries this time using the specified query. | | ` https://developer.android.com/reference/java/time/temporal/ValueRange` | ` https://developer.android.com/reference/java/time/LocalTime#range(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the range of valid values for the specified field. | | ` long` | ` https://developer.android.com/reference/java/time/LocalTime#toEpochSecond(java.time.LocalDate,%20java.time.ZoneOffset)(https://developer.android.com/reference/java/time/LocalDate date, https://developer.android.com/reference/java/time/ZoneOffset offset) ` Converts this `LocalTime` to the number of seconds since the epoch of 1970-01-01T00:00:00Z. | | ` long` | ` https://developer.android.com/reference/java/time/LocalTime#toNanoOfDay()() ` Extracts the time as nanos of day, from `0` to `24 * 60 * 60 * 1,000,000,000 - 1`. | | ` int` | ` https://developer.android.com/reference/java/time/LocalTime#toSecondOfDay()() ` Extracts the time as seconds of day, from `0` to `24 * 60 * 60 - 1`. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/time/LocalTime#toString()() ` Outputs this time as a `String`, such as `10:15`. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#truncatedTo(java.time.temporal.TemporalUnit)(https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Returns a copy of this `LocalTime` with the time truncated. | | ` long` | ` https://developer.android.com/reference/java/time/LocalTime#until(java.time.temporal.Temporal,%20java.time.temporal.TemporalUnit)(https://developer.android.com/reference/java/time/temporal/Temporal endExclusive, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Calculates the amount of time until another time in terms of the specified unit. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#with(java.time.temporal.TemporalField,%20long)(https://developer.android.com/reference/java/time/temporal/TemporalField field, long newValue) ` Returns a copy of this time with the specified field set to a new value. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#with(java.time.temporal.TemporalAdjuster)(https://developer.android.com/reference/java/time/temporal/TemporalAdjuster adjuster) ` Returns an adjusted copy of this time. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#withHour(int)(int hour) ` Returns a copy of this `LocalTime` with the hour-of-day altered. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#withMinute(int)(int minute) ` Returns a copy of this `LocalTime` with the minute-of-hour altered. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#withNano(int)(int nanoOfSecond) ` Returns a copy of this `LocalTime` with the nano-of-second altered. | | ` https://developer.android.com/reference/java/time/LocalTime` | ` https://developer.android.com/reference/java/time/LocalTime#withSecond(int)(int second) ` Returns a copy of this `LocalTime` with the second-of-minute altered. | ### Inherited methods From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. ` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. ` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. ` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. ` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. ` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. ` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. ` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. ` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. ` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. ` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. From interface ` https://developer.android.com/reference/java/lang/Comparable ` ` abstract int` ` https://developer.android.com/reference/java/lang/Comparable#compareTo(T)(https://developer.android.com/reference/java/time/LocalTime o) ` Compares this object with the specified object for order. From interface ` https://developer.android.com/reference/java/time/temporal/Temporal ` ` abstract boolean` ` https://developer.android.com/reference/java/time/temporal/Temporal#isSupported(java.time.temporal.TemporalUnit)(https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Checks if the specified unit is supported. ` default https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#minus(java.time.temporal.TemporalAmount)(https://developer.android.com/reference/java/time/temporal/TemporalAmount amount) ` Returns an object of the same type as this object with an amount subtracted. ` default https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#minus(long,%20java.time.temporal.TemporalUnit)(long amountToSubtract, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Returns an object of the same type as this object with the specified period subtracted. ` abstract https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#plus(long,%20java.time.temporal.TemporalUnit)(long amountToAdd, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Returns an object of the same type as this object with the specified period added. ` default https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#plus(java.time.temporal.TemporalAmount)(https://developer.android.com/reference/java/time/temporal/TemporalAmount amount) ` Returns an object of the same type as this object with an amount added. ` abstract long` ` https://developer.android.com/reference/java/time/temporal/Temporal#until(java.time.temporal.Temporal,%20java.time.temporal.TemporalUnit)(https://developer.android.com/reference/java/time/temporal/Temporal endExclusive, https://developer.android.com/reference/java/time/temporal/TemporalUnit unit) ` Calculates the amount of time until another temporal in terms of the specified unit. ` abstract https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#with(java.time.temporal.TemporalField,%20long)(https://developer.android.com/reference/java/time/temporal/TemporalField field, long newValue) ` Returns an object of the same type as this object with the specified field altered. ` default https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/Temporal#with(java.time.temporal.TemporalAdjuster)(https://developer.android.com/reference/java/time/temporal/TemporalAdjuster adjuster) ` Returns an adjusted object of the same type as this object with the adjustment made. From interface ` https://developer.android.com/reference/java/time/temporal/TemporalAdjuster ` ` abstract https://developer.android.com/reference/java/time/temporal/Temporal` ` https://developer.android.com/reference/java/time/temporal/TemporalAdjuster#adjustInto(java.time.temporal.Temporal)(https://developer.android.com/reference/java/time/temporal/Temporal temporal) ` Adjusts the specified temporal object. From interface ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor ` ` default int` ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor#get(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the value of the specified field as an `int`. ` abstract long` ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor#getLong(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the value of the specified field as a `long`. ` abstract boolean` ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor#isSupported(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Checks if the specified field is supported. ` default R` ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor#query(java.time.temporal.TemporalQuery)(https://developer.android.com/reference/java/time/temporal/TemporalQuery query) ` Queries this date-time. ` default https://developer.android.com/reference/java/time/temporal/ValueRange` ` https://developer.android.com/reference/java/time/temporal/TemporalAccessor#range(java.time.temporal.TemporalField)(https://developer.android.com/reference/java/time/temporal/TemporalField field) ` Gets the range of valid values for the specified field. ## Fields ### MAX Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final LocalTime MAX ``` The maximum supported `LocalTime`, '23:59:59.999999999'. This is the time just before midnight at the end of the day.
### MIDNIGHT Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final LocalTime MIDNIGHT ``` The time of midnight at the start of the day, '00:00'.
### MIN Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final LocalTime MIN ``` The minimum supported `LocalTime`, '00:00'. This is the time of midnight at the start of the day.
### NOON Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static final LocalTime NOON ``` The time of noon in the middle of the day, '12:00'.
## Public methods ### adjustInto Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public Temporal adjustInto (Temporal temporal) ``` Adjusts the specified temporal object to have the same time as this object. This returns a temporal object of the same observable type as the input with the time changed to be the same as this. The adjustment is equivalent to using `https://developer.android.com/reference/java/time/temporal/Temporal#with(java.time.temporal.TemporalField,%20long)` passing `https://developer.android.com/reference/java/time/temporal/ChronoField#NANO_OF_DAY` as the field. In most cases, it is clearer to reverse the calling pattern by using `https://developer.android.com/reference/java/time/temporal/Temporal#with(java.time.temporal.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.
| Parameters || |---|---| | `temporal` | `Temporal`: the target object to be adjusted, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/temporal/Temporal` | the adjusted object, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if unable to make the adjustment | ### atDate Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalDateTime atDate (LocalDate date) ``` Combines this time with a date to create a `LocalDateTime`. This returns a `LocalDateTime` formed from this time at the specified date. All possible combinations of date and time are valid.
| Parameters || |---|---| | `date` | `LocalDate`: the date to combine with, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalDateTime` | the local date-time formed from this time and the specified date, not null
| ### atOffset Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public OffsetTime atOffset (ZoneOffset offset) ``` Combines this time with an offset to create an `OffsetTime`. This returns an `OffsetTime` formed from this time at the specified offset. All possible combinations of time and offset are valid.
| Parameters || |---|---| | `offset` | `ZoneOffset`: the offset to combine with, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/OffsetTime` | the offset time formed from this time and the specified offset, not null
| ### compareTo Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int compareTo (LocalTime other) ``` 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 `https://developer.android.com/reference/java/lang/Comparable`.
| Parameters || |---|---| | `other` | `LocalTime`: the other time to compare to, not null
| | Returns || |---|---| | `int` | the comparator value, that is less than zero if this is before `other`, zero if they are equal, or greater than zero if this is after `other`
| **See also:** - `https://developer.android.com/reference/java/time/LocalTime#isBefore(java.time.LocalTime)` - `https://developer.android.com/reference/java/time/LocalTime#isAfter(java.time.LocalTime)` ### equals Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean equals (Object obj) ``` Checks if this time is equal to another time. The comparison is based on the time-line position of the time within a day. Only objects of type `LocalTime` are compared, other types return false. To compare the date of two `TemporalAccessor` instances, use `https://developer.android.com/reference/java/time/temporal/ChronoField#NANO_OF_DAY` as a comparator.
| Parameters || |---|---| | `obj` | `Object`: the object to check, null returns false
| | Returns || |---|---| | `boolean` | true if this is equal to the other time
| ### format Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String format (DateTimeFormatter formatter) ``` Formats this time using the specified formatter. This time will be passed to the formatter to produce a string.
| Parameters || |---|---| | `formatter` | `DateTimeFormatter`: the formatter to use, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/lang/String` | the formatted time string, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if an error occurs during printing | ### from Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime from (TemporalAccessor temporal) ``` Obtains an instance of `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 `https://developer.android.com/reference/java/time/temporal/TemporalQueries#localTime()` query, which relies on extracting the `https://developer.android.com/reference/java/time/temporal/ChronoField#NANO_OF_DAY` field. This method matches the signature of the functional interface `https://developer.android.com/reference/java/time/temporal/TemporalQuery` allowing it to be used as a query via method reference, `LocalTime::from`.
| Parameters || |---|---| | `temporal` | `TemporalAccessor`: the temporal object to convert, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if unable to convert to a `LocalTime` | ### get Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int get (TemporalField field) ``` Gets the value of the specified field from this time as an `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 `https://developer.android.com/reference/java/time/temporal/ChronoField` then the query is implemented here. The `https://developer.android.com/reference/java/time/LocalTime#isSupported(java.time.temporal.TemporalField)` 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 an `UnsupportedTemporalTypeException`. 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.
| Parameters || |---|---| | `field` | `TemporalField`: the field to get, not null
| | Returns || |---|---| | `int` | the value for the field
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if a value for the field cannot be obtained or the value is outside the range of valid values for the field | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the field is not supported or the range of values exceeds an `int` | ### getHour Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getHour () ``` Gets the hour-of-day field.
| Returns || |---|---| | `int` | the hour-of-day, from 0 to 23
| ### getLong Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public long getLong (TemporalField field) ``` Gets the value of the specified field from this time as a `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 `https://developer.android.com/reference/java/time/temporal/ChronoField` then the query is implemented here. The `https://developer.android.com/reference/java/time/LocalTime#isSupported(java.time.temporal.TemporalField)` 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.
| Parameters || |---|---| | `field` | `TemporalField`: the field to get, not null
| | Returns || |---|---| | `long` | the value for the field
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if a value for the field cannot be obtained | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the field is not supported | ### getMinute Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getMinute () ``` Gets the minute-of-hour field.
| Returns || |---|---| | `int` | the minute-of-hour, from 0 to 59
| ### getNano Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getNano () ``` Gets the nano-of-second field.
| Returns || |---|---| | `int` | the nano-of-second, from 0 to 999,999,999
| ### getSecond Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int getSecond () ``` Gets the second-of-minute field.
| Returns || |---|---| | `int` | the second-of-minute, from 0 to 59
| ### hashCode Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int hashCode () ``` A hash code for this time.
| Returns || |---|---| | `int` | a suitable hash code
| ### isAfter Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isAfter (LocalTime other) ``` Checks if this time is after the specified time. The comparison is based on the time-line position of the time within a day.
| Parameters || |---|---| | `other` | `LocalTime`: the other time to compare to, not null
| | Returns || |---|---| | `boolean` | true if this is after the specified time
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/NullPointerException` | if `other` is null | ### isBefore Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isBefore (LocalTime other) ``` Checks if this time is before the specified time. The comparison is based on the time-line position of the time within a day.
| Parameters || |---|---| | `other` | `LocalTime`: the other time to compare to, not null
| | Returns || |---|---| | `boolean` | true if this point is before the specified time
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/NullPointerException` | if `other` is null | ### isSupported Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isSupported (TemporalUnit unit) ``` 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 `https://developer.android.com/reference/java/time/LocalTime#plus(long,%20java.time.temporal.TemporalUnit)` and `https://developer.android.com/reference/java/time/LocalTime#minus(long,%20java.time.temporal.TemporalUnit)` methods will throw an exception. If the unit is a `https://developer.android.com/reference/java/time/temporal/ChronoUnit` then the query is implemented here. The supported units are: - `NANOS` - `MICROS` - `MILLIS` - `SECONDS` - `MINUTES` - `HOURS` - `HALF_DAYS` All other `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.
| Parameters || |---|---| | `unit` | `TemporalUnit`: the unit to check, null returns false
| | Returns || |---|---| | `boolean` | true if the unit can be added/subtracted, false if not
| ### isSupported Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public boolean isSupported (TemporalField field) ``` Checks if the specified field is supported. This checks if this time can be queried for the specified field. If false, then calling the `https://developer.android.com/reference/java/time/LocalTime#range(java.time.temporal.TemporalField)`, `https://developer.android.com/reference/java/time/LocalTime#get(java.time.temporal.TemporalField)` and `https://developer.android.com/reference/java/time/LocalTime#with(java.time.temporal.TemporalField,%20long)` methods will throw an exception. If the field is a `https://developer.android.com/reference/java/time/temporal/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` All other `ChronoField` instances will return false. If the field is not a `ChronoField`, then the result of this method is obtained by invoking `TemporalField.isSupportedBy(TemporalAccessor)` passing `this` as the argument. Whether the field is supported is determined by the field.
| Parameters || |---|---| | `field` | `TemporalField`: the field to check, null returns false
| | Returns || |---|---| | `boolean` | true if the field is supported on this time, false if not
| ### minus Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minus (TemporalAmount amountToSubtract) ``` Returns a copy of this time with the specified amount subtracted. This returns a `LocalTime`, based on this one, with the specified amount subtracted. The amount is typically `https://developer.android.com/reference/java/time/Duration` but may be any other type implementing the `https://developer.android.com/reference/java/time/temporal/TemporalAmount` interface. The calculation is delegated to the amount object by calling `https://developer.android.com/reference/java/time/temporal/TemporalAmount#subtractFrom(java.time.temporal.Temporal)`. The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to `https://developer.android.com/reference/java/time/LocalTime#minus(long,%20java.time.temporal.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.
| Parameters || |---|---| | `amountToSubtract` | `TemporalAmount`: the amount to subtract, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the subtraction made, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the subtraction cannot be made | ### minus Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minus (long amountToSubtract, TemporalUnit unit) ``` Returns a copy of this time with the specified amount subtracted. 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 `https://developer.android.com/reference/java/time/LocalTime#plus(long,%20java.time.temporal.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.
| Parameters || |---|---| | `amountToSubtract` | `long`: the amount of the unit to subtract from the result, may be negative
| | `unit` | `TemporalUnit`: the unit of the amount to subtract, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the specified amount subtracted, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the subtraction cannot be made | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the unit is not supported | ### minusHours Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minusHours (long hoursToSubtract) ``` Returns a copy of this `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.
| Parameters || |---|---| | `hoursToSubtract` | `long`: the hours to subtract, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the hours subtracted, not null
| ### minusMinutes Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minusMinutes (long minutesToSubtract) ``` Returns a copy of this `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.
| Parameters || |---|---| | `minutesToSubtract` | `long`: the minutes to subtract, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the minutes subtracted, not null
| ### minusNanos Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minusNanos (long nanosToSubtract) ``` Returns a copy of this `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.
| Parameters || |---|---| | `nanosToSubtract` | `long`: the nanos to subtract, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the nanoseconds subtracted, not null
| ### minusSeconds Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime minusSeconds (long secondsToSubtract) ``` Returns a copy of this `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.
| Parameters || |---|---| | `secondsToSubtract` | `long`: the seconds to subtract, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the seconds subtracted, not null
| ### now Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime now (ZoneId zone) ``` Obtains the current time from the system clock in the specified time-zone. This will query the `https://developer.android.com/reference/java/time/Clock#system(java.time.ZoneId)` 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.
| Parameters || |---|---| | `zone` | `ZoneId`: the zone ID to use, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the current time using the system clock, not null
| ### now Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime now () ``` Obtains the current time from the system clock in the default time-zone. This will query the `https://developer.android.com/reference/java/time/Clock#systemDefaultZone()` 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.
| Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the current time using the system clock and default time-zone, not null
| ### now Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime now (Clock clock) ``` 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 `https://developer.android.com/reference/java/time/Clock`.
| Parameters || |---|---| | `clock` | `Clock`: the clock to use, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the current time, not null
| ### of Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime of (int hour, int minute, int second) ``` Obtains an instance of `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.
| Parameters || |---|---| | `hour` | `int`: the hour-of-day to represent, from 0 to 23
| | `minute` | `int`: the minute-of-hour to represent, from 0 to 59
| | `second` | `int`: the second-of-minute to represent, from 0 to 59
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the value of any field is out of range | ### of Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime of (int hour, int minute, int second, int nanoOfSecond) ``` Obtains an instance of `LocalTime` from an hour, minute, second and nanosecond. This returns a `LocalTime` with the specified hour, minute, second and nanosecond.
| Parameters || |---|---| | `hour` | `int`: the hour-of-day to represent, from 0 to 23
| | `minute` | `int`: the minute-of-hour to represent, from 0 to 59
| | `second` | `int`: the second-of-minute to represent, from 0 to 59
| | `nanoOfSecond` | `int`: the nano-of-second to represent, from 0 to 999,999,999
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the value of any field is out of range | ### of Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime of (int hour, int minute) ``` Obtains an instance of `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.
| Parameters || |---|---| | `hour` | `int`: the hour-of-day to represent, from 0 to 23
| | `minute` | `int`: the minute-of-hour to represent, from 0 to 59
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the value of any field is out of range | ### ofInstant Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime ofInstant (Instant instant, ZoneId zone) ``` Obtains an instance of `LocalTime` from an `Instant` and zone ID. This creates a local time based on the specified instant. First, the offset from UTC/Greenwich is obtained using the zone ID and instant, which is simple as there is only one valid offset for each instant. Then, the instant and offset are used to calculate the local time.
| Parameters || |---|---| | `instant` | `Instant`: the instant to create the time from, not null
| | `zone` | `ZoneId`: the time-zone, which may be an offset, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| ### ofNanoOfDay Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime ofNanoOfDay (long nanoOfDay) ``` Obtains an instance of `LocalTime` from a nanos-of-day value. This returns a `LocalTime` with the specified nanosecond-of-day.
| Parameters || |---|---| | `nanoOfDay` | `long`: the nano of day, from `0` to `24 * 60 * 60 * 1,000,000,000 - 1`
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the nanos of day value is invalid | ### ofSecondOfDay Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime ofSecondOfDay (long secondOfDay) ``` Obtains an instance of `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.
| Parameters || |---|---| | `secondOfDay` | `long`: the second-of-day, from `0` to `24 * 60 * 60 - 1`
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the second-of-day value is invalid | ### parse Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime parse (CharSequence text, DateTimeFormatter formatter) ``` Obtains an instance of `LocalTime` from a text string using a specific formatter. The text is parsed using the formatter, returning a time.
| Parameters || |---|---| | `text` | `CharSequence`: the text to parse, not null
| | `formatter` | `DateTimeFormatter`: the formatter to use, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the parsed local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/format/DateTimeParseException` | if the text cannot be parsed | ### parse Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public static LocalTime parse (CharSequence text) ``` Obtains an instance of `LocalTime` from a text string such as `10:15`. The string must represent a valid time and is parsed using `https://developer.android.com/reference/java/time/format/DateTimeFormatter#ISO_LOCAL_TIME`.
| Parameters || |---|---| | `text` | `CharSequence`: the text to parse such as "10:15:30", not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | the parsed local time, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/format/DateTimeParseException` | if the text cannot be parsed | ### plus Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plus (TemporalAmount amountToAdd) ``` Returns a copy of this time with the specified amount added. This returns a `LocalTime`, based on this one, with the specified amount added. The amount is typically `https://developer.android.com/reference/java/time/Duration` but may be any other type implementing the `https://developer.android.com/reference/java/time/temporal/TemporalAmount` interface. The calculation is delegated to the amount object by calling `https://developer.android.com/reference/java/time/temporal/TemporalAmount#addTo(java.time.temporal.Temporal)`. The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to `https://developer.android.com/reference/java/time/LocalTime#plus(long,%20java.time.temporal.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.
| Parameters || |---|---| | `amountToAdd` | `TemporalAmount`: the amount to add, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the addition made, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the addition cannot be made | ### plus Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plus (long amountToAdd, TemporalUnit unit) ``` Returns a copy of this time with the specified amount added. 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 `https://developer.android.com/reference/java/time/temporal/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 `https://developer.android.com/reference/java/time/LocalTime#plusNanos(long)`. - `MICROS` - Returns a `LocalTime` with the specified number of microseconds added. This is equivalent to `https://developer.android.com/reference/java/time/LocalTime#plusNanos(long)` with the amount multiplied by 1,000. - `MILLIS` - Returns a `LocalTime` with the specified number of milliseconds added. This is equivalent to `https://developer.android.com/reference/java/time/LocalTime#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 `https://developer.android.com/reference/java/time/LocalTime#plusSeconds(long)`. - `MINUTES` - Returns a `LocalTime` with the specified number of minutes added. This is equivalent to `https://developer.android.com/reference/java/time/LocalTime#plusMinutes(long)`. - `HOURS` - Returns a `LocalTime` with the specified number of hours added. This is equivalent to `https://developer.android.com/reference/java/time/LocalTime#plusHours(long)`. - `HALF_DAYS` - Returns a `LocalTime` with the specified number of half-days added. This is equivalent to `https://developer.android.com/reference/java/time/LocalTime#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.
| Parameters || |---|---| | `amountToAdd` | `long`: the amount of the unit to add to the result, may be negative
| | `unit` | `TemporalUnit`: the unit of the amount to add, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the specified amount added, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the addition cannot be made | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the unit is not supported | ### plusHours Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plusHours (long hoursToAdd) ``` Returns a copy of this `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.
| Parameters || |---|---| | `hoursToAdd` | `long`: the hours to add, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the hours added, not null
| ### plusMinutes Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plusMinutes (long minutesToAdd) ``` Returns a copy of this `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.
| Parameters || |---|---| | `minutesToAdd` | `long`: the minutes to add, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the minutes added, not null
| ### plusNanos Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plusNanos (long nanosToAdd) ``` Returns a copy of this `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.
| Parameters || |---|---| | `nanosToAdd` | `long`: the nanos to add, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the nanoseconds added, not null
| ### plusSeconds Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime plusSeconds (long secondstoAdd) ``` Returns a copy of this `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.
| Parameters || |---|---| | `secondstoAdd` | `long`: the seconds to add, may be negative
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the seconds added, not null
| ### query Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public R query (TemporalQuery query) ``` Queries this time using the specified query. This queries this time using the specified query strategy object. The `TemporalQuery` object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be. The result of this method is obtained by invoking the `https://developer.android.com/reference/java/time/temporal/TemporalQuery#queryFrom(java.time.temporal.TemporalAccessor)` method on the specified query passing `this` as the argument.
| Parameters || |---|---| | `query` | `TemporalQuery`: the query to invoke, not null
| | Returns || |---|---| | `R` | the query result, null may be returned (defined by the query)
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs (defined by the query) | | `https://developer.android.com/reference/java/time/DateTimeException` | if unable to query (defined by the query) | ### range Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public ValueRange range (TemporalField field) ``` 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 `https://developer.android.com/reference/java/time/temporal/ChronoField` then the query is implemented here. The `https://developer.android.com/reference/java/time/LocalTime#isSupported(java.time.temporal.TemporalField)` 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.
| Parameters || |---|---| | `field` | `TemporalField`: the field to query the range for, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/temporal/ValueRange` | the range of valid values for the field, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the range for the field cannot be obtained | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the field is not supported | ### toEpochSecond Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public long toEpochSecond (LocalDate date, ZoneOffset offset) ``` Converts this `LocalTime` to the number of seconds since the epoch of 1970-01-01T00:00:00Z. This combines this local time with the specified date and offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.
| Parameters || |---|---| | `date` | `LocalDate`: the local date, not null
| | `offset` | `ZoneOffset`: the zone offset, not null
| | Returns || |---|---| | `long` | the number of seconds since the epoch of 1970-01-01T00:00:00Z, may be negative
| ### toNanoOfDay Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public long toNanoOfDay () ``` Extracts the time as nanos of day, from `0` to `24 * 60 * 60 * 1,000,000,000 - 1`.
| Returns || |---|---| | `long` | the nano of day equivalent to this time
| ### toSecondOfDay Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public int toSecondOfDay () ``` Extracts the time as seconds of day, from `0` to `24 * 60 * 60 - 1`.
| Returns || |---|---| | `int` | the second-of-day equivalent to this time
| ### toString Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public String toString () ``` Outputs this time as a `String`, such as `10:15`. The output will be one of the following ISO-8601 formats: - `HH:mm` - `HH:mm:ss` - `HH:mm:ss.SSS` - `HH:mm:ss.SSSSSS` - `HH:mm:ss.SSSSSSSSS` The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.

| Returns || |---|---| | `https://developer.android.com/reference/java/lang/String` | a string representation of this time, not null
| ### truncatedTo Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime truncatedTo (TemporalUnit unit) ``` Returns a copy of this `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 `https://developer.android.com/reference/java/time/temporal/ChronoUnit#MINUTES` unit will set the second-of-minute and nano-of-second field to zero. The unit must have a [duration](https://developer.android.com/reference/java/time/temporal/TemporalUnit#getDuration()) that divides into the length of a standard day without remainder. This includes all supplied time units on `https://developer.android.com/reference/java/time/temporal/ChronoUnit` and `https://developer.android.com/reference/java/time/temporal/ChronoUnit#DAYS`. Other units throw an exception. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `unit` | `TemporalUnit`: the unit to truncate to, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the time truncated, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if unable to truncate | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the unit is not supported | ### until Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public long until (Temporal endExclusive, TemporalUnit unit) ``` Calculates the amount of time until another time in terms of the specified 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 `https://developer.android.com/reference/java/time/LocalTime#from(java.time.temporal.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 `https://developer.android.com/reference/java/time/temporal/TemporalUnit#between(java.time.temporal.Temporal,%20java.time.temporal.Temporal)`: ``` // 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 `https://developer.android.com/reference/java/time/temporal/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.
| Parameters || |---|---| | `endExclusive` | `Temporal`: the end time, exclusive, which is converted to a `LocalTime`, not null
| | `unit` | `TemporalUnit`: the unit to measure the amount in, not null
| | Returns || |---|---| | `long` | the amount of time between this time and the end time
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the amount cannot be calculated, or the end temporal cannot be converted to a `LocalTime` | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the unit is not supported | ### with Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime with (TemporalField field, long newValue) ``` Returns a copy of this time with the specified field set to a new value. 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 `https://developer.android.com/reference/java/time/temporal/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 `https://developer.android.com/reference/java/time/LocalTime#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 `https://developer.android.com/reference/java/time/LocalTime#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 `https://developer.android.com/reference/java/time/LocalTime#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.
| Parameters || |---|---| | `field` | `TemporalField`: the field to set in the result, not null
| | `newValue` | `long`: the new value of the field in the result
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on `this` with the specified field set, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the field cannot be set | | `https://developer.android.com/reference/java/time/temporal/UnsupportedTemporalTypeException` | if the field is not supported | ### with Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime with (TemporalAdjuster adjuster) ``` Returns an adjusted copy of this time. 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 `https://developer.android.com/reference/java/time/temporal/TemporalAdjuster#adjustInto(java.time.temporal.Temporal)` method on the specified adjuster passing `this` as the argument. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `adjuster` | `TemporalAdjuster`: the adjuster to use, not null
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on `this` with the adjustment made, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/lang/ArithmeticException` | if numeric overflow occurs | | `https://developer.android.com/reference/java/time/DateTimeException` | if the adjustment cannot be made | ### withHour Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime withHour (int hour) ``` Returns a copy of this `LocalTime` with the hour-of-day altered. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `hour` | `int`: the hour-of-day to set in the result, from 0 to 23
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the requested hour, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the hour value is invalid | ### withMinute Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime withMinute (int minute) ``` Returns a copy of this `LocalTime` with the minute-of-hour altered. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `minute` | `int`: the minute-of-hour to set in the result, from 0 to 59
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the requested minute, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the minute value is invalid | ### withNano Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime withNano (int nanoOfSecond) ``` Returns a copy of this `LocalTime` with the nano-of-second altered. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `nanoOfSecond` | `int`: the nano-of-second to set in the result, from 0 to 999,999,999
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the requested nanosecond, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the nanos value is invalid | ### withSecond Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) ``` public LocalTime withSecond (int second) ``` Returns a copy of this `LocalTime` with the second-of-minute altered. This instance is immutable and unaffected by this method call.
| Parameters || |---|---| | `second` | `int`: the second-of-minute to set in the result, from 0 to 59
| | Returns || |---|---| | `https://developer.android.com/reference/java/time/LocalTime` | a `LocalTime` based on this time with the requested second, not null
| | Throws || |---|---| | `https://developer.android.com/reference/java/time/DateTimeException` | if the second value is invalid |