Class OffsetTime
- All Implemented Interfaces:
Serializable
,Comparable<OffsetTime>
,Calendrical
,CalendricalMatcher
,TimeAdjuster
,TimeProvider
10:15:30+01:00
.
OffsetTime
is an immutable calendrical 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.
Thus, for example, the value "13:45.30.123456789+02:00" can be stored
in a OffsetTime
.
OffsetTime is immutable and thread-safe.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
Rule implementation. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ZoneOffset
The zone offset from UTC, never null.private static final long
A serialization identifier for this class.private final LocalTime
The local time, never null. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadjustTime
(LocalTime time) Adjusts a time to have the value of the time part of this object.int
compareTo
(OffsetTime other) Compares thisOffsetTime
to another time based on the UTC equivalent times then local time.boolean
equalInstant
(OffsetTime other) Checks if the instant of thisOffsetTime
is equal to that of the specified time applying both times to a common date.boolean
Checks if thisOffsetTime
is equal to the specified time.<T> T
get
(CalendricalRule<T> rule) Gets the value of the specified calendrical rule.Gets the chronology that this time uses, which is the ISO calendar system.int
Gets the hour-of-day field.int
Gets the minute-of-hour field.int
Gets the nano-of-second field.Gets the zone offset representing how far ahead or behind UTC the time is.int
Gets the second-of-minute field.int
hashCode()
A hash code for thisOffsetTime
.boolean
isAfter
(OffsetTime other) Checks if the instant of thisOffsetTime
is after that of the specified time applying both times to a common date.boolean
isBefore
(OffsetTime other) Checks if the instant of thisOffsetTime
is before that of the specified time applying both times to a common date.boolean
matches
(CalendricalMatcher matcher) Checks whether thisOffsetTime
matches the specified matcher.boolean
matchesCalendrical
(Calendrical calendrical) Checks if the time extracted from the calendrical matches this.minus
(PeriodProvider periodProvider) Returns a copy of thisOffsetTime
with the specified period subtracted.Returns a copy of thisOffsetTime
with the specified duration subtracted.minusHours
(long hours) Returns a copy of thisOffsetTime
with the specified period in hours subtracted.minusMinutes
(long minutes) Returns a copy of thisOffsetTime
with the specified period in minutes subtracted.minusNanos
(long nanos) Returns a copy of thisOffsetTime
with the specified period in nanoseconds subtracted.minusSeconds
(long seconds) Returns a copy of thisOffsetTime
with the specified period in seconds subtracted.static OffsetTime
now()
Obtains the current time from the system clock in the default time-zone.static OffsetTime
Obtains the current time from the specified clock.static OffsetTime
of
(int hourOfDay, int minuteOfHour, int secondOfMinute, int nanoOfSecond, ZoneOffset offset) Obtains an instance ofOffsetTime
from an hour, minute, second and nanosecond.static OffsetTime
of
(int hourOfDay, int minuteOfHour, int secondOfMinute, ZoneOffset offset) Obtains an instance ofOffsetTime
from an hour, minute and second.static OffsetTime
of
(int hourOfDay, int minuteOfHour, ZoneOffset offset) Obtains an instance ofOffsetTime
from an hour and minute.static OffsetTime
of
(TimeProvider timeProvider, ZoneOffset offset) Obtains an instance ofOffsetTime
from a time provider.static OffsetTime
ofInstant
(InstantProvider instantProvider, ZoneOffset offset) Obtains an instance ofOffsetTime
from anInstantProvider
.static OffsetTime
Obtains an instance ofOffsetTime
from a text string such as10:15:30+01:00
.static OffsetTime
parse
(String text, DateTimeFormatter formatter) Obtains an instance ofOffsetTime
from a text string using a specific formatter.plus
(PeriodProvider periodProvider) Returns a copy of thisOffsetTime
with the specified period added.Returns a copy of thisOffsetTime
with the specified duration added.plusHours
(long hours) Returns a copy of thisOffsetTime
with the specified period in hours added.plusMinutes
(long minutes) Returns a copy of thisOffsetTime
with the specified period in minutes added.plusNanos
(long nanos) Returns a copy of thisOffsetTime
with the specified period in nanoseconds added.plusSeconds
(long seconds) Returns a copy of thisOffsetTime
with the specified period in seconds added.static CalendricalRule<OffsetTime>
rule()
Gets the rule forOffsetTime
.private long
Converts this time to epoch nanos based on 1970-01-01Z.Converts this time to aLocalTime
.toString()
Outputs this time as aString
, such as10:15:30+01:00
.toString
(DateTimeFormatter formatter) Outputs this time as aString
using the formatter.with
(TimeAdjuster adjuster) Returns a copy of thisOffsetTime
with the time altered using the adjuster.withHourOfDay
(int hourOfDay) Returns a copy of thisOffsetTime
with the hour-of-day value altered.withMinuteOfHour
(int minuteOfHour) Returns a copy of thisOffsetTime
with the minute-of-hour value altered.withNanoOfSecond
(int nanoOfSecond) Returns a copy of thisOffsetTime
with the nano-of-second value altered.withOffsetSameInstant
(ZoneOffset offset) Returns a copy of thisOffsetTime
with the specified offset ensuring that the result is at the same instant on an implied day.withOffsetSameLocal
(ZoneOffset offset) Returns a copy of thisOffsetTime
with the specified offset ensuring that the result has the same local time.withSecondOfMinute
(int secondOfMinute) Returns a copy of thisOffsetTime
with the second-of-minute value altered.withTime
(TimeProvider timeProvider) Returns a copy of thisOffsetTime
with the time altered and the offset retained.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDA serialization identifier for this class.- See Also:
-
time
The local time, never null. -
offset
The zone offset from UTC, never null.
-
-
Constructor Details
-
OffsetTime
Constructor.- Parameters:
time
- the time, validated as not nulloffset
- the zone offset, validated as not null
-
-
Method Details
-
now
Obtains the current time from the system clock in the default time-zone.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.
- Returns:
- the current time using the system clock, never null
-
now
Obtains the current time from the specified 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
.- Parameters:
clock
- the clock to use, not null- Returns:
- the current time, never null
-
of
Obtains an instance ofOffsetTime
from an hour and minute.The second and nanosecond fields will be set to zero by this factory method.
- Parameters:
hourOfDay
- the hour-of-day to represent, from 0 to 23minuteOfHour
- the minute-of-hour to represent, from 0 to 59offset
- the zone offset, not null- Returns:
- the offset time, never null
- Throws:
IllegalCalendarFieldValueException
- if the value of any field is out of range
-
of
Obtains an instance ofOffsetTime
from an hour, minute and second.The second field will be set to zero by this factory method.
- Parameters:
hourOfDay
- the hour-of-day to represent, from 0 to 23minuteOfHour
- the minute-of-hour to represent, from 0 to 59secondOfMinute
- the second-of-minute to represent, from 0 to 59offset
- the zone offset, not null- Returns:
- the offset time, never null
- Throws:
IllegalCalendarFieldValueException
- if the value of any field is out of range
-
of
public static OffsetTime of(int hourOfDay, int minuteOfHour, int secondOfMinute, int nanoOfSecond, ZoneOffset offset) Obtains an instance ofOffsetTime
from an hour, minute, second and nanosecond.- Parameters:
hourOfDay
- the hour-of-day to represent, from 0 to 23minuteOfHour
- the minute-of-hour to represent, from 0 to 59secondOfMinute
- 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 null- Returns:
- the offset time, never null
- Throws:
IllegalCalendarFieldValueException
- if the value of any field is out of range
-
of
Obtains an instance ofOffsetTime
from a time provider.- Parameters:
timeProvider
- the time provider to use, not nulloffset
- the zone offset, not null- Returns:
- the offset time, never null
-
ofInstant
Obtains an instance ofOffsetTime
from anInstantProvider
.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.
- Parameters:
instantProvider
- the instant to convert, not nulloffset
- the zone offset, not null- Returns:
- the offset time, never null
-
parse
Obtains an instance ofOffsetTime
from a text string such as10:15:30+01:00
.The following formats are accepted in ASCII:
{Hour}:{Minute}{OffsetID}
{Hour}:{Minute}:{Second}{OffsetID}
{Hour}:{Minute}:{Second}.{NanosecondFraction}{OffsetID}
The hour has 2 digits with values from 0 to 23. The minute has 2 digits with values from 0 to 59. The second has 2 digits with values from 0 to 59. The nanosecond fraction has from 1 to 9 digits with values from 0 to 999,999,999.
The offset ID is the normalized form as defined in
ZoneOffset
.- Parameters:
text
- the text to parse such as '10:15:30+01:00', not null- Returns:
- the parsed local time, never null
- Throws:
CalendricalException
- if the text cannot be parsed
-
parse
Obtains an instance ofOffsetTime
from a text string using a specific formatter.The text is parsed using the formatter, returning a time.
- Parameters:
text
- the text to parse, not nullformatter
- the formatter to use, not null- Returns:
- the parsed offset time, never null
- Throws:
UnsupportedOperationException
- if the formatter cannot parseCalendricalException
- if the text cannot be parsed
-
getChronology
Gets the chronology that this time uses, which is the ISO calendar system.- Returns:
- the ISO chronology, never null
-
get
Gets the value of the specified calendrical rule.This method queries the value of the specified calendrical rule. If the value cannot be returned for the rule from this time then
null
will be returned.- Specified by:
get
in interfaceCalendrical
- Parameters:
rule
- the rule to use, not null- Returns:
- the value for the rule, null if the value cannot be returned
-
withTime
Returns a copy of thisOffsetTime
with the time altered and the offset retained.This method returns an object with the same
ZoneOffset
and the specifiedLocalTime
. No calculation is needed or performed.- Parameters:
timeProvider
- the local time to change to, not null- Returns:
- an
OffsetTime
based on this time with the requested time, never null
-
getOffset
Gets the zone offset representing how far ahead or behind UTC the time is.- Returns:
- the zone offset, never null
-
withOffsetSameLocal
Returns a copy of thisOffsetTime
with the specified offset ensuring that the result has the same local time.This method returns an object with the same
LocalTime
and the specifiedZoneOffset
. No calculation is needed or performed. For example, if this time represents10:30+02:00
and the offset specified is+03:00
, then this method will return10:30+03:00
.To take into account the difference between the offsets, and adjust the time fields, use
withOffsetSameInstant(javax.time.calendar.ZoneOffset)
.This instance is immutable and unaffected by this method call.
- Parameters:
offset
- the zone offset to change to, not null- Returns:
- an
OffsetTime
based on this time with the requested offset, never null
-
withOffsetSameInstant
Returns a copy of thisOffsetTime
with the specified offset ensuring that the result is at the same instant on an implied day.This method returns an object with the the specified
ZoneOffset
and aLocalTime
adjusted by the difference between the two offsets. This will result in the old and new objects representing the same instant an an implied day. This is useful for finding the local time in a different offset. For example, if this time represents10:30+02:00
and the offset specified is+03:00
, then this method will return11:30+03:00
.To change the offset without adjusting the local time use
withOffsetSameLocal(javax.time.calendar.ZoneOffset)
.This instance is immutable and unaffected by this method call.
- Parameters:
offset
- the zone offset to change to, not null- Returns:
- an
OffsetTime
based on this time with the requested offset, never null
-
getHourOfDay
public int getHourOfDay()Gets the hour-of-day field.- Returns:
- the hour-of-day, from 0 to 23
-
getMinuteOfHour
public int getMinuteOfHour()Gets the minute-of-hour field.- Returns:
- the minute-of-hour, from 0 to 59
-
getSecondOfMinute
public int getSecondOfMinute()Gets the second-of-minute field.- Returns:
- the second-of-minute, from 0 to 59
-
getNanoOfSecond
public int getNanoOfSecond()Gets the nano-of-second field.- Returns:
- the nano-of-second, from 0 to 999,999,999
-
with
Returns a copy of thisOffsetTime
with the time altered using the adjuster.Adjusters can be used to alter the time in various ways. 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 end of the working day.
This instance is immutable and unaffected by this method call.
- Parameters:
adjuster
- the adjuster to use, not null- Returns:
- an
OffsetTime
based on this time adjusted as necessary, never null
-
withHourOfDay
Returns a copy of thisOffsetTime
with the hour-of-day value altered.This instance is immutable and unaffected by this method call.
- Parameters:
hourOfDay
- the hour-of-day to represent, from 0 to 23- Returns:
- an
OffsetTime
based on this time with the requested hour, never null - Throws:
IllegalCalendarFieldValueException
- if the hour value is invalid
-
withMinuteOfHour
Returns a copy of thisOffsetTime
with the minute-of-hour value altered.This instance is immutable and unaffected by this method call.
- Parameters:
minuteOfHour
- the minute-of-hour to represent, from 0 to 59- Returns:
- an
OffsetTime
based on this time with the requested minute, never null - Throws:
IllegalCalendarFieldValueException
- if the minute value is invalid
-
withSecondOfMinute
Returns a copy of thisOffsetTime
with the second-of-minute value altered.This instance is immutable and unaffected by this method call.
- Parameters:
secondOfMinute
- the second-of-minute to represent, from 0 to 59- Returns:
- an
OffsetTime
based on this time with the requested second, never null - Throws:
IllegalCalendarFieldValueException
- if the second value is invalid
-
withNanoOfSecond
Returns a copy of thisOffsetTime
with the nano-of-second value altered.This instance is immutable and unaffected by this method call.
- Parameters:
nanoOfSecond
- the nano-of-second to represent, from 0 to 999,999,999- Returns:
- an
OffsetTime
based on this time with the requested nanosecond, never null - Throws:
IllegalCalendarFieldValueException
- if the nanos value is invalid
-
plus
Returns a copy of thisOffsetTime
with the specified period added.This adds the specified period to this time, returning a new time. The calculation wraps around midnight and ignores any date-based ISO fields.
The period is interpreted using rules equivalent to
Period.ofTimeFields(PeriodProvider)
. Those rules ignore any date-based ISO fields, thus adding a date-based period to this time will have no effect.This instance is immutable and unaffected by this method call.
- Parameters:
periodProvider
- the period to add, not null- Returns:
- an
OffsetTime
based on this time with the period added, never null - Throws:
CalendricalException
- if the specified period cannot be converted to aPeriod
ArithmeticException
- if the period overflows during conversion to hours/minutes/seconds/nanos
-
plus
Returns a copy of thisOffsetTime
with the specified duration added.This adds the specified duration to this time, returning a new time. The calculation wraps around midnight.
The calculation is equivalent to using
plusSeconds(long)
andplusNanos(long)
on the two parts of the duration.This instance is immutable and unaffected by this method call.
- Parameters:
duration
- the duration to add, not null- Returns:
- an
OffsetTime
based on this time with the duration added, never null
-
plusHours
Returns a copy of thisOffsetTime
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.
- Parameters:
hours
- the hours to add, may be negative- Returns:
- an
OffsetTime
based on this time with the hours added, never null
-
plusMinutes
Returns a copy of thisOffsetTime
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.
- Parameters:
minutes
- the minutes to add, may be negative- Returns:
- an
OffsetTime
based on this time with the minutes added, never null
-
plusSeconds
Returns a copy of thisOffsetTime
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.
- Parameters:
seconds
- the seconds to add, may be negative- Returns:
- an
OffsetTime
based on this time with the seconds added, never null
-
plusNanos
Returns a copy of thisOffsetTime
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.
- Parameters:
nanos
- the nanos to add, may be negative- Returns:
- an
OffsetTime
based on this time with the nanoseconds added, never null
-
minus
Returns a copy of thisOffsetTime
with the specified period subtracted.This subtracts the specified period from this time, returning a new time. The calculation wraps around midnight and ignores any date-based ISO fields.
The period is interpreted using rules equivalent to
Period.ofTimeFields(PeriodProvider)
. Those rules ignore any date-based ISO fields, thus adding a date-based period to this time will have no effect.This instance is immutable and unaffected by this method call.
- Parameters:
periodProvider
- the period to subtract, not null- Returns:
- an
OffsetTime
based on this time with the period subtracted, never null - Throws:
CalendricalException
- if the specified period cannot be converted to aPeriod
ArithmeticException
- if the period overflows during conversion to hours/minutes/seconds/nanos
-
minus
Returns a copy of thisOffsetTime
with the specified duration subtracted.This subtracts the specified duration to this time, returning a new time. The calculation wraps around midnight.
The calculation is equivalent to using
minusSeconds(long)
andminusNanos(long)
on the two parts of the duration.This instance is immutable and unaffected by this method call.
- Parameters:
duration
- the duration to subtract, not null- Returns:
- an
OffsetTime
based on this time with the duration subtracted, never null
-
minusHours
Returns a copy of thisOffsetTime
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.
- Parameters:
hours
- the hours to subtract, may be negative- Returns:
- an
OffsetTime
based on this time with the hours subtracted, never null
-
minusMinutes
Returns a copy of thisOffsetTime
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.
- Parameters:
minutes
- the minutes to subtract, may be negative- Returns:
- an
OffsetTime
based on this time with the minutes subtracted, never null
-
minusSeconds
Returns a copy of thisOffsetTime
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.
- Parameters:
seconds
- the seconds to subtract, may be negative- Returns:
- an
OffsetTime
based on this time with the seconds subtracted, never null
-
minusNanos
Returns a copy of thisOffsetTime
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.
- Parameters:
nanos
- the nanos to subtract, may be negative- Returns:
- an
OffsetTime
based on this time with the nanoseconds subtracted, never null
-
matches
Checks whether thisOffsetTime
matches the specified matcher.Matchers can be used to query the time. A simple matcher might simply compare one of the fields, such as the hour field. A more complex matcher might check if the time is the last second of the day.
- Parameters:
matcher
- the matcher to use, not null- Returns:
- true if this time matches the matcher, false otherwise
-
matchesCalendrical
Checks if the time extracted from the calendrical matches this.This method implements the
CalendricalMatcher
interface. It is intended that applications usematches(javax.time.calendar.CalendricalMatcher)
rather than this method.- Specified by:
matchesCalendrical
in interfaceCalendricalMatcher
- Parameters:
calendrical
- the calendrical to match, not null- Returns:
- true if the calendrical matches, false otherwise
-
adjustTime
Adjusts a time to have the value of the time part of this object.This method implements the
TimeAdjuster
interface. It is intended that applications usewith(TimeAdjuster)
rather than this method.- Specified by:
adjustTime
in interfaceTimeAdjuster
- Parameters:
time
- the time to be adjusted, not null- Returns:
- the adjusted time, never null
-
toLocalTime
Converts this time to aLocalTime
.- Specified by:
toLocalTime
in interfaceTimeProvider
- Returns:
- a LocalTime with the same time as this instance, never null
-
toEpochNanos
private long toEpochNanos()Converts this time to epoch nanos based on 1970-01-01Z.- Returns:
- the epoch nanos value
-
compareTo
Compares thisOffsetTime
to another time based on the UTC equivalent times then local time.This ordering is consistent with
equals()
. 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()
.- Specified by:
compareTo
in interfaceComparable<OffsetTime>
- Parameters:
other
- the other time to compare to, not null- Returns:
- the comparator value, negative if less, positive if greater
- Throws:
NullPointerException
- ifother
is null
-
isAfter
Checks if the instant of thisOffsetTime
is after that of the specified time applying both times to a common date.This method differs from the comparison in
compareTo(javax.time.calendar.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.- Parameters:
other
- the other time to compare to, not null- Returns:
- true if this is after the instant of the specified time
-
isBefore
Checks if the instant of thisOffsetTime
is before that of the specified time applying both times to a common date.This method differs from the comparison in
compareTo(javax.time.calendar.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.- Parameters:
other
- the other time to compare to, not null- Returns:
- true if this is before the instant of the specified time
-
equalInstant
Checks if the instant of thisOffsetTime
is equal to that of the specified time applying both times to a common date.This method differs from the comparison in
compareTo(javax.time.calendar.OffsetTime)
andequals(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.- Parameters:
other
- the other time to compare to, not null- Returns:
- true if this is equal to the instant of the specified time
-
equals
Checks if thisOffsetTime
is equal to the specified time.The comparison is based on the time and the offset.
-
hashCode
public int hashCode()A hash code for thisOffsetTime
. -
toString
Outputs this time as aString
, such as10:15:30+01:00
.The output will be one of the following formats:
HH:mmZZZZ
HH:mm:ssZZZZ
HH:mm:ssfnnnZZZZ
HH:mm:ssfnnnnnnZZZZ
HH:mm:ssfnnnnnnnnnZZZZ
-
toString
Outputs this time as aString
using the formatter.- Parameters:
formatter
- the formatter to use, not null- Returns:
- the formatted time string, never null
- Throws:
UnsupportedOperationException
- if the formatter cannot printCalendricalPrintException
- if an error occurs during printing
-
rule
Gets the rule forOffsetTime
.- Returns:
- the rule for the time, never null
-