final class OffsetTime extends TemporalAccessor with Temporal with TemporalAdjuster with Ordered[OffsetTime] with Serializable
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
.
Specification for implementors
This class is immutable and thread-safe.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- OffsetTime
- Serializable
- Ordered
- Comparable
- TemporalAdjuster
- Temporal
- TemporalAccessor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
OffsetTime(time: LocalTime, offset: ZoneOffset)
- time
the local time, not null
- offset
the zone offset, not null
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
<(that: OffsetTime): Boolean
- Definition Classes
- Ordered
-
def
<=(that: OffsetTime): Boolean
- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
>(that: OffsetTime): Boolean
- Definition Classes
- Ordered
-
def
>=(that: OffsetTime): Boolean
- Definition Classes
- Ordered
-
def
adjustInto(temporal: Temporal): Temporal
Adjusts the specified temporal object to have the same offset and time as this object.
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
long)
twice, passingChronoField#NANO_OF_DAY
andChronoField#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.
- temporal
the target object to be adjusted, not null
- returns
the adjusted object, not null
- Definition Classes
- OffsetTime → TemporalAdjuster
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if unable to make the adjustment
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
atDate(date: LocalDate): OffsetDateTime
Combines this time with a date to create an
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.- date
the date to combine with, not null
- returns
the offset date-time formed from this time and the specified date, not null
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compare(other: OffsetTime): Int
Compares this
OffsetTime
to another time.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
Values #2 and #3 represent the same instant on the time-line. When two values represent the same instant, the local time is compared to distinguish them. This step is needed to make the ordering consistent withequals()
.
To compare the underlying local time of two
TemporalAccessor
instances, useChronoField#NANO_OF_DAY
as a comparator.- other
the other time to compare to, not null
- returns
the comparator value, negative if less, positive if greater
- Definition Classes
- OffsetTime → Ordered
- Exceptions thrown
NullPointerException
if { @code other} is null
-
def
compareTo(other: OffsetTime): Int
- Definition Classes
- OffsetTime → Ordered → Comparable
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
Checks if this time is equal to another time.
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(OffsetTime)
.Only objects of type
OffsetTime
are compared, other types return false. To compare the underlying local time of twoTemporalAccessor
instances, useChronoField#NANO_OF_DAY
as a comparator.- obj
the object to check, null returns false
- returns
true if this is equal to the other time
- Definition Classes
- OffsetTime → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
format(formatter: DateTimeFormatter): String
Outputs this time as a
String
using the formatter.Outputs this time as a
String
using the formatter.This time will be passed to the formatter
print method
.- formatter
the formatter to use, not null
- returns
the formatted time string, not null
- Exceptions thrown
DateTimeException
if an error occurs during printing
-
def
get(field: TemporalField): Int
Gets the value of the specified field from this time as an
int
.Gets the value of the specified field from this time as an
int
.This queries this time for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoField
then the query is implemented here. The#isSupported(TemporalField) supported fields
will return valid values based on this time, exceptNANO_OF_DAY
andMICRO_OF_DAY
which are too large to fit in anint
and throw aDateTimeException
. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- field
the field to get, not null
- returns
the value for the field
- Definition Classes
- OffsetTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if a value for the field cannot be obtained
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getHour: Int
Gets the hour-of-day field.
Gets the hour-of-day field.
- returns
the hour-of-day, from 0 to 23
-
def
getLong(field: TemporalField): Long
Gets the value of the specified field from this time as a
long
.Gets the value of the specified field from this time as a
long
.This queries this time for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoField
then the query is implemented here. The#isSupported(TemporalField) supported fields
will return valid values based on this time. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.- field
the field to get, not null
- returns
the value for the field
- Definition Classes
- OffsetTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if a value for the field cannot be obtained
-
def
getMinute: Int
Gets the minute-of-hour field.
Gets the minute-of-hour field.
- returns
the minute-of-hour, from 0 to 59
-
def
getNano: Int
Gets the nano-of-second field.
Gets the nano-of-second field.
- returns
the nano-of-second, from 0 to 999,999,999
-
def
getOffset: ZoneOffset
Gets the zone offset, such as '+01:00'.
Gets the zone offset, such as '+01:00'.
This is the offset of the local time from UTC/Greenwich.
- returns
the zone offset, not null
-
def
getSecond: Int
Gets the second-of-minute field.
Gets the second-of-minute field.
- returns
the second-of-minute, from 0 to 59
-
def
hashCode(): Int
A hash code for this time.
-
def
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.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.- other
the other time to compare to, not null
- returns
true if this is after the instant of the specified time
-
def
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.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.- other
the other time to compare to, not null
- returns
true if this is before the instant of the specified time
-
def
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.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.- other
the other time to compare to, not null
- returns
true if this is equal to the instant of the specified time
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isSupported(unit: TemporalUnit): Boolean
Checks if the specified unit is supported.
Checks if the specified unit is supported.
This checks if the date-time can be queried for the specified unit. If false, then calling the
plus
andminus
methods will throw an exception.Specification for implementors
Implementations must check and handle all fields defined in
ChronoUnit
. If the field is supported, then true is returned, otherwise falseIf the field is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.isSupportedBy(Temporal)
passingthis
as the argument.Implementations must not alter this object.
- unit
the unit to check, null returns false
- returns
true if this date-time can be queried for the unit, false if not
- Definition Classes
- OffsetTime → Temporal
-
def
isSupported(field: TemporalField): Boolean
Checks if the specified field is supported.
Checks if the specified field is supported.
This checks if this time can be queried for the specified field. If false, then calling the
range
andget
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
All otherChronoField
instances will return false.
If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.isSupportedBy(TemporalAccessor)
passingthis
as the argument. Whether the field is supported is determined by the field.- field
the field to check, null returns false
- returns
true if the field is supported on this time, false if not
- Definition Classes
- OffsetTime → TemporalAccessor
-
def
minus(amountToSubtract: Long, unit: TemporalUnit): OffsetTime
Returns a copy of this time with the specified period subtracted.
Returns a copy of this time with the specified period subtracted.
This method returns a new time based on this time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation. The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
- amountToSubtract
the amount of the unit to subtract from the result, may be negative
- unit
the unit of the period to subtract, not null
- returns
an { @code OffsetTime} based on this time with the specified period subtracted, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
minus(amount: TemporalAmount): OffsetTime
Returns a copy of this time with the specified period subtracted.
Returns a copy of this time with the specified period subtracted.
This method returns a new time based on this time with the specified period subtracted. The amount is typically
Period
but may be any other type implementing theTemporalAmount
interface. The calculation is delegated to the specified adjuster, which typically calls back toTemporalUnit)
. The offset is not part of the calculation and will be unchanged in the result.This instance is immutable and unaffected by this method call.
- amount
the amount to subtract, not null
- returns
an { @code OffsetTime} based on this time with the subtraction made, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the subtraction cannot be made
-
def
minusHours(hours: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in hours subtracted.Returns a copy of this
OffsetTime
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.
- hours
the hours to subtract, may be negative
- returns
an { @code OffsetTime} based on this time with the hours subtracted, not null
-
def
minusMinutes(minutes: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in minutes subtracted.Returns a copy of this
OffsetTime
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.
- minutes
the minutes to subtract, may be negative
- returns
an { @code OffsetTime} based on this time with the minutes subtracted, not null
-
def
minusNanos(nanos: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in nanoseconds subtracted.Returns a copy of this
OffsetTime
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.
- nanos
the nanos to subtract, may be negative
- returns
an { @code OffsetTime} based on this time with the nanoseconds subtracted, not null
-
def
minusSeconds(seconds: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in seconds subtracted.Returns a copy of this
OffsetTime
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.
- seconds
the seconds to subtract, may be negative
- returns
an { @code OffsetTime} based on this time with the seconds subtracted, not null
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
plus(amountToAdd: Long, unit: TemporalUnit): OffsetTime
Returns a copy of this time with the specified period added.
Returns a copy of this time with the specified period added.
This method returns a new time based on this time with the specified period added. This can be used to add any period that is defined by a unit, for example to add hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation. The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
- amountToAdd
the amount of the unit to add to the result, may be negative
- unit
the unit of the period to add, not null
- returns
an { @code OffsetTime} based on this time with the specified period added, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
plus(amount: TemporalAmount): OffsetTime
Returns a copy of this date with the specified period added.
Returns a copy of this date with the specified period added.
This method returns a new time based on this time with the specified period added. The amount is typically
Period
but may be any other type implementing theTemporalAmount
interface. The calculation is delegated to the specified adjuster, which typically calls back toTemporalUnit)
. The offset is not part of the calculation and will be unchanged in the result.This instance is immutable and unaffected by this method call.
- amount
the amount to add, not null
- returns
an { @code OffsetTime} based on this time with the addition made, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the addition cannot be made
-
def
plusHours(hours: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in hours added.Returns a copy of this
OffsetTime
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.
- hours
the hours to add, may be negative
- returns
an { @code OffsetTime} based on this time with the hours added, not null
-
def
plusMinutes(minutes: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in minutes added.Returns a copy of this
OffsetTime
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.
- minutes
the minutes to add, may be negative
- returns
an { @code OffsetTime} based on this time with the minutes added, not null
-
def
plusNanos(nanos: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in nanoseconds added.Returns a copy of this
OffsetTime
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.
- nanos
the nanos to add, may be negative
- returns
an { @code OffsetTime} based on this time with the nanoseconds added, not null
-
def
plusSeconds(seconds: Long): OffsetTime
Returns a copy of this
OffsetTime
with the specified period in seconds added.Returns a copy of this
OffsetTime
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.
- seconds
the seconds to add, may be negative
- returns
an { @code OffsetTime} based on this time with the seconds added, not null
-
def
query[R](query: TemporalQuery[R]): R
Queries this time using the specified query.
Queries this time using the specified query.
This queries this time using the specified query strategy object. The
TemporalQuery
object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.The result of this method is obtained by invoking the
TemporalQuery#queryFrom(TemporalAccessor)
method on the specified query passingthis
as the argument.- R
the type of the result
- query
the query to invoke, not null
- returns
the query result, null may be returned (defined by the query)
- Definition Classes
- OffsetTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occurs (defined by the query)DateTimeException
if unable to query (defined by the query)
-
def
range(field: TemporalField): ValueRange
Gets the range of valid values for the specified field.
Gets the range of valid values for the specified field.
The range object expresses the minimum and maximum valid values for a field. This time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a
ChronoField
then the query is implemented here. The#isSupported(TemporalField) supported fields
will return appropriate range instances. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)
passingthis
as the argument. Whether the range can be obtained is determined by the field.- field
the field to query the range for, not null
- returns
the range of valid values for the field, not null
- Definition Classes
- OffsetTime → TemporalAccessor
- Exceptions thrown
DateTimeException
if the range for the field cannot be obtained
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocalTime: LocalTime
Gets the
LocalTime
part of this date-time.Gets the
LocalTime
part of this date-time.This returns a
LocalTime
with the same hour, minute, second and nanosecond as this date-time.- returns
the time part of this date-time, not null
-
def
toString(): String
Outputs this time as a
String
, such as10:15:30+01:00
.Outputs this time as a
String
, such as10: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
The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.
- returns
a string representation of this time, not null
- Definition Classes
- OffsetTime → AnyRef → Any
-
def
truncatedTo(unit: TemporalUnit): OffsetTime
Returns a copy of this
OffsetTime
with the time truncated.Returns a copy of this
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
andDAYS
. 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 null
- returns
an { @code OffsetTime} based on this time with the time truncated, not null
- Exceptions thrown
DateTimeException
if unable to truncate
-
def
until(endExclusive: Temporal, unit: TemporalUnit): Long
Calculates the period between this time and another time in terms of the specified unit.
Calculates the period between this time and another time in terms of the specified unit.
This calculates the period between two times in terms of a single unit. The start and end points are
this
and the specified time. The result will be negative if the end is before the start. For example, the period in hours between two times can be calculated usingstartTime.until(endTime, HOURS)
.The
Temporal
passed to this method must be anOffsetTime
. 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 period in hours between 11:30Z and 13:29Z will only be one hour as it is one minute short of two hours.
This method operates in association with
TemporalUnit#between
. The result of this method is along
representing the amount of the specified unit. By contrast, the result ofbetween
is an object that can be used directly in addition/subtraction:long period = start.until(end, HOURS); // this method dateTime.plus(HOURS.between(start, end)); // use in plus/minus
The calculation is implemented in this method for
ChronoUnit
. The unitsNANOS
,MICROS
,MILLIS
,SECONDS
,MINUTES
,HOURS
andHALF_DAYS
are supported. OtherChronoUnit
values will throw an exception.If the unit is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.between(Temporal, Temporal)
passingthis
as the first argument and the input temporal as the second argument.This instance is immutable and unaffected by this method call.
- endExclusive
the end time, which is converted to an { @code OffsetTime}, not null
- unit
the unit to measure the period in, not null
- returns
the amount of the period between this time and the end time
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the period cannot be calculated
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
with(field: TemporalField, newValue: Long): OffsetTime
Returns a copy of this time with the specified field set to a new value.
Returns a copy of this time with the specified field set to a new value.
This returns a new
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 aDateTimeException
will be thrown.The other
supported fields
will behave as per the matching method onlong)
LocalTime}. In this case, the offset is not part of the calculation and will be unchanged.All other
ChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.adjustInto(Temporal, long)
passingthis
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.
- field
the field to set in the result, not null
- newValue
the new value of the field in the result
- returns
an { @code OffsetTime} based on { @code this} with the specified field set, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the field cannot be set
-
def
with(adjuster: TemporalAdjuster): OffsetTime
Returns an adjusted copy of this time.
Returns an adjusted copy of this time.
This returns a new
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
andZoneOffset
implementTemporalAdjuster
, 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 passingthis
as the argument.This instance is immutable and unaffected by this method call.
- adjuster
the adjuster to use, not null
- returns
an { @code OffsetTime} based on { @code this} with the adjustment made, not null
- Definition Classes
- OffsetTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the adjustment cannot be made
-
def
withHour(hour: Int): OffsetTime
Returns a copy of this
OffsetTime
with the hour-of-day value altered.Returns a copy of this
OffsetTime
with the hour-of-day value 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 23
- returns
an { @code OffsetTime} based on this time with the requested hour, not null
- Exceptions thrown
DateTimeException
if the hour value is invalid
-
def
withMinute(minute: Int): OffsetTime
Returns a copy of this
OffsetTime
with the minute-of-hour value altered.Returns a copy of this
OffsetTime
with the minute-of-hour value 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 59
- returns
an { @code OffsetTime} based on this time with the requested minute, not null
- Exceptions thrown
DateTimeException
if the minute value is invalid
-
def
withNano(nanoOfSecond: Int): OffsetTime
Returns a copy of this
OffsetTime
with the nano-of-second value altered.Returns a copy of this
OffsetTime
with the nano-of-second value 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,999
- returns
an { @code OffsetTime} based on this time with the requested nanosecond, not null
- Exceptions thrown
DateTimeException
if the nanos value is invalid
-
def
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.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 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
.This instance is immutable and unaffected by this method call.
- offset
the zone offset to change to, not null
- returns
an { @code OffsetTime} based on this time with the requested offset, not null
-
def
withOffsetSameLocal(offset: ZoneOffset): OffsetTime
Returns a copy of this
OffsetTime
with the specified offset ensuring that the result has the same local time.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 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
.This instance is immutable and unaffected by this method call.
- offset
the zone offset to change to, not null
- returns
an { @code OffsetTime} based on this time with the requested offset, not null
-
def
withSecond(second: Int): OffsetTime
Returns a copy of this
OffsetTime
with the second-of-minute value altered.Returns a copy of this
OffsetTime
with the second-of-minute value 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 59
- returns
an { @code OffsetTime} based on this time with the requested second, not null
- Exceptions thrown
DateTimeException
if the second value is invalid