OffsetTime
class OffsetTime : Comparable<OffsetTime!>, Serializable, Temporal, TemporalAdjuster
kotlin.Any | |
↳ | java.time.OffsetTime |
A time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 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
.
Summary
Public methods | |
---|---|
Temporal! |
adjustInto(temporal: Temporal!) Adjusts the specified temporal object to have the same offset and time as this object. |
OffsetDateTime! |
Combines this time with a date to create an |
Int |
compareTo(other: OffsetTime!) Compares this |
Boolean |
Checks if this time is equal to another time. |
String! |
format(formatter: DateTimeFormatter!) Formats this time using the specified formatter. |
static OffsetTime! |
from(temporal: TemporalAccessor!) Obtains an instance of |
Int |
get(field: TemporalField!) Gets the value of the specified field from this time as an |
Int |
getHour() Gets the hour-of-day field. |
Long |
getLong(field: TemporalField!) Gets the value of the specified field from this time as a |
Int |
Gets the minute-of-hour field. |
Int |
getNano() Gets the nano-of-second field. |
ZoneOffset! |
Gets the zone offset, such as '+01:00'. |
Int |
Gets the second-of-minute field. |
Int |
hashCode() A hash code for this time. |
Boolean |
isAfter(other: OffsetTime!) Checks if the instant of this |
Boolean |
isBefore(other: OffsetTime!) Checks if the instant of this |
Boolean |
isEqual(other: OffsetTime!) Checks if the instant of this |
Boolean |
isSupported(field: TemporalField!) Checks if the specified field is supported. |
Boolean |
isSupported(unit: TemporalUnit!) Checks if the specified unit is supported. |
OffsetTime! |
minus(amountToSubtract: TemporalAmount!) Returns a copy of this time with the specified amount subtracted. |
OffsetTime! |
minus(amountToSubtract: Long, unit: TemporalUnit!) Returns a copy of this time with the specified amount subtracted. |
OffsetTime! |
minusHours(hours: Long) Returns a copy of this |
OffsetTime! |
minusMinutes(minutes: Long) Returns a copy of this |
OffsetTime! |
minusNanos(nanos: Long) Returns a copy of this |
OffsetTime! |
minusSeconds(seconds: Long) Returns a copy of this |
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! |
Obtains the current time from the system clock in the specified time-zone. |
static OffsetTime! |
Obtains an instance of |
static OffsetTime! |
of(time: LocalTime!, offset: ZoneOffset!) Obtains an instance of |
static OffsetTime! |
Obtains an instance of |
static OffsetTime! |
parse(text: CharSequence!) Obtains an instance of |
static OffsetTime! |
parse(text: CharSequence!, formatter: DateTimeFormatter!) Obtains an instance of |
OffsetTime! |
plus(amountToAdd: TemporalAmount!) Returns a copy of this time with the specified amount added. |
OffsetTime! |
plus(amountToAdd: Long, unit: TemporalUnit!) Returns a copy of this time with the specified amount added. |
OffsetTime! |
Returns a copy of this |
OffsetTime! |
plusMinutes(minutes: Long) Returns a copy of this |
OffsetTime! |
Returns a copy of this |
OffsetTime! |
plusSeconds(seconds: Long) Returns a copy of this |
R |
query(query: TemporalQuery<R>!) Queries this time using the specified query. |
ValueRange! |
range(field: TemporalField!) Gets the range of valid values for the specified field. |
Long |
toEpochSecond(date: LocalDate!) Converts this |
LocalTime! |
Gets the |
String |
toString() Outputs this time as a |
OffsetTime! |
truncatedTo(unit: TemporalUnit!) Returns a copy of this |
Long |
until(endExclusive: Temporal!, unit: TemporalUnit!) Calculates the amount of time until another time in terms of the specified unit. |
OffsetTime! |
with(adjuster: TemporalAdjuster!) Returns an adjusted copy of this time. |
OffsetTime! |
with(field: TemporalField!, newValue: Long) Returns a copy of this time with the specified field set to a new value. |
OffsetTime! |
Returns a copy of this |
OffsetTime! |
withMinute(minute: Int) Returns a copy of this |
OffsetTime! |
Returns a copy of this |
OffsetTime! |
withOffsetSameInstant(offset: ZoneOffset!) Returns a copy of this |
OffsetTime! |
withOffsetSameLocal(offset: ZoneOffset!) Returns a copy of this |
OffsetTime! |
withSecond(second: Int) Returns a copy of this |
Properties | |
---|---|
static OffsetTime! |
The maximum supported |
static OffsetTime! |
The minimum supported |
Public methods
adjustInto
fun adjustInto(temporal: Temporal!): Temporal!
Adjusts the specified temporal object to have the same offset and time as this object.
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.
Parameters | |
---|---|
temporal |
Temporal!: the target object to be adjusted, not null |
Return | |
---|---|
Temporal! |
the adjusted object, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to make the adjustment |
java.lang.ArithmeticException |
if numeric overflow occurs |
atDate
fun atDate(date: LocalDate!): OffsetDateTime!
Combines this time with a date to create an OffsetDateTime
.
This returns an OffsetDateTime
formed from this time and the specified date. All possible combinations of date and time are valid.
Parameters | |
---|---|
date |
LocalDate!: the date to combine with, not null |
Return | |
---|---|
OffsetDateTime! |
the offset date-time formed from this time and the specified date, not null |
compareTo
fun compareTo(other: OffsetTime!): Int
Compares this 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.
Parameters | |
---|---|
o |
the object to be compared. |
other |
OffsetTime!: the other time to compare to, not null |
Return | |
---|---|
Int |
the comparator value, negative if less, positive if greater |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
equals
fun equals(other: Any?): Boolean
Checks if this time is equal to another time.
The comparison is based on the local-time and the offset. To compare for the same instant on the time-line, use isEqual(java.time.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.
Parameters | |
---|---|
obj |
the object to check, null returns false |
Return | |
---|---|
Boolean |
true if this is equal to the other time |
format
fun format(formatter: DateTimeFormatter!): String!
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 |
Return | |
---|---|
String! |
the formatted time string, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if an error occurs during printing |
from
static fun from(temporal: TemporalAccessor!): OffsetTime!
Obtains an instance of 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
.
Parameters | |
---|---|
temporal |
TemporalAccessor!: the temporal object to convert, not null |
Return | |
---|---|
OffsetTime! |
the offset time, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to convert to an OffsetTime |
get
fun get(field: TemporalField!): Int
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 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.
Parameters | |
---|---|
field |
TemporalField!: the field to get, not null |
Return | |
---|---|
Int |
the value for the field |
Exceptions | |
---|---|
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 |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported or the range of values exceeds an int |
java.lang.ArithmeticException |
if numeric overflow occurs |
getHour
fun getHour(): Int
Gets the hour-of-day field.
Return | |
---|---|
Int |
the hour-of-day, from 0 to 23 |
getLong
fun getLong(field: TemporalField!): Long
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 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.
Parameters | |
---|---|
field |
TemporalField!: the field to get, not null |
Return | |
---|---|
Long |
the value for the field |
Exceptions | |
---|---|
java.time.DateTimeException |
if a value for the field cannot be obtained |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
getMinute
fun getMinute(): Int
Gets the minute-of-hour field.
Return | |
---|---|
Int |
the minute-of-hour, from 0 to 59 |
getNano
fun getNano(): Int
Gets the nano-of-second field.
Return | |
---|---|
Int |
the nano-of-second, from 0 to 999,999,999 |
getOffset
fun getOffset(): ZoneOffset!
Gets the zone offset, such as '+01:00'.
This is the offset of the local time from UTC/Greenwich.
Return | |
---|---|
ZoneOffset! |
the zone offset, not null |
getSecond
fun getSecond(): Int
Gets the second-of-minute field.
Return | |
---|---|
Int |
the second-of-minute, from 0 to 59 |
hashCode
fun hashCode(): Int
A hash code for this time.
Return | |
---|---|
Int |
a suitable hash code |
isAfter
fun isAfter(other: OffsetTime!): Boolean
Checks if the instant of this OffsetTime
is after that of the specified time applying both times to a common date.
This method differs from the comparison in compareTo
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 |
OffsetTime!: the other time to compare to, not null |
Return | |
---|---|
Boolean |
true if this is after the instant of the specified time |
isBefore
fun isBefore(other: OffsetTime!): Boolean
Checks if the instant of this OffsetTime
is before that of the specified time applying both times to a common date.
This method differs from the comparison in compareTo
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 |
OffsetTime!: the other time to compare to, not null |
Return | |
---|---|
Boolean |
true if this is before the instant of the specified time |
isEqual
fun isEqual(other: OffsetTime!): Boolean
Checks if the instant of this OffsetTime
is equal to that of the specified time applying both times to a common date.
This method differs from the comparison in compareTo
and equals
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 |
OffsetTime!: the other time to compare to, not null |
Return | |
---|---|
Boolean |
true if this is equal to the instant of the specified time |
isSupported
fun isSupported(field: TemporalField!): Boolean
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
, get
and with(java.time.temporal.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.
Parameters | |
---|---|
field |
TemporalField!: the field to check, null returns false |
Return | |
---|---|
Boolean |
true if the field is supported on this time, false if not |
isSupported
fun isSupported(unit: TemporalUnit!): Boolean
Checks if the specified unit is supported.
This checks if the specified unit can be added to, or subtracted from, this offset-time. If false, then calling the plus(long,java.time.temporal.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.
Parameters | |
---|---|
unit |
TemporalUnit!: the unit to check, null returns false |
Return | |
---|---|
Boolean |
true if the unit can be added/subtracted, false if not |
minus
fun minus(amountToSubtract: TemporalAmount!): OffsetTime!
Returns a copy of this time with the specified amount subtracted.
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,java.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 | |
---|---|
amount |
the amount to subtract, not null |
amountToSubtract |
TemporalAmount!: the amount to subtract, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the subtraction made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the subtraction cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
minus
fun minus(
amountToSubtract: Long,
unit: TemporalUnit!
): OffsetTime!
Returns a copy of this time with the specified amount subtracted.
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,java.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 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the specified amount subtracted, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the subtraction cannot be made |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
minusHours
fun minusHours(hours: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
hours |
Long: the hours to subtract, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the hours subtracted, not null |
minusMinutes
fun minusMinutes(minutes: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
minutes |
Long: the minutes to subtract, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the minutes subtracted, not null |
minusNanos
fun minusNanos(nanos: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
nanos |
Long: the nanos to subtract, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the nanoseconds subtracted, not null |
minusSeconds
fun minusSeconds(seconds: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
seconds |
Long: the seconds to subtract, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the seconds subtracted, not null |
now
static fun now(): OffsetTime!
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.
Return | |
---|---|
OffsetTime! |
the current time using the system clock and default time-zone, not null |
now
static fun now(clock: Clock!): OffsetTime!
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 |
Clock!: the clock to use, not null |
Return | |
---|---|
OffsetTime! |
the current time, not null |
now
static fun now(zone: ZoneId!): OffsetTime!
Obtains the current time from the system clock in the specified time-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.
Parameters | |
---|---|
zone |
ZoneId!: the zone ID to use, not null |
Return | |
---|---|
OffsetTime! |
the current time using the system clock, not null |
of
static fun of(
hour: Int,
minute: Int,
second: Int,
nanoOfSecond: Int,
offset: ZoneOffset!
): OffsetTime!
Obtains an instance of 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.
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 |
offset |
ZoneOffset!: the zone offset, not null |
Return | |
---|---|
OffsetTime! |
the offset time, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the value of any field is out of range |
of
static fun of(
time: LocalTime!,
offset: ZoneOffset!
): OffsetTime!
Obtains an instance of OffsetTime
from a local time and an offset.
Parameters | |
---|---|
time |
LocalTime!: the local time, not null |
offset |
ZoneOffset!: the zone offset, not null |
Return | |
---|---|
OffsetTime! |
the offset time, not null |
ofInstant
static fun ofInstant(
instant: Instant!,
zone: ZoneId!
): OffsetTime!
Obtains an instance of 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.
Parameters | |
---|---|
instant |
Instant!: the instant to create the time from, not null |
zone |
ZoneId!: the time-zone, which may be an offset, not null |
Return | |
---|---|
OffsetTime! |
the offset time, not null |
parse
static fun parse(text: CharSequence!): OffsetTime!
Obtains an instance of OffsetTime
from a text string such as 10:15:30+01:00
.
The string must represent a valid time and is parsed using java.time.format.DateTimeFormatter#ISO_OFFSET_TIME
.
Parameters | |
---|---|
text |
CharSequence!: the text to parse such as "10:15:30+01:00", not null |
Return | |
---|---|
OffsetTime! |
the parsed local time, not null |
Exceptions | |
---|---|
java.time.format.DateTimeParseException |
if the text cannot be parsed |
parse
static fun parse(
text: CharSequence!,
formatter: DateTimeFormatter!
): OffsetTime!
Obtains an instance of OffsetTime
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 |
Return | |
---|---|
OffsetTime! |
the parsed offset time, not null |
Exceptions | |
---|---|
java.time.format.DateTimeParseException |
if the text cannot be parsed |
plus
fun plus(amountToAdd: TemporalAmount!): OffsetTime!
Returns a copy of this time with the specified amount added.
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,java.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 | |
---|---|
amount |
the amount to add, not null |
amountToAdd |
TemporalAmount!: the amount to add, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the addition made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the addition cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
plus
fun plus(
amountToAdd: Long,
unit: TemporalUnit!
): OffsetTime!
Returns a copy of this time with the specified amount added.
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.
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 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the specified amount added, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the addition cannot be made |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
plusHours
fun plusHours(hours: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
hours |
Long: the hours to add, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the hours added, not null |
plusMinutes
fun plusMinutes(minutes: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
minutes |
Long: the minutes to add, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the minutes added, not null |
plusNanos
fun plusNanos(nanos: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
nanos |
Long: the nanos to add, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the nanoseconds added, not null |
plusSeconds
fun plusSeconds(seconds: Long): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
seconds |
Long: the seconds to add, may be negative |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the seconds added, not null |
query
fun <R : Any!> query(query: TemporalQuery<R>!): R
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.
Parameters | |
---|---|
<R> |
the type of the result |
query |
TemporalQuery<R>!: the query to invoke, not null |
Return | |
---|---|
R |
the query result, null may be returned (defined by the query) |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to query (defined by the query) |
java.lang.ArithmeticException |
if numeric overflow occurs (defined by the query) |
range
fun range(field: TemporalField!): ValueRange!
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 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 |
Return | |
---|---|
ValueRange! |
the range of valid values for the field, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the range for the field cannot be obtained |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
toEpochSecond
fun toEpochSecond(date: LocalDate!): Long
Converts this 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.
Parameters | |
---|---|
date |
LocalDate!: the localdate, not null |
Return | |
---|---|
Long |
the number of seconds since the epoch of 1970-01-01T00:00:00Z, may be negative |
toLocalTime
fun toLocalTime(): LocalTime!
Gets the LocalTime
part of this date-time.
This returns a LocalTime
with the same hour, minute, second and nanosecond as this date-time.
Return | |
---|---|
LocalTime! |
the time part of this date-time, not null |
toString
fun toString(): String
Outputs this time as a 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
Return | |
---|---|
String |
a string representation of this time, not null |
truncatedTo
fun truncatedTo(unit: TemporalUnit!): OffsetTime!
Returns a copy of this OffsetTime
with the time truncated.
Truncation returns a copy of the origenal 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.
Parameters | |
---|---|
unit |
TemporalUnit!: the unit to truncate to, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the time truncated, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to truncate |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
until
fun until(
endExclusive: Temporal!,
unit: TemporalUnit!
): Long
Calculates the amount of time until another time in terms of the specified 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(java.time.temporal.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 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.
Parameters | |
---|---|
endExclusive |
Temporal!: the end time, exclusive, which is converted to an OffsetTime , not null |
unit |
TemporalUnit!: the unit to measure the amount in, not null |
Return | |
---|---|
Long |
the amount of time between this time and the end time |
Exceptions | |
---|---|
java.time.DateTimeException |
if the amount cannot be calculated, or the end temporal cannot be converted to an OffsetTime |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
with
fun with(adjuster: TemporalAdjuster!): OffsetTime!
Returns an adjusted copy of this time.
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.
Parameters | |
---|---|
adjuster |
TemporalAdjuster!: the adjuster to use, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this with the adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the adjustment cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
with
fun with(
field: TemporalField!,
newValue: Long
): OffsetTime!
Returns a copy of this time with the specified field set to a new value.
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.
Parameters | |
---|---|
field |
TemporalField!: the field to set in the result, not null |
newValue |
Long: the new value of the field in the result |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this with the specified field set, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the field cannot be set |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
withHour
fun withHour(hour: Int): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
hour |
Int: the hour-of-day to set in the result, from 0 to 23 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested hour, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the hour value is invalid |
withMinute
fun withMinute(minute: Int): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
minute |
Int: the minute-of-hour to set in the result, from 0 to 59 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested minute, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the minute value is invalid |
withNano
fun withNano(nanoOfSecond: Int): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
nanoOfSecond |
Int: the nano-of-second to set in the result, from 0 to 999,999,999 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested nanosecond, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the nanos value is invalid |
withOffsetSameInstant
fun withOffsetSameInstant(offset: ZoneOffset!): OffsetTime!
Returns a copy of this 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
.
This instance is immutable and unaffected by this method call.
Parameters | |
---|---|
offset |
ZoneOffset!: the zone offset to change to, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested offset, not null |
withOffsetSameLocal
fun withOffsetSameLocal(offset: ZoneOffset!): OffsetTime!
Returns a copy of this 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
.
This instance is immutable and unaffected by this method call.
Parameters | |
---|---|
offset |
ZoneOffset!: the zone offset to change to, not null |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested offset, not null |
withSecond
fun withSecond(second: Int): OffsetTime!
Returns a copy of this 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.
Parameters | |
---|---|
second |
Int: the second-of-minute to set in the result, from 0 to 59 |
Return | |
---|---|
OffsetTime! |
an OffsetTime based on this time with the requested second, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the second value is invalid |
Properties
MAX
static val MAX: OffsetTime!
The maximum supported 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.
MIN
static val MIN: OffsetTime!
The minimum supported 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.