OffsetTime

A time with an offset from UTC/Greenwich _in the ISO-8601 calendar system, such as {@code 10:15:30+01:00}. !(p) {@code 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 {@code OffsetTime}.

!(p) This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a> class; use of identity-sensitive operations (including reference equality ({@code ==}), identity hash code, or synchronization) on instances of {@code OffsetTime} may have unpredictable results and should be avoided. The {@code equals} method should be used for comparisons.

@implSpec This class is immutable and thread-safe.

@since 1.8

final
class OffsetTime : Temporal , TemporalAdjuster , Comparable!(OffsetTime) {}

Members

Functions

_with
OffsetTime _with(TemporalAdjuster adjuster)

Returns an adjusted copy of this time. !(p) This returns an {@code 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. !(p) 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. !(p) The classes {@link LocalTime} and {@link ZoneOffset} implement {@code TemporalAdjuster}, thus this method can be used to change the time or offset: !(pre) result = offsetTime._with(time); result = offsetTime._with(offset); </pre> !(p) The result of this method is obtained by invoking the {@link TemporalAdjuster#adjustInto(Temporal)} method on the specified adjuster passing {@code this} as the argument. !(p) This instance is immutable and unaffected by this method call.

_with
OffsetTime _with(TemporalField field, long newValue)

Returns a copy of this time with the specified field set to a new value. !(p) This returns an {@code 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. !(p) If the field is a {@link ChronoField} then the adjustment is implemented here. !(p) The {@code 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 {@code DateTimeException} will be thrown. !(p) The other {@link #isSupported(TemporalField) supported fields} will behave as per the matching method on {@link LocalTime#_with(TemporalField, long)} LocalTime}. In this case, the offset is not part of the calculation and will be unchanged. !(p) All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.adjustInto(Temporal, long)} passing {@code this} as the argument. In this case, the field determines whether and how to adjust the instant. !(p) This instance is immutable and unaffected by this method call.

adjustInto
Temporal adjustInto(Temporal temporal)

Adjusts the specified temporal object to have the same offset and time as this object. !(p) 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. !(p) The adjustment is equivalent to using {@link Temporal#_with(TemporalField, long)} twice, passing {@link ChronoField#NANO_OF_DAY} and {@link ChronoField#OFFSET_SECONDS} as the fields. !(p) In most cases, it is clearer to reverse the calling pattern by using {@link Temporal#_with(TemporalAdjuster)}: !(pre) // these two lines are equivalent, but the second approach is recommended temporal = thisOffsetTime.adjustInto(temporal); temporal = temporal._with(thisOffsetTime); </pre> !(p) This instance is immutable and unaffected by this method call.

atDate
OffsetDateTime atDate(LocalDate date)

Combines this time with a date to create an {@code OffsetDateTime}. !(p) This returns an {@code OffsetDateTime} formed from this time and the specified date. All possible combinations of date and time are valid.

compareTo
int compareTo(OffsetTime other)

Compares this {@code OffsetTime} to another time. !(p) The comparison is based first on the UTC equivalent instant, then on the local time. It is "consistent with equals", as defined by {@link Comparable}. !(p) For example, the following is the comparator order: !(ol) !(li){@code 10:30+01:00}</li> !(li){@code 11:00+01:00}</li> !(li){@code 12:00+02:00}</li> !(li){@code 11:30+01:00}</li> !(li){@code 12:00+01:00}</li> !(li){@code 12:30+01:00}</li> </ol> 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 with {@code equals()}. !(p) To compare the underlying local time of two {@code TemporalAccessor} instances, use {@link ChronoField#NANO_OF_DAY} as a comparator.

get
int get(TemporalField field)

Gets the value of the specified field from this time as an {@code int}. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this time, except {@code NANO_OF_DAY} and {@code MICRO_OF_DAY} which are too large to fit _in an {@code int} and throw an {@code UnsupportedTemporalTypeException}. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getHour
int getHour()

Gets the hour-of-day field.

getLong
long getLong(TemporalField field)

Gets the value of the specified field from this time as a {@code long}. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this time. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getMinute
int getMinute()

Gets the minute-of-hour field.

getNano
int getNano()

Gets the nano-of-second field.

getOffset
ZoneOffset getOffset()

Gets the zone offset, such as '+01:00'. !(p) This is the offset of the local time from UTC/Greenwich.

getSecond
int getSecond()

Gets the second-of-minute field.

isAfter
bool isAfter(OffsetTime other)

Checks if the instant of this {@code OffsetTime} is after that of the specified time applying both times to a common date. !(p) This method differs from the comparison _in {@link #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.

isBefore
bool isBefore(OffsetTime other)

Checks if the instant of this {@code OffsetTime} is before that of the specified time applying both times to a common date. !(p) This method differs from the comparison _in {@link #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.

isEqual
bool isEqual(OffsetTime other)

Checks if the instant of this {@code OffsetTime} is equal to that of the specified time applying both times to a common date. !(p) This method differs from the comparison _in {@link #compareTo} and {@link #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.

isSupported
bool isSupported(TemporalField field)

Checks if the specified field is supported. !(p) This checks if this time can be queried for the specified field. If false, then calling the {@link #range(TemporalField) range}, {@link #get(TemporalField) get} and {@link #_with(TemporalField, long)} methods will throw an exception. !(p) If the field is a {@link ChronoField} then the query is implemented here. The supported fields are: !(ul) !(li){@code NANO_OF_SECOND} !(li){@code NANO_OF_DAY} !(li){@code MICRO_OF_SECOND} !(li){@code MICRO_OF_DAY} !(li){@code MILLI_OF_SECOND} !(li){@code MILLI_OF_DAY} !(li){@code SECOND_OF_MINUTE} !(li){@code SECOND_OF_DAY} !(li){@code MINUTE_OF_HOUR} !(li){@code MINUTE_OF_DAY} !(li){@code HOUR_OF_AMPM} !(li){@code CLOCK_HOUR_OF_AMPM} !(li){@code HOUR_OF_DAY} !(li){@code CLOCK_HOUR_OF_DAY} !(li){@code AMPM_OF_DAY} !(li){@code OFFSET_SECONDS} </ul> All other {@code ChronoField} instances will return false. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the field is supported is determined by the field.

isSupported
bool isSupported(TemporalUnit unit)

Checks if the specified unit is supported. !(p) This checks if the specified unit can be added to, or subtracted from, this offset-time. If false, then calling the {@link #plus(long, TemporalUnit)} and {@link #minus(long, TemporalUnit) minus} methods will throw an exception. !(p) If the unit is a {@link ChronoUnit} then the query is implemented here. The supported units are: !(ul) !(li){@code NANOS} !(li){@code MICROS} !(li){@code MILLIS} !(li){@code SECONDS} !(li){@code MINUTES} !(li){@code HOURS} !(li){@code HALF_DAYS} </ul> All other {@code ChronoUnit} instances will return false. !(p) If the unit is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)} passing {@code this} as the argument. Whether the unit is supported is determined by the unit.

minus
OffsetTime minus(TemporalAmount amountToSubtract)

Returns a copy of this time with the specified amount subtracted. !(p) This returns an {@code OffsetTime}, based on this one, with the specified amount subtracted. The amount is typically {@link Duration} but may be any other type implementing the {@link TemporalAmount} interface. !(p) The calculation is delegated to the amount object by calling {@link TemporalAmount#subtractFrom(Temporal)}. The amount implementation is free to implement the subtraction _in any way it wishes, however it typically calls back to {@link #minus(long, TemporalUnit)}. Consult the documentation of the amount implementation to determine if it can be successfully subtracted. !(p) This instance is immutable and unaffected by this method call.

minus
OffsetTime minus(long amountToSubtract, TemporalUnit unit)

Returns a copy of this time with the specified amount subtracted. !(p) This returns an {@code 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. !(p) This method is equivalent to {@link #plus(long, TemporalUnit)} with the amount negated. See that method for a full description of how addition, and thus subtraction, works. !(p) This instance is immutable and unaffected by this method call.

minusHours
OffsetTime minusHours(long hours)

Returns a copy of this {@code OffsetTime} with the specified number of hours subtracted. !(p) This subtracts the specified number of hours from this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

minusMinutes
OffsetTime minusMinutes(long minutes)

Returns a copy of this {@code OffsetTime} with the specified number of minutes subtracted. !(p) This subtracts the specified number of minutes from this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

minusNanos
OffsetTime minusNanos(long nanos)

Returns a copy of this {@code OffsetTime} with the specified number of nanoseconds subtracted. !(p) This subtracts the specified number of nanoseconds from this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

minusSeconds
OffsetTime minusSeconds(long seconds)

Returns a copy of this {@code OffsetTime} with the specified number of seconds subtracted. !(p) This subtracts the specified number of seconds from this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

opCmp
int opCmp(OffsetTime other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object obj)

Checks if this time is equal to another time. !(p) The comparison is based on the local-time and the offset. To compare for the same instant on the time-line, use {@link #isEqual(OffsetTime)}. !(p) Only objects of type {@code OffsetTime} are compared, other types return false. To compare the underlying local time of two {@code TemporalAccessor} instances, use {@link ChronoField#NANO_OF_DAY} as a comparator.

plus
OffsetTime plus(TemporalAmount amountToAdd)

Returns a copy of this time with the specified amount added. !(p) This returns an {@code OffsetTime}, based on this one, with the specified amount added. The amount is typically {@link Duration} but may be any other type implementing the {@link TemporalAmount} interface. !(p) The calculation is delegated to the amount object by calling {@link TemporalAmount#addTo(Temporal)}. The amount implementation is free to implement the addition _in any way it wishes, however it typically calls back to {@link #plus(long, TemporalUnit)}. Consult the documentation of the amount implementation to determine if it can be successfully added. !(p) This instance is immutable and unaffected by this method call.

plus
OffsetTime plus(long amountToAdd, TemporalUnit unit)

Returns a copy of this time with the specified amount added. !(p) This returns an {@code 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. !(p) If the field is a {@link ChronoUnit} then the addition is implemented by {@link LocalTime#plus(long, TemporalUnit)}. The offset is not part of the calculation and will be unchanged _in the result. !(p) If the field is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.addTo(Temporal, long)} passing {@code this} as the argument. In this case, the unit determines whether and how to perform the addition. !(p) This instance is immutable and unaffected by this method call.

plusHours
OffsetTime plusHours(long hours)

Returns a copy of this {@code OffsetTime} with the specified number of hours added. !(p) This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

plusMinutes
OffsetTime plusMinutes(long minutes)

Returns a copy of this {@code OffsetTime} with the specified number of minutes added. !(p) This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

plusNanos
OffsetTime plusNanos(long nanos)

Returns a copy of this {@code OffsetTime} with the specified number of nanoseconds added. !(p) This adds the specified number of nanoseconds to this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

plusSeconds
OffsetTime plusSeconds(long seconds)

Returns a copy of this {@code OffsetTime} with the specified number of seconds added. !(p) This adds the specified number of seconds to this time, returning a new time. The calculation wraps around midnight. !(p) This instance is immutable and unaffected by this method call.

query
R query(TemporalQuery!(R) query)

Queries this time using the specified query. !(p) This queries this time using the specified query strategy object. The {@code 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. !(p) The result of this method is obtained by invoking the {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the specified query passing {@code this} as the argument.

range
ValueRange range(TemporalField field)

Gets the range of valid values for the specified field. !(p) 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. !(p) If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return appropriate range instances. All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}. !(p) If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the range can be obtained is determined by the field.

super_get
int super_get(TemporalField field)
Undocumented in source. Be warned that the author may not have intended to support it.
toEpochSecond
long toEpochSecond(LocalDate date)

Converts this {@code OffsetTime} to the number of seconds since the epoch of 1970-01-01T00:00:00Z. !(p) 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.

toHash
size_t toHash()

A hash code for this time.

toLocalTime
LocalTime toLocalTime()

Gets the {@code LocalTime} part of this date-time. !(p) This returns a {@code LocalTime} with the same hour, minute, second and nanosecond as this date-time.

toString
string toString()

Outputs this time as a {@code string}, such as {@code 10:15:30+01:00}. !(p) The output will be one of the following ISO-8601 formats: !(ul) !(li){@code HH:mmXXXXX}</li> !(li){@code HH:mm:ssXXXXX}</li> !(li){@code HH:mm:ss.SSSXXXXX}</li> !(li){@code HH:mm:ss.SSSSSSXXXXX}</li> !(li){@code HH:mm:ss.SSSSSSSSSXXXXX}</li> </ul> The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.

truncatedTo
OffsetTime truncatedTo(TemporalUnit unit)

Returns a copy of this {@code OffsetTime} with the time truncated. !(p) Truncation returns a copy of the original time with fields smaller than the specified unit set to zero. For example, truncating with the {@link ChronoUnit#MINUTES minutes} unit will set the second-of-minute and nano-of-second field to zero. !(p) The unit must have a {@linkplain TemporalUnit#getDuration() duration} that divides into the length of a standard day without remainder. This includes all supplied time units on {@link ChronoUnit} and {@link ChronoUnit#DAYS DAYS}. Other units throw an exception. !(p) The offset does not affect the calculation and will be the same _in the result. !(p) This instance is immutable and unaffected by this method call.

until
long until(Temporal endExclusive, TemporalUnit unit)

Calculates the amount of time until another time _in terms of the specified unit. !(p) This calculates the amount of time between two {@code OffsetTime} objects _in terms of a single {@code TemporalUnit}. The start and end points are {@code 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 {@code startTime.until(endTime, HOURS)}. !(p) The {@code Temporal} passed to this method is converted to a {@code OffsetTime} using {@link #from(TemporalAccessor)}. If the offset differs between the two times, then the specified end time is normalized to have the same offset as this time. !(p) 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. !(p) There are two equivalent ways of using this method. The first is to invoke this method. The second is to use {@link TemporalUnit#between(Temporal, Temporal)}: !(pre) // these two lines are equivalent amount = start.until(end, MINUTES); amount = MINUTES.between(start, end); </pre> The choice should be made based on which makes the code more readable. !(p) The calculation is implemented _in this method for {@link ChronoUnit}. The units {@code NANOS}, {@code MICROS}, {@code MILLIS}, {@code SECONDS}, {@code MINUTES}, {@code HOURS} and {@code HALF_DAYS} are supported. Other {@code ChronoUnit} values will throw an exception. !(p) If the unit is not a {@code ChronoUnit}, then the result of this method is obtained by invoking {@code TemporalUnit.between(Temporal, Temporal)} passing {@code this} as the first argument and the converted input temporal as the second argument. !(p) This instance is immutable and unaffected by this method call.

withHour
OffsetTime withHour(int hour)

Returns a copy of this {@code OffsetTime} with the hour-of-day altered. !(p) The offset does not affect the calculation and will be the same _in the result. !(p) This instance is immutable and unaffected by this method call.

withMinute
OffsetTime withMinute(int minute)

Returns a copy of this {@code OffsetTime} with the minute-of-hour altered. !(p) The offset does not affect the calculation and will be the same _in the result. !(p) This instance is immutable and unaffected by this method call.

withNano
OffsetTime withNano(int nanoOfSecond)

Returns a copy of this {@code OffsetTime} with the nano-of-second altered. !(p) The offset does not affect the calculation and will be the same _in the result. !(p) This instance is immutable and unaffected by this method call.

withOffsetSameInstant
OffsetTime withOffsetSameInstant(ZoneOffset offset)

Returns a copy of this {@code OffsetTime} with the specified offset ensuring that the result is at the same instant on an implied day. !(p) This method returns an object with the specified {@code ZoneOffset} and a {@code 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 {@code 10:30+02:00} and the offset specified is {@code +03:00}, then this method will return {@code 11:30+03:00}. !(p) To change the offset without adjusting the local time use {@link #withOffsetSameLocal}. !(p) This instance is immutable and unaffected by this method call.

withOffsetSameLocal
OffsetTime withOffsetSameLocal(ZoneOffset offset)

Returns a copy of this {@code OffsetTime} with the specified offset ensuring that the result has the same local time. !(p) This method returns an object with the same {@code LocalTime} and the specified {@code ZoneOffset}. No calculation is needed or performed. For example, if this time represents {@code 10:30+02:00} and the offset specified is {@code +03:00}, then this method will return {@code 10:30+03:00}. !(p) To take into account the difference between the offsets, and adjust the time fields, use {@link #withOffsetSameInstant}. !(p) This instance is immutable and unaffected by this method call.

withSecond
OffsetTime withSecond(int second)

Returns a copy of this {@code OffsetTime} with the second-of-minute altered. !(p) The offset does not affect the calculation and will be the same _in the result. !(p) This instance is immutable and unaffected by this method call.

Static functions

MAX
OffsetTime MAX()

The maximum supported {@code 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 {@link LocalTime#MAX} and {@link ZoneOffset#MIN}. This could be used by an application as a "far future" date.

MIN
OffsetTime MIN()

The minimum supported {@code 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 {@link LocalTime#MIN} and {@link ZoneOffset#MAX}. This could be used by an application as a "far past" date.

from
OffsetTime from(TemporalAccessor temporal)

Obtains an instance of {@code OffsetTime} from a temporal object. !(p) This obtains an offset time based on the specified temporal. A {@code TemporalAccessor} represents an arbitrary set of date and time information, which this factory converts to an instance of {@code OffsetTime}. !(p) The conversion extracts and combines the {@code ZoneOffset} and the {@code LocalTime} from the temporal object. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects. !(p) This method matches the signature of the functional interface {@link TemporalQuery} allowing it to be used as a query via method reference, {@code OffsetTime::from}.

now
OffsetTime now()

Obtains the current time from the system clock _in the default time-zone. !(p) This will query the {@link Clock#systemDefaultZone() system clock} _in the default time-zone to obtain the current time. The offset will be calculated from the time-zone _in the clock. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

now
OffsetTime now(ZoneId zone)

Obtains the current time from the system clock _in the specified time-zone. !(p) This will query the {@link Clock#system(ZoneId) 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. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

now
OffsetTime now(Clock clock)

Obtains the current time from the specified clock. !(p) This will query the specified clock to obtain the current time. The offset will be calculated from the time-zone _in the clock. !(p) Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using {@link Clock dependency injection}.

of
OffsetTime of(LocalTime time, ZoneOffset offset)

Obtains an instance of {@code OffsetTime} from a local time and an offset.

of
OffsetTime of(int hour, int minute, int second, int nanoOfSecond, ZoneOffset offset)

Obtains an instance of {@code OffsetTime} from an hour, minute, second and nanosecond. !(p) This creates an offset time with the four specified fields. !(p) This method exists primarily for writing test cases. Non test-code will typically use other methods to create an offset time. {@code 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.

ofInstant
OffsetTime ofInstant(Instant instant, ZoneId zone)

Obtains an instance of {@code OffsetTime} from an {@code Instant} and zone ID. !(p) 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. !(p) 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.

Inherited Members

From Temporal

isSupported
bool isSupported(TemporalUnit unit)

Checks if the specified unit is supported. !(p) This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the {@link #plus(long, TemporalUnit)} and {@link #minus(long, TemporalUnit) minus} methods will throw an exception.

isSupported
bool isSupported(TemporalField field)
Undocumented in source.
_with
Temporal _with(TemporalAdjuster adjuster)

Returns an adjusted object of the same type as this object with the adjustment made. !(p) This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided _in {@link hunt.time.temporal.TemporalAdjusters TemporalAdjusters}. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years. !(p) Some example code indicating how and why this method is used: !(pre) date = date._with(Month.JULY); // most key classes implement TemporalAdjuster date = date._with(lastDayOfMonth()); // static import from Adjusters date = date._with(next(WEDNESDAY)); // static import from Adjusters and DayOfWeek </pre>

_with
Temporal _with(TemporalField field, long newValue)

Returns an object of the same type as this object with the specified field altered. !(p) This returns a new object based on this one with the value for the specified field changed. For example, on a {@code LocalDate}, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object. !(p) In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February _in this example.

plus
Temporal plus(TemporalAmount amount)

Returns an object of the same type as this object with an amount added. !(p) This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a {@link hunt.time.Period} but may be any other type implementing the {@link TemporalAmount} interface, such as {@link hunt.time.Duration}. !(p) Some example code indicating how and why this method is used: !(pre) date = date.plus(period); // add a Period instance date = date.plus(duration); // add a Duration instance date = date.plus(workingDays(6)); // example user-written workingDays method </pre> !(p) Note that calling {@code plus} followed by {@code minus} is not guaranteed to return the same date-time.

plus
Temporal plus(long amountToAdd, TemporalUnit unit)

Returns an object of the same type as this object with the specified period added. !(p) This method returns a new object based on this one with the specified period added. For example, on a {@code LocalDate}, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object. !(p) In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February _in this example.

minus
Temporal minus(TemporalAmount amount)

Returns an object of the same type as this object with an amount subtracted. !(p) This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a {@link hunt.time.Period} but may be any other type implementing the {@link TemporalAmount} interface, such as {@link hunt.time.Duration}. !(p) Some example code indicating how and why this method is used: !(pre) date = date.minus(period); // subtract a Period instance date = date.minus(duration); // subtract a Duration instance date = date.minus(workingDays(6)); // example user-written workingDays method </pre> !(p) Note that calling {@code plus} followed by {@code minus} is not guaranteed to return the same date-time.

minus
Temporal minus(long amountToSubtract, TemporalUnit unit)

Returns an object of the same type as this object with the specified period subtracted. !(p) This method returns a new object based on this one with the specified period subtracted. For example, on a {@code LocalDate}, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object. !(p) In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February _in this example.

until
long until(Temporal endExclusive, TemporalUnit unit)

Calculates the amount of time until another temporal _in terms of the specified unit. !(p) This calculates the amount of time between two temporal objects _in terms of a single {@code TemporalUnit}. The start and end points are {@code this} and the specified temporal. The end point is converted to be of the same type as the start point if different. The result will be negative if the end is before the start. For example, the amount _in hours between two temporal objects can be calculated using {@code startTime.until(endTime, HOURS)}. !(p) The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the amount _in hours between the times 11:30 and 13:29 will only be one hour as it is one minute short of two hours. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link TemporalUnit#between(Temporal, Temporal)}: !(pre) // these two lines are equivalent temporal = start.until(end, unit); temporal = unit.between(start, end); </pre> The choice should be made based on which makes the code more readable. !(p) For example, this method allows the number of days between two dates to be calculated: !(pre) long daysBetween = start.until(end, DAYS); // or alternatively long daysBetween = DAYS.between(start, end); </pre>

From TemporalAdjuster

adjustInto
Temporal adjustInto(Temporal temporal)

Adjusts the specified temporal object. !(p) This adjusts the specified temporal object using the logic encapsulated _in the implementing class. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link Temporal#_with(TemporalAdjuster)}: !(pre) // these two lines are equivalent, but the second approach is recommended temporal = thisAdjuster.adjustInto(temporal); temporal = temporal._with(thisAdjuster); </pre> It is recommended to use the second approach, {@code _with(TemporalAdjuster)}, as it is a lot clearer to read _in code.

Meta