Serializable
, Comparable<OffsetTime>
, Temporal
, TemporalAccessor
, TemporalAdjuster
public final class OffsetTime extends Object implements Temporal, TemporalAdjuster, Comparable<OffsetTime>, Serializable
10:15:30+01:00
. OffsetTime
is an immutable date-time object that represents a time, often viewed as hour-minute-second-offset. This class stores all time fields, to a precision of nanoseconds, as well as a zone offset. For example, the value "13:45:30.123456789+02:00" can be stored in an OffsetTime
.
This is a value-based class; programmers should treat instances that are equal 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.
Modifier and Type | Field | Description |
---|---|---|
static final OffsetTime |
MAX |
The maximum supported OffsetTime , '23:59:59.999999999-18:00'. |
static final OffsetTime |
MIN |
The minimum supported OffsetTime , '00:00:00+18:00'. |
Modifier and Type | Method | Description |
---|---|---|
Temporal |
adjustInto |
Adjusts the specified temporal object to have the same offset and time as this object. |
OffsetDateTime |
atDate |
Combines this time with a date to create an OffsetDateTime . |
int |
compareTo |
Compares this OffsetTime to another time. |
boolean |
equals |
Checks if this time is equal to another time. |
String |
format |
Formats this time using the specified formatter. |
static OffsetTime |
from |
Obtains an instance of OffsetTime from a temporal object. |
int |
get |
Gets the value of the specified field from this time as an int . |
int |
getHour() |
Gets the hour-of-day field. |
long |
getLong |
Gets the value of the specified field from this time as a long . |
int |
getMinute() |
Gets the minute-of-hour field. |
int |
getNano() |
Gets the nano-of-second field. |
ZoneOffset |
getOffset() |
Gets the zone offset, such as '+01:00'. |
int |
getSecond() |
Gets the second-of-minute field. |
int |
hashCode() |
A hash code for this time. |
boolean |
isAfter |
Checks if the instant of this OffsetTime is after that of the specified time applying both times to a common date. |
boolean |
isBefore |
Checks if the instant of this OffsetTime is before that of the specified time applying both times to a common date. |
boolean |
isEqual |
Checks if the instant of this OffsetTime is equal to that of the specified time applying both times to a common date. |
boolean |
isSupported |
Checks if the specified field is supported. |
boolean |
isSupported |
Checks if the specified unit is supported. |
OffsetTime |
minus |
Returns a copy of this time with the specified amount subtracted. |
OffsetTime |
minus |
Returns a copy of this time with the specified amount subtracted. |
OffsetTime |
minusHours |
Returns a copy of this OffsetTime with the specified number of hours subtracted. |
OffsetTime |
minusMinutes |
Returns a copy of this OffsetTime with the specified number of minutes subtracted. |
OffsetTime |
minusNanos |
Returns a copy of this OffsetTime with the specified number of nanoseconds subtracted. |
OffsetTime |
minusSeconds |
Returns a copy of this OffsetTime with the specified number of seconds subtracted. |
static OffsetTime |
now() |
Obtains the current time from the system clock in the default time-zone. |
static OffsetTime |
now |
Obtains the current time from the specified clock. |
static OffsetTime |
now |
Obtains the current time from the system clock in the specified time-zone. |
static OffsetTime |
of |
Obtains an instance of OffsetTime from an hour, minute, second and nanosecond. |
static OffsetTime |
of |
Obtains an instance of OffsetTime from a local time and an offset. |
static OffsetTime |
ofInstant |
Obtains an instance of OffsetTime from an Instant and zone ID. |
static OffsetTime |
parse |
Obtains an instance of OffsetTime from a text string such as 10:15:30+01:00 . |
static OffsetTime |
parse |
Obtains an instance of OffsetTime from a text string using a specific formatter. |
OffsetTime |
plus |
Returns a copy of this time with the specified amount added. |
OffsetTime |
plus |
Returns a copy of this time with the specified amount added. |
OffsetTime |
plusHours |
Returns a copy of this OffsetTime with the specified number of hours added. |
OffsetTime |
plusMinutes |
Returns a copy of this OffsetTime with the specified number of minutes added. |
OffsetTime |
plusNanos |
Returns a copy of this OffsetTime with the specified number of nanoseconds added. |
OffsetTime |
plusSeconds |
Returns a copy of this OffsetTime with the specified number of seconds added. |
<R> R |
query |
Queries this time using the specified query. |
ValueRange |
range |
Gets the range of valid values for the specified field. |
long |
toEpochSecond |
Converts this OffsetTime to the number of seconds since the epoch of 1970-01-01T00:00:00Z. |
LocalTime |
toLocalTime() |
Gets the LocalTime part of this date-time. |
String |
toString() |
Outputs this time as a String , such as 10:15:30+01:00 . |
OffsetTime |
truncatedTo |
Returns a copy of this OffsetTime with the time truncated. |
long |
until |
Calculates the amount of time until another time in terms of the specified unit. |
OffsetTime |
with |
Returns an adjusted copy of this time. |
OffsetTime |
with |
Returns a copy of this time with the specified field set to a new value. |
OffsetTime |
withHour |
Returns a copy of this OffsetTime with the hour-of-day altered. |
OffsetTime |
withMinute |
Returns a copy of this OffsetTime with the minute-of-hour altered. |
OffsetTime |
withNano |
Returns a copy of this OffsetTime with the nano-of-second altered. |
OffsetTime |
withOffsetSameInstant |
Returns a copy of this OffsetTime with the specified offset ensuring that the result is at the same instant on an implied day. |
OffsetTime |
withOffsetSameLocal |
Returns a copy of this OffsetTime with the specified offset ensuring that the result has the same local time. |
OffsetTime |
withSecond |
Returns a copy of this OffsetTime with the second-of-minute altered. |
public static final OffsetTime MIN
OffsetTime
, '00:00:00+18:00'. This is the time of midnight at the start of the day in the maximum offset (larger offsets are earlier on the time-line). This combines LocalTime.MIN
and ZoneOffset.MAX
. This could be used by an application as a "far past" date.public static final OffsetTime MAX
OffsetTime
, '23:59:59.999999999-18:00'. This is the time just before midnight at the end of the day in the minimum offset (larger negative offsets are later on the time-line). This combines LocalTime.MAX
and ZoneOffset.MIN
. This could be used by an application as a "far future" date.public static OffsetTime now()
This will query the system clock
in the default time-zone to obtain the current time. The offset will be calculated from the time-zone in the clock.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
public static OffsetTime now(ZoneId zone)
This will query the system clock
to obtain the current time. Specifying the time-zone avoids dependence on the default time-zone. The offset will be calculated from the specified time-zone.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
zone
- the zone ID to use, not nullpublic static OffsetTime now(Clock clock)
This will query the specified clock to obtain the current time. The offset will be calculated from the time-zone in the clock.
Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection
.
clock
- the clock to use, not nullpublic static OffsetTime of(LocalTime time, ZoneOffset offset)
OffsetTime
from a local time and an offset.time
- the local time, not nulloffset
- the zone offset, not nullpublic static OffsetTime of(int hour, int minute, int second, int nanoOfSecond, ZoneOffset offset)
OffsetTime
from an hour, minute, second and nanosecond. This creates an offset time with the four specified fields.
This method exists primarily for writing test cases. Non test-code will typically use other methods to create an offset time. LocalTime
has two additional convenience variants of the equivalent factory method taking fewer arguments. They are not provided here to reduce the footprint of the API.
hour
- the hour-of-day to represent, from 0 to 23minute
- the minute-of-hour to represent, from 0 to 59second
- the second-of-minute to represent, from 0 to 59nanoOfSecond
- the nano-of-second to represent, from 0 to 999,999,999offset
- the zone offset, not nullDateTimeException
- if the value of any field is out of rangepublic static OffsetTime ofInstant(Instant instant, ZoneId zone)
OffsetTime
from an Instant
and zone ID. This creates an offset time with the same instant as that specified. Finding the offset from UTC/Greenwich is simple as there is only one valid offset for each instant.
The date component of the instant is dropped during the conversion. This means that the conversion can never fail due to the instant being out of the valid range of dates.
instant
- the instant to create the time from, not nullzone
- the time-zone, which may be an offset, not nullpublic static OffsetTime from(TemporalAccessor temporal)
OffsetTime
from a temporal object. This obtains an offset 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 OffsetTime
.
The conversion extracts and combines the ZoneOffset
and the LocalTime
from the temporal object. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects.
This method matches the signature of the functional interface TemporalQuery
allowing it to be used as a query via method reference, OffsetTime::from
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to an OffsetTime
public static OffsetTime parse(CharSequence text)
OffsetTime
from a text string such as 10:15:30+01:00
. The string must represent a valid time and is parsed using DateTimeFormatter.ISO_OFFSET_TIME
.
text
- the text to parse such as "10:15:30+01:00", not nullDateTimeParseException
- if the text cannot be parsedpublic static OffsetTime parse(CharSequence text, DateTimeFormatter formatter)
OffsetTime
from a text string using a specific formatter. The text is parsed using the formatter, returning a time.
text
- the text to parse, not nullformatter
- the formatter to use, not nullDateTimeParseException
- if the text cannot be parsedpublic boolean isSupported(TemporalField field)
This checks if this time can be queried for the specified field. If false, then calling the range
, get
and with(TemporalField, long)
methods will throw an exception.
If the field is a ChronoField
then the query is implemented here. The supported fields are:
NANO_OF_SECOND
NANO_OF_DAY
MICRO_OF_SECOND
MICRO_OF_DAY
MILLI_OF_SECOND
MILLI_OF_DAY
SECOND_OF_MINUTE
SECOND_OF_DAY
MINUTE_OF_HOUR
MINUTE_OF_DAY
HOUR_OF_AMPM
CLOCK_HOUR_OF_AMPM
HOUR_OF_DAY
CLOCK_HOUR_OF_DAY
AMPM_OF_DAY
OFFSET_SECONDS
ChronoField
instances will return false. If the field is not a ChronoField
, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor)
passing this
as the argument. Whether the field is supported is determined by the field.
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic boolean isSupported(TemporalUnit unit)
This checks if the specified unit can be added to, or subtracted from, this offset-time. If false, then calling the plus(long, TemporalUnit)
and minus
methods will throw an exception.
If the unit is a ChronoUnit
then the query is implemented here. The supported units are:
NANOS
MICROS
MILLIS
SECONDS
MINUTES
HOURS
HALF_DAYS
ChronoUnit
instances will return false. If the unit is not a ChronoUnit
, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this
as the argument. Whether the unit is supported is determined by the unit.
isSupported
in interface Temporal
unit
- the unit to check, null returns falsepublic ValueRange range(TemporalField field)
The range object expresses the minimum and maximum valid values for a field. This time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here. The supported fields
will return appropriate range instances. All other ChronoField
instances will throw an UnsupportedTemporalTypeException
.
If the field is not a ChronoField
, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor)
passing this
as the argument. Whether the range can be obtained is determined by the field.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedpublic int get(TemporalField field)
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 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 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.
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtained or the value is outside the range of valid values for the fieldUnsupportedTemporalTypeException
- if the field is not supported or the range of values exceeds an int
ArithmeticException
- if numeric overflow occurspublic long getLong(TemporalField field)
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 ChronoField
then the query is implemented here. The supported fields
will return valid values based on this time. All other ChronoField
instances will throw an UnsupportedTemporalTypeException
.
If the field is not a ChronoField
, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurspublic ZoneOffset getOffset()
This is the offset of the local time from UTC/Greenwich.
public OffsetTime withOffsetSameLocal(ZoneOffset offset)
OffsetTime
with the specified offset ensuring that the result has the same local time. This method returns an object with the same LocalTime
and the specified ZoneOffset
. No calculation is needed or performed. For example, if this time represents 10:30+02:00
and the offset specified is +03:00
, then this method will return 10:30+03:00
.
To take into account the difference between the offsets, and adjust the time fields, use withOffsetSameInstant(java.time.ZoneOffset)
.
This instance is immutable and unaffected by this method call.
offset
- the zone offset to change to, not nullOffsetTime
based on this time with the requested offset, not nullpublic OffsetTime withOffsetSameInstant(ZoneOffset offset)
OffsetTime
with the specified offset ensuring that the result is at the same instant on an implied day. This method returns an object with the specified ZoneOffset
and a LocalTime
adjusted by the difference between the two offsets. This will result in the old and new objects representing the same instant on an implied day. This is useful for finding the local time in a different offset. For example, if this time represents 10:30+02:00
and the offset specified is +03:00
, then this method will return 11:30+03:00
.
To change the offset without adjusting the local time use withOffsetSameLocal(java.time.ZoneOffset)
.
This instance is immutable and unaffected by this method call.
offset
- the zone offset to change to, not nullOffsetTime
based on this time with the requested offset, not nullpublic LocalTime toLocalTime()
LocalTime
part of this date-time. This returns a LocalTime
with the same hour, minute, second and nanosecond as this date-time.
public int getHour()
public int getMinute()
public int getSecond()
public int getNano()
public OffsetTime with(TemporalAdjuster adjuster)
This returns an OffsetTime
, 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 classes LocalTime
and ZoneOffset
implement TemporalAdjuster
, thus this method can be used to change the time or offset:
result = offsetTime.with(time); result = offsetTime.with(offset);
The result of this method is obtained by invoking the TemporalAdjuster.adjustInto(Temporal)
method on the specified adjuster passing this
as the argument.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
adjuster
- the adjuster to use, not nullOffsetTime
based on this
with the adjustment made, not nullDateTimeException
- if the adjustment cannot be madeArithmeticException
- if numeric overflow occurspublic OffsetTime with(TemporalField field, long newValue)
This returns an OffsetTime
, 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 OFFSET_SECONDS
field will return a time with the specified offset. The local time is unaltered. If the new offset value is outside the valid range then a DateTimeException
will be thrown.
The other supported fields
will behave as per the matching method on LocalTime.with(TemporalField, long)
LocalTime}. In this case, the offset is not part of the calculation and will be unchanged.
All other ChronoField
instances will throw an UnsupportedTemporalTypeException
.
If the field is not a ChronoField
, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long)
passing this
as the argument. In this case, the field determines whether and how to adjust the instant.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultOffsetTime
based on this
with the specified field set, not nullDateTimeException
- if the field cannot be setUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurspublic OffsetTime withHour(int hour)
OffsetTime
with the hour-of-day altered. The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
hour
- the hour-of-day to set in the result, from 0 to 23OffsetTime
based on this time with the requested hour, not nullDateTimeException
- if the hour value is invalidpublic OffsetTime withMinute(int minute)
OffsetTime
with the minute-of-hour altered. The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
minute
- the minute-of-hour to set in the result, from 0 to 59OffsetTime
based on this time with the requested minute, not nullDateTimeException
- if the minute value is invalidpublic OffsetTime withSecond(int second)
OffsetTime
with the second-of-minute altered. The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
second
- the second-of-minute to set in the result, from 0 to 59OffsetTime
based on this time with the requested second, not nullDateTimeException
- if the second value is invalidpublic OffsetTime withNano(int nanoOfSecond)
OffsetTime
with the nano-of-second altered. The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
nanoOfSecond
- the nano-of-second to set in the result, from 0 to 999,999,999OffsetTime
based on this time with the requested nanosecond, not nullDateTimeException
- if the nanos value is invalidpublic OffsetTime truncatedTo(TemporalUnit unit)
OffsetTime
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 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.
The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
unit
- the unit to truncate to, not nullOffsetTime
based on this time with the time truncated, not nullDateTimeException
- if unable to truncateUnsupportedTemporalTypeException
- if the unit is not supportedpublic OffsetTime plus(TemporalAmount amountToAdd)
This returns an OffsetTime
, based on this one, with the specified amount added. The amount is typically Duration
but may be any other type implementing the TemporalAmount
interface.
The calculation is delegated to the amount object by calling TemporalAmount.addTo(Temporal)
. The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long, TemporalUnit)
. Consult the documentation of the amount implementation to determine if it can be successfully added.
This instance is immutable and unaffected by this method call.
plus
in interface Temporal
amountToAdd
- the amount to add, not nullOffsetTime
based on this time with the addition made, not nullDateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occurspublic OffsetTime plus(long amountToAdd, TemporalUnit unit)
This returns an OffsetTime
, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.
If the field is a ChronoUnit
then the addition is implemented by LocalTime.plus(long, TemporalUnit)
. The offset is not part of the calculation and will be unchanged in the result.
If the field is not a ChronoUnit
, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long)
passing this
as the argument. In this case, the unit determines whether and how to perform the addition.
This instance is immutable and unaffected by this method call.
plus
in interface Temporal
amountToAdd
- the amount of the unit to add to the result, may be negativeunit
- the unit of the amount to add, not nullOffsetTime
based on this time with the specified amount added, not nullDateTimeException
- if the addition cannot be madeUnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic OffsetTime plusHours(long hours)
OffsetTime
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.
hours
- the hours to add, may be negativeOffsetTime
based on this time with the hours added, not nullpublic OffsetTime plusMinutes(long minutes)
OffsetTime
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.
minutes
- the minutes to add, may be negativeOffsetTime
based on this time with the minutes added, not nullpublic OffsetTime plusSeconds(long seconds)
OffsetTime
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.
seconds
- the seconds to add, may be negativeOffsetTime
based on this time with the seconds added, not nullpublic OffsetTime plusNanos(long nanos)
OffsetTime
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.
nanos
- the nanos to add, may be negativeOffsetTime
based on this time with the nanoseconds added, not nullpublic OffsetTime minus(TemporalAmount amountToSubtract)
This returns an OffsetTime
, based on this one, with the specified amount subtracted. The amount is typically Duration
but may be any other type implementing the TemporalAmount
interface.
The calculation is delegated to the amount object by calling TemporalAmount.subtractFrom(Temporal)
. The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long, TemporalUnit)
. Consult the documentation of the amount implementation to determine if it can be successfully subtracted.
This instance is immutable and unaffected by this method call.
minus
in interface Temporal
amountToSubtract
- the amount to subtract, not nullOffsetTime
based on this time with the subtraction made, not nullDateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occurspublic OffsetTime minus(long amountToSubtract, TemporalUnit unit)
This returns an OffsetTime
, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.
This method is equivalent to plus(long, TemporalUnit)
with the amount negated. See that method for a full description of how addition, and thus subtraction, works.
This instance is immutable and unaffected by this method call.
minus
in interface Temporal
amountToSubtract
- the amount of the unit to subtract from the result, may be negativeunit
- the unit of the amount to subtract, not nullOffsetTime
based on this time with the specified amount subtracted, not nullDateTimeException
- if the subtraction cannot be madeUnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic OffsetTime minusHours(long hours)
OffsetTime
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.
hours
- the hours to subtract, may be negativeOffsetTime
based on this time with the hours subtracted, not nullpublic OffsetTime minusMinutes(long minutes)
OffsetTime
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.
minutes
- the minutes to subtract, may be negativeOffsetTime
based on this time with the minutes subtracted, not nullpublic OffsetTime minusSeconds(long seconds)
OffsetTime
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.
seconds
- the seconds to subtract, may be negativeOffsetTime
based on this time with the seconds subtracted, not nullpublic OffsetTime minusNanos(long nanos)
OffsetTime
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.
nanos
- the nanos to subtract, may be negativeOffsetTime
based on this time with the nanoseconds subtracted, not nullpublic <R> R query(TemporalQuery<R> query)
This queries this time using the specified query strategy object. The TemporalQuery
object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.
The result of this method is obtained by invoking the TemporalQuery.queryFrom(TemporalAccessor)
method on the specified query passing this
as the argument.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)ArithmeticException
- if numeric overflow occurs (defined by the query)public Temporal adjustInto(Temporal temporal)
This returns a temporal object of the same observable type as the input with the offset and time changed to be the same as this.
The adjustment is equivalent to using Temporal.with(TemporalField, long)
twice, passing ChronoField.NANO_OF_DAY
and ChronoField.OFFSET_SECONDS
as the fields.
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 = thisOffsetTime.adjustInto(temporal); temporal = temporal.with(thisOffsetTime);
This instance is immutable and unaffected by this method call.
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occurspublic long until(Temporal endExclusive, TemporalUnit unit)
This calculates the amount of time between two OffsetTime
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. For example, the amount in hours between two times can be calculated using startTime.until(endTime, HOURS)
.
The Temporal
passed to this method is converted to a OffsetTime
using from(TemporalAccessor)
. If the offset differs between the two times, then the specified end time is normalized to have the same offset as this time.
The calculation returns a whole number, representing the number of complete units between the two times. For example, the amount in hours between 11:30Z and 13:29Z will only be one hour as it is one minute short of two hours.
There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit.between(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 ChronoUnit
. The units NANOS
, MICROS
, MILLIS
, SECONDS
, MINUTES
, HOURS
and HALF_DAYS
are supported. Other ChronoUnit
values will throw an exception.
If the unit is not a ChronoUnit
, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal)
passing this
as the first argument and the converted input temporal as the second argument.
This instance is immutable and unaffected by this method call.
until
in interface Temporal
endExclusive
- the end time, exclusive, which is converted to an OffsetTime
, not nullunit
- the unit to measure the amount in, not nullDateTimeException
- if the amount cannot be calculated, or the end temporal cannot be converted to an OffsetTime
UnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic String format(DateTimeFormatter formatter)
This time will be passed to the formatter to produce a string.
formatter
- the formatter to use, not nullDateTimeException
- if an error occurs during printingpublic OffsetDateTime atDate(LocalDate date)
OffsetDateTime
. This returns an OffsetDateTime
formed from this time and the specified date. All possible combinations of date and time are valid.
date
- the date to combine with, not nullpublic long toEpochSecond(LocalDate date)
OffsetTime
to the number of seconds since the epoch of 1970-01-01T00:00:00Z. This combines this offset time with the specified date 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.
date
- the localdate, not nullpublic int compareTo(OffsetTime other)
OffsetTime
to another time. The comparison is based first on the UTC equivalent instant, then on the local time. It is "consistent with equals", as defined by Comparable
.
For example, the following is the comparator order:
10:30+01:00
11:00+01:00
12:00+02:00
11:30+01:00
12:00+01:00
12:30+01:00
equals()
. To compare the underlying local time of two TemporalAccessor
instances, use ChronoField.NANO_OF_DAY
as a comparator.
compareTo
in interface Comparable<OffsetTime>
other
- the other time to compare to, not nullother
instant, if they are not equal, and if the UTC equivalent other
instant is equal, the comparison of this local time with other
local timepublic boolean isAfter(OffsetTime other)
OffsetTime
is after that of the specified time applying both times to a common date. This method differs from the comparison in compareTo(java.time.OffsetTime)
in that it only compares the instant of the time. This is equivalent to converting both times to an instant using the same date and comparing the instants.
other
- the other time to compare to, not nullpublic boolean isBefore(OffsetTime other)
OffsetTime
is before that of the specified time applying both times to a common date. This method differs from the comparison in compareTo(java.time.OffsetTime)
in that it only compares the instant of the time. This is equivalent to converting both times to an instant using the same date and comparing the instants.
other
- the other time to compare to, not nullpublic boolean isEqual(OffsetTime other)
OffsetTime
is equal to that of the specified time applying both times to a common date. This method differs from the comparison in compareTo(java.time.OffsetTime)
and equals(java.lang.Object)
in that it only compares the instant of the time. This is equivalent to converting both times to an instant using the same date and comparing the instants.
other
- the other time to compare to, not nullpublic boolean equals(Object obj)
The comparison is based on the local-time and the offset. To compare for the same instant on the time-line, use isEqual(OffsetTime)
.
Only objects of type OffsetTime
are compared, other types return false. To compare the underlying local time of two TemporalAccessor
instances, use ChronoField.NANO_OF_DAY
as a comparator.
public int hashCode()
public String toString()
String
, such as 10:15:30+01:00
. The output will be one of the following ISO-8601 formats:
HH:mmXXXXX
HH:mm:ssXXXXX
HH:mm:ss.SSSXXXXX
HH:mm:ss.SSSSSSXXXXX
HH:mm:ss.SSSSSSSSSXXXXX
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/OffsetTime.html