LocalTime
Related Docs:
object LocalTime
| package bp
Constructor, previously validated.
Constructor, previously validated.
the hour-of-day to represent, validated from 0 to 23
the minute-of-hour to represent, validated from 0 to 59
the second-of-minute to represent, validated from 0 to 59
the nano-of-second to represent, validated from 0 to 999,999,999
Adjusts the specified temporal object to have the same time as this object.
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 long)
passing ChronoField#NANO_OF_DAY as the field.
In most cases, it is clearer to reverse the calling pattern by using
Temporal#with(TemporalAdjuster):
// these two lines are equivalent, but the second approach is recommended temporal = thisLocalTime.adjustInto(temporal); temporal = temporal.with(thisLocalTime);
This instance is immutable and unaffected by this method call.
the target object to be adjusted, not null
the adjusted object, not null
ArithmeticException if numeric overflow occurs
DateTimeException if unable to make the adjustment
Combines this time with a date to create a LocalDateTime.
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.
the date to combine with, not null
the local date-time formed from this time and the specified date, not null
Combines this time with an offset to create an OffsetTime.
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.
the offset to combine with, not null
the offset time formed from this time and the specified offset, not null
Compares this LocalTime to another time.
Compares this LocalTime to another time.
The comparison is based on the time-line position of the local times within a day.
It is "consistent with equals", as defined by Comparable.
the other time to compare to, not null
the comparator value, negative if less, positive if greater
NullPointerException if { @code other} is null
Checks if this time is equal to another time.
Checks if this time is equal to another time.
The comparison is based on the time-line position of the time within a day.
Only objects of type LocalTime are compared, other types return false.
To compare the date of two TemporalAccessor instances, use
ChronoField#NANO_OF_DAY as a comparator.
the object to check, null returns false
true if this is equal to the other time
Outputs this time as a String using the formatter.
Outputs this time as a String using the formatter.
This time will be passed to the formatter
print method.
the formatter to use, not null
the formatted time string, not null
DateTimeException if an error occurs during printing
Gets the value of the specified field from this time as an int.
Gets the value of the specified field from this time as an int.
This queries this time for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here.
The supported fields will return valid
values based on this time, except NANO_OF_DAY and MICRO_OF_DAY
which are too large to fit in an int and throw a DateTimeException.
All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
the field to get, not null
the value for the field
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
Gets the hour-of-day field.
Gets the hour-of-day field.
the hour-of-day, from 0 to 23
Gets the value of the specified field from this time as a long.
Gets the value of the specified field from this time as a long.
This queries this time for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here.
The supported fields will return valid
values based on this time.
All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
the field to get, not null
the value for the field
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
Gets the minute-of-hour field.
Gets the minute-of-hour field.
the minute-of-hour, from 0 to 59
Gets the nano-of-second field.
Gets the nano-of-second field.
the nano-of-second, from 0 to 999,999,999
Gets the second-of-minute field.
Gets the second-of-minute field.
the second-of-minute, from 0 to 59
A hash code for this time.
Checks if this LocalTime is after the specified time.
Checks if this LocalTime is after the specified time.
The comparison is based on the time-line position of the time within a day.
the other time to compare to, not null
true if this is after the specified time
NullPointerException if { @code other} is null
Checks if this LocalTime is before the specified time.
Checks if this LocalTime is before the specified time.
The comparison is based on the time-line position of the time within a day.
the other time to compare to, not null
true if this point is before the specified time
NullPointerException if { @code other} is null
Checks if the specified unit is supported.
Checks if the specified unit is supported.
This checks if the date-time can be queried for the specified unit.
If false, then calling the plus and minus
methods will throw an exception.
Implementations must check and handle all fields defined in ChronoUnit.
If the field is supported, then true is returned, otherwise false
If the field is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this as the argument.
Implementations must not alter this object.
the unit to check, null returns false
true if this date-time can be queried for the unit, false if not
Checks if the specified field is supported.
Checks if the specified field is supported.
This checks if this time can be queried for the specified field.
If false, then calling the range and
get methods will throw an exception.
If the field is a ChronoField then the query is implemented here.
The supported fields are:
NANO_OF_SECONDNANO_OF_DAYMICRO_OF_SECONDMICRO_OF_DAYMILLI_OF_SECONDMILLI_OF_DAYSECOND_OF_MINUTESECOND_OF_DAYMINUTE_OF_HOURMINUTE_OF_DAYHOUR_OF_AMPMCLOCK_HOUR_OF_AMPMHOUR_OF_DAYCLOCK_HOUR_OF_DAYAMPM_OF_DAYAll 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.
the field to check, null returns false
true if the field is supported on this time, false if not
Returns a copy of this time with the specified period subtracted.
Returns a copy of this time with the specified period subtracted.
This method returns a new time based on this time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.
This instance is immutable and unaffected by this method call.
the amount of the unit to subtract from the result, may be negative
the unit of the period to subtract, not null
a { @code LocalTime} based on this time with the specified period subtracted, not null
DateTimeException if the unit cannot be added to this type
Returns a copy of this time with the specified period subtracted.
Returns a copy of this time with the specified period subtracted.
This method returns a new time based on this time with the specified period subtracted.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the specified adjuster, which typically calls
back to TemporalUnit).
This instance is immutable and unaffected by this method call.
the amount to subtract, not null
a { @code LocalTime} based on this time with the subtraction made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the subtraction cannot be made
Returns a copy of this LocalTime with the specified period in hours subtracted.
Returns a copy of this LocalTime with the specified period in hours subtracted.
This subtracts the specified number of hours from this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the hours to subtract, may be negative
a { @code LocalTime} based on this time with the hours subtracted, not null
Returns a copy of this LocalTime with the specified period in minutes subtracted.
Returns a copy of this LocalTime with the specified period in minutes subtracted.
This subtracts the specified number of minutes from this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the minutes to subtract, may be negative
a { @code LocalTime} based on this time with the minutes subtracted, not null
Returns a copy of this LocalTime with the specified period in nanoseconds subtracted.
Returns a copy of this LocalTime with the specified period in nanoseconds subtracted.
This subtracts the specified number of nanoseconds from this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the nanos to subtract, may be negative
a { @code LocalTime} based on this time with the nanoseconds subtracted, not null
Returns a copy of this LocalTime with the specified period in seconds subtracted.
Returns a copy of this LocalTime with the specified period in seconds subtracted.
This subtracts the specified number of seconds from this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the seconds to subtract, may be negative
a { @code LocalTime} based on this time with the seconds subtracted, not null
Returns a copy of this time with the specified period added.
Returns a copy of this time with the specified period added.
This method returns a new time based on this time with the specified period added. This can be used to add any period that is defined by a unit, for example to add hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.
This instance is immutable and unaffected by this method call.
the amount of the unit to add to the result, may be negative
the unit of the period to add, not null
a { @code LocalTime} based on this time with the specified period added, not null
DateTimeException if the unit cannot be added to this type
Returns a copy of this date with the specified period added.
Returns a copy of this date with the specified period added.
This method returns a new time based on this time with the specified period added.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the specified adjuster, which typically calls
back to TemporalUnit).
This instance is immutable and unaffected by this method call.
the amount to add, not null
a { @code LocalTime} based on this time with the addition made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the addition cannot be made
Returns a copy of this LocalTime with the specified period in hours added.
Returns a copy of this LocalTime with the specified period in hours added.
This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the hours to add, may be negative
a { @code LocalTime} based on this time with the hours added, not null
Returns a copy of this LocalTime with the specified period in minutes added.
Returns a copy of this LocalTime with the specified period in minutes added.
This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the minutes to add, may be negative
a { @code LocalTime} based on this time with the minutes added, not null
Returns a copy of this LocalTime with the specified period in nanoseconds added.
Returns a copy of this LocalTime with the specified period in nanoseconds added.
This adds the specified number of nanoseconds to this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the nanos to add, may be negative
a { @code LocalTime} based on this time with the nanoseconds added, not null
Returns a copy of this LocalTime with the specified period in seconds added.
Returns a copy of this LocalTime with the specified period in seconds added.
This adds the specified number of seconds to this time, returning a new time. The calculation wraps around midnight.
This instance is immutable and unaffected by this method call.
the seconds to add, may be negative
a { @code LocalTime} based on this time with the seconds added, not null
Queries this time using the specified 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
TemporalQuery#queryFrom(TemporalAccessor) method on the
specified query passing this as the argument.
the type of the result
the query to invoke, not null
the query result, null may be returned (defined by the query)
ArithmeticException if numeric overflow occurs (defined by the query)
DateTimeException if unable to query (defined by the query)
Gets the range of valid values for the specified 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 ChronoField then the query is implemented here.
The supported fields will return
appropriate range instances.
All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor)
passing this as the argument.
Whether the range can be obtained is determined by the field.
the field to query the range for, not null
the range of valid values for the field, not null
DateTimeException if the range for the field cannot be obtained
Extracts the time as nanos of day,
from 0 to 24 * 60 * 60 * 1,000,000,000 - 1.
Extracts the time as nanos of day,
from 0 to 24 * 60 * 60 * 1,000,000,000 - 1.
the nano of day equivalent to this time
Extracts the time as seconds of day,
from 0 to 24 * 60 * 60 - 1.
Extracts the time as seconds of day,
from 0 to 24 * 60 * 60 - 1.
the second-of-day equivalent to this time
Outputs this time as a String, such as 10:15.
Outputs this time as a 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.SSSSSSSSSThe format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.
a string representation of this time, not null
Returns a copy of this LocalTime with the time truncated.
Returns a copy of this LocalTime with the time truncated.
Truncating the time returns a copy of the original time with fields
smaller than the specified unit set to zero.
For example, truncating with the 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.
the unit to truncate to, not null
a { @code LocalTime} based on this time with the time truncated, not null
DateTimeException if unable to truncate
Calculates the period between this time and another time in terms of the specified unit.
Calculates the period between this time and another time in terms of the specified unit.
This calculates the period between two times in terms of a single unit.
The start and end points are this and the specified time.
The result will be negative if the end is before the start.
The Temporal passed to this method must be a LocalTime.
For example, the period in hours between two times can be calculated
using startTime.until(endTime, HOURS).
The calculation returns a whole number, representing the number of complete units between the two times. For example, the period in hours between 11:30 and 13:29 will only be one hour as it is one minute short of two hours.
This method operates in association with TemporalUnit#between.
The result of this method is a long representing the amount of
the specified unit. By contrast, the result of between is an
object that can be used directly in addition/subtraction:
long period = start.until(end, HOURS); // this method dateTime.plus(HOURS.between(start, end)); // use in plus/minus
The calculation is implemented in this method for ChronoUnit.
The units NANOS, MICROS, MILLIS, SECONDS,
MINUTES, HOURS and HALF_DAYS are supported.
Other ChronoUnit values will throw an exception.
If the unit is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.between(Temporal, Temporal)
passing this as the first argument and the input temporal as
the second argument.
This instance is immutable and unaffected by this method call.
the end time, which is converted to a { @code LocalTime}, not null
the unit to measure the period in, not null
the amount of the period between this time and the end time
ArithmeticException if numeric overflow occurs
DateTimeException if the period cannot be calculated
Returns a copy of this time with the specified field set to a new value.
Returns a copy of this time with the specified field set to a new value.
This returns a new LocalTime, based on this one, with the value
for the specified field changed.
This can be used to change any supported field, such as the hour, minute or second.
If it is not possible to set the value, because the field is not supported or for
some other reason, an exception is thrown.
If the field is a ChronoField then the adjustment is implemented here.
The supported fields behave as follows:
NANO_OF_SECOND -
Returns a LocalTime with the specified nano-of-second.
The hour, minute and second will be unchanged.NANO_OF_DAY -
Returns a LocalTime with the specified nano-of-day.
This completely replaces the time and is equivalent to #ofNanoOfDay(long).MICRO_OF_SECOND -
Returns a LocalTime with the nano-of-second replaced by the specified
micro-of-second multiplied by 1,000.
The hour, minute and second will be unchanged.MICRO_OF_DAY -
Returns a LocalTime with the specified micro-of-day.
This completely replaces the time and is equivalent to using #ofNanoOfDay(long)
with the micro-of-day multiplied by 1,000.MILLI_OF_SECOND -
Returns a LocalTime with the nano-of-second replaced by the specified
milli-of-second multiplied by 1,000,000.
The hour, minute and second will be unchanged.MILLI_OF_DAY -
Returns a LocalTime with the specified milli-of-day.
This completely replaces the time and is equivalent to using #ofNanoOfDay(long)
with the milli-of-day multiplied by 1,000,000.SECOND_OF_MINUTE -
Returns a LocalTime with the specified second-of-minute.
The hour, minute and nano-of-second will be unchanged.SECOND_OF_DAY -
Returns a LocalTime with the specified second-of-day.
The nano-of-second will be unchanged.MINUTE_OF_HOUR -
Returns a LocalTime with the specified minute-of-hour.
The hour, second-of-minute and nano-of-second will be unchanged.MINUTE_OF_DAY -
Returns a LocalTime with the specified minute-of-day.
The second-of-minute and nano-of-second will be unchanged.HOUR_OF_AMPM -
Returns a LocalTime with the specified hour-of-am-pm.
The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.CLOCK_HOUR_OF_AMPM -
Returns a LocalTime with the specified clock-hour-of-am-pm.
The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.HOUR_OF_DAY -
Returns a LocalTime with the specified hour-of-day.
The minute-of-hour, second-of-minute and nano-of-second will be unchanged.CLOCK_HOUR_OF_DAY -
Returns a LocalTime with the specified clock-hour-of-day.
The minute-of-hour, second-of-minute and nano-of-second will be unchanged.AMPM_OF_DAY -
Returns a LocalTime with the specified AM/PM.
The hour-of-am-pm, minute-of-hour, second-of-minute and nano-of-second will be unchanged.In all cases, if the new value is outside the valid range of values for the field
then a DateTimeException will be thrown.
All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.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.
the field to set in the result, not null
the new value of the field in the result
a { @code LocalTime} based on { @code this} with the specified field set, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the field cannot be set
Returns an adjusted copy of this time.
Returns an adjusted copy of this time.
This returns a new LocalTime, based on this one, with the time adjusted.
The adjustment takes place using the specified adjuster strategy object.
Read the documentation of the adjuster to understand what adjustment will be made.
A simple adjuster might simply set the one of the fields, such as the hour field. A more complex adjuster might set the time to the last hour of the day.
The result of this method is obtained by invoking the
TemporalAdjuster#adjustInto(Temporal) method on the
specified adjuster passing this as the argument.
This instance is immutable and unaffected by this method call.
the adjuster to use, not null
a { @code LocalTime} based on { @code this} with the adjustment made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the adjustment cannot be made
Returns a copy of this LocalTime with the hour-of-day value altered.
Returns a copy of this LocalTime with the hour-of-day value altered.
This instance is immutable and unaffected by this method call.
the hour-of-day to set in the result, from 0 to 23
a { @code LocalTime} based on this time with the requested hour, not null
DateTimeException if the hour value is invalid
Returns a copy of this LocalTime with the minute-of-hour value altered.
Returns a copy of this LocalTime with the minute-of-hour value altered.
This instance is immutable and unaffected by this method call.
the minute-of-hour to set in the result, from 0 to 59
a { @code LocalTime} based on this time with the requested minute, not null
DateTimeException if the minute value is invalid
Returns a copy of this LocalTime with the nano-of-second value altered.
Returns a copy of this LocalTime with the nano-of-second value altered.
This instance is immutable and unaffected by this method call.
the nano-of-second to set in the result, from 0 to 999,999,999
a { @code LocalTime} based on this time with the requested nanosecond, not null
DateTimeException if the nanos value is invalid
Returns a copy of this LocalTime with the second-of-minute value altered.
Returns a copy of this LocalTime with the second-of-minute value altered.
This instance is immutable and unaffected by this method call.
the second-of-minute to set in the result, from 0 to 59
a { @code LocalTime} based on this time with the requested second, not null
DateTimeException if the second value is invalid
A time without time-zone in the ISO-8601 calendar system, such as
10:15:30.LocalTimeis 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 aLocalTime.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.
Specification for implementors
This class is immutable and thread-safe.