org.threeten.bp.OffsetTime Maven / Gradle / Ivy
Show all versions of threetenbp Show documentation
/*
* Copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of JSR-310 nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.threeten.bp;
import static org.threeten.bp.LocalTime.NANOS_PER_HOUR;
import static org.threeten.bp.LocalTime.NANOS_PER_MINUTE;
import static org.threeten.bp.LocalTime.NANOS_PER_SECOND;
import static org.threeten.bp.LocalTime.SECONDS_PER_DAY;
import static org.threeten.bp.temporal.ChronoField.NANO_OF_DAY;
import static org.threeten.bp.temporal.ChronoField.OFFSET_SECONDS;
import static org.threeten.bp.temporal.ChronoUnit.NANOS;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectStreamException;
import java.io.Serializable;
import org.threeten.bp.format.DateTimeFormatter;
import org.threeten.bp.format.DateTimeParseException;
import org.threeten.bp.jdk8.DefaultInterfaceTemporalAccessor;
import org.threeten.bp.jdk8.Jdk8Methods;
import org.threeten.bp.temporal.ChronoField;
import org.threeten.bp.temporal.ChronoUnit;
import org.threeten.bp.temporal.Temporal;
import org.threeten.bp.temporal.TemporalAccessor;
import org.threeten.bp.temporal.TemporalAdjuster;
import org.threeten.bp.temporal.TemporalAmount;
import org.threeten.bp.temporal.TemporalField;
import org.threeten.bp.temporal.TemporalQueries;
import org.threeten.bp.temporal.TemporalQuery;
import org.threeten.bp.temporal.TemporalUnit;
import org.threeten.bp.temporal.UnsupportedTemporalTypeException;
import org.threeten.bp.temporal.ValueRange;
import org.threeten.bp.zone.ZoneRules;
/**
* A time with an offset from UTC/Greenwich in the ISO-8601 calendar system,
* such as {@code 10:15:30+01:00}.
*
* {@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}.
*
*
Specification for implementors
* This class is immutable and thread-safe.
*/
public final class OffsetTime
extends DefaultInterfaceTemporalAccessor
implements Temporal, TemporalAdjuster, Comparable, Serializable {
/**
* 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.
*/
public static final OffsetTime MIN = LocalTime.MIN.atOffset(ZoneOffset.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.
*/
public static final OffsetTime MAX = LocalTime.MAX.atOffset(ZoneOffset.MIN);
/**
* Simulate JDK 8 method reference OffsetTime::from.
*/
public static final TemporalQuery FROM = new TemporalQuery() {
@Override
public OffsetTime queryFrom(TemporalAccessor temporal) {
return OffsetTime.from(temporal);
}
};
/**
* Serialization version.
*/
private static final long serialVersionUID = 7264499704384272492L;
/**
* The local date-time.
*/
private final LocalTime time;
/**
* The offset from UTC/Greenwich.
*/
private final ZoneOffset offset;
//-----------------------------------------------------------------------
/**
* Obtains the current time from the system clock in the default time-zone.
*
* 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.
*
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @return the current time using the system clock, not null
*/
public static OffsetTime now() {
return now(Clock.systemDefaultZone());
}
/**
* Obtains the current time from the system clock in the specified time-zone.
*
* 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.
*
* Using this method will prevent the ability to use an alternate clock for testing
* because the clock is hard-coded.
*
* @param zone the zone ID to use, not null
* @return the current time using the system clock, not null
*/
public static OffsetTime now(ZoneId zone) {
return now(Clock.system(zone));
}
/**
* 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 {@link Clock dependency injection}.
*
* @param clock the clock to use, not null
* @return the current time, not null
*/
public static OffsetTime now(Clock clock) {
Jdk8Methods.requireNonNull(clock, "clock");
final Instant now = clock.instant(); // called once
return ofInstant(now, clock.getZone().getRules().getOffset(now));
}
//-----------------------------------------------------------------------
/**
* Obtains an instance of {@code OffsetTime} from a local time and an offset.
*
* @param time the local time, not null
* @param offset the zone offset, not null
* @return the offset time, not null
*/
public static OffsetTime of(LocalTime time, ZoneOffset offset) {
return new OffsetTime(time, offset);
}
/**
* Obtains an instance of {@code 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.
* {@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.
*
* @param hour the hour-of-day to represent, from 0 to 23
* @param minute the minute-of-hour to represent, from 0 to 59
* @param second the second-of-minute to represent, from 0 to 59
* @param nanoOfSecond the nano-of-second to represent, from 0 to 999,999,999
* @param offset the zone offset, not null
* @return the offset time, not null
* @throws DateTimeException if the value of any field is out of range
*/
public static OffsetTime of(int hour, int minute, int second, int nanoOfSecond, ZoneOffset offset) {
return new OffsetTime(LocalTime.of(hour, minute, second, nanoOfSecond), offset);
}
//-----------------------------------------------------------------------
/**
* Obtains an instance of {@code OffsetTime} from an {@code 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.
*
* @param instant the instant to create the time from, not null
* @param zone the time-zone, which may be an offset, not null
* @return the offset time, not null
*/
public static OffsetTime ofInstant(Instant instant, ZoneId zone) {
Jdk8Methods.requireNonNull(instant, "instant");
Jdk8Methods.requireNonNull(zone, "zone");
ZoneRules rules = zone.getRules();
ZoneOffset offset = rules.getOffset(instant);
long secsOfDay = instant.getEpochSecond() % SECONDS_PER_DAY;
secsOfDay = (secsOfDay + offset.getTotalSeconds()) % SECONDS_PER_DAY;
if (secsOfDay < 0) {
secsOfDay += SECONDS_PER_DAY;
}
LocalTime time = LocalTime.ofSecondOfDay(secsOfDay, instant.getNano());
return new OffsetTime(time, offset);
}
//-----------------------------------------------------------------------
/**
* Obtains an instance of {@code OffsetTime} from a temporal object.
*
* A {@code TemporalAccessor} represents some form of date and time information.
* This factory converts the arbitrary temporal object to an instance of {@code OffsetTime}.
*
* The conversion extracts and combines {@code LocalTime} and {@code ZoneOffset}.
*
* This method matches the signature of the functional interface {@link TemporalQuery}
* allowing it to be used in queries via method reference, {@code OffsetTime::from}.
*
* @param temporal the temporal object to convert, not null
* @return the offset time, not null
* @throws DateTimeException if unable to convert to an {@code OffsetTime}
*/
public static OffsetTime from(TemporalAccessor temporal) {
if (temporal instanceof OffsetTime) {
return (OffsetTime) temporal;
}
try {
LocalTime time = LocalTime.from(temporal);
ZoneOffset offset = ZoneOffset.from(temporal);
return new OffsetTime(time, offset);
} catch (DateTimeException ex) {
throw new DateTimeException("Unable to obtain OffsetTime from TemporalAccessor: " +
temporal + ", type " + temporal.getClass().getName());
}
}
//-----------------------------------------------------------------------
/**
* Obtains an instance of {@code OffsetTime} from a text string such as {@code 10:15:30+01:00}.
*
* The string must represent a valid time and is parsed using
* {@link org.threeten.bp.format.DateTimeFormatter#ISO_OFFSET_TIME}.
*
* @param text the text to parse such as "10:15:30+01:00", not null
* @return the parsed local time, not null
* @throws DateTimeParseException if the text cannot be parsed
*/
public static OffsetTime parse(CharSequence text) {
return parse(text, DateTimeFormatter.ISO_OFFSET_TIME);
}
/**
* Obtains an instance of {@code OffsetTime} from a text string using a specific formatter.
*
* The text is parsed using the formatter, returning a time.
*
* @param text the text to parse, not null
* @param formatter the formatter to use, not null
* @return the parsed offset time, not null
* @throws DateTimeParseException if the text cannot be parsed
*/
public static OffsetTime parse(CharSequence text, DateTimeFormatter formatter) {
Jdk8Methods.requireNonNull(formatter, "formatter");
return formatter.parse(text, OffsetTime.FROM);
}
//-----------------------------------------------------------------------
/**
* Constructor.
*
* @param time the local time, not null
* @param offset the zone offset, not null
*/
private OffsetTime(LocalTime time, ZoneOffset offset) {
this.time = Jdk8Methods.requireNonNull(time, "time");
this.offset = Jdk8Methods.requireNonNull(offset, "offset");
}
/**
* Returns a new time based on this one, returning {@code this} where possible.
*
* @param time the time to create with, not null
* @param offset the zone offset to create with, not null
*/
private OffsetTime with(LocalTime time, ZoneOffset offset) {
if (this.time == time && this.offset.equals(offset)) {
return this;
}
return new OffsetTime(time, offset);
}
//-----------------------------------------------------------------------
/**
* Checks if the specified field is supported.
*
* This checks if this time can be queried for the specified field.
* If false, then calling the {@link #range(TemporalField) range} and
* {@link #get(TemporalField) get} methods will throw an exception.
*
* If the field is a {@link ChronoField} then the query is implemented here.
* The supported fields are:
*
* - {@code NANO_OF_SECOND}
*
- {@code NANO_OF_DAY}
*
- {@code MICRO_OF_SECOND}
*
- {@code MICRO_OF_DAY}
*
- {@code MILLI_OF_SECOND}
*
- {@code MILLI_OF_DAY}
*
- {@code SECOND_OF_MINUTE}
*
- {@code SECOND_OF_DAY}
*
- {@code MINUTE_OF_HOUR}
*
- {@code MINUTE_OF_DAY}
*
- {@code HOUR_OF_AMPM}
*
- {@code CLOCK_HOUR_OF_AMPM}
*
- {@code HOUR_OF_DAY}
*
- {@code CLOCK_HOUR_OF_DAY}
*
- {@code AMPM_OF_DAY}
*
- {@code OFFSET_SECONDS}
*
* All other {@code ChronoField} instances will return false.
*
* 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.
*
* @param field the field to check, null returns false
* @return true if the field is supported on this time, false if not
*/
@Override
public boolean isSupported(TemporalField field) {
if (field instanceof ChronoField) {
return field.isTimeBased() || field == OFFSET_SECONDS;
}
return field != null && field.isSupportedBy(this);
}
@Override
public boolean isSupported(TemporalUnit unit) {
if (unit instanceof ChronoUnit) {
return unit.isTimeBased();
}
return unit != null && unit.isSupportedBy(this);
}
/**
* 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 {@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 a {@code DateTimeException}.
*
* 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.
*
* @param field the field to query the range for, not null
* @return the range of valid values for the field, not null
* @throws DateTimeException if the range for the field cannot be obtained
*/
@Override
public ValueRange range(TemporalField field) {
if (field instanceof ChronoField) {
if (field == OFFSET_SECONDS) {
return field.range();
}
return time.range(field);
}
return field.rangeRefinedBy(this);
}
/**
* Gets the value of the specified field from this time as an {@code 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 {@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 a {@code DateTimeException}.
* All other {@code ChronoField} instances will throw a {@code DateTimeException}.
*
* 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.
*
* @param field the field to get, not null
* @return the value for the field
* @throws DateTimeException if a value for the field cannot be obtained
* @throws ArithmeticException if numeric overflow occurs
*/
@Override // override for Javadoc
public int get(TemporalField field) {
return super.get(field);
}
/**
* Gets the value of the specified field from this time as a {@code 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 {@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 a {@code DateTimeException}.
*
* 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.
*
* @param field the field to get, not null
* @return the value for the field
* @throws DateTimeException if a value for the field cannot be obtained
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public long getLong(TemporalField field) {
if (field instanceof ChronoField) {
if (field == OFFSET_SECONDS) {
return getOffset().getTotalSeconds();
}
return time.getLong(field);
}
return field.getFrom(this);
}
//-----------------------------------------------------------------------
/**
* Gets the zone offset, such as '+01:00'.
*
* This is the offset of the local time from UTC/Greenwich.
*
* @return the zone offset, not null
*/
public ZoneOffset getOffset() {
return offset;
}
/**
* Returns a copy of this {@code OffsetTime} with the specified offset ensuring
* that the result has the same local time.
*
* 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}.
*
* To take into account the difference between the offsets, and adjust the time fields,
* use {@link #withOffsetSameInstant}.
*
* This instance is immutable and unaffected by this method call.
*
* @param offset the zone offset to change to, not null
* @return an {@code OffsetTime} based on this time with the requested offset, not null
*/
public OffsetTime withOffsetSameLocal(ZoneOffset offset) {
return offset != null && offset.equals(this.offset) ? this : new OffsetTime(time, 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.
*
* 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}.
*
* To change the offset without adjusting the local time use {@link #withOffsetSameLocal}.
*
* This instance is immutable and unaffected by this method call.
*
* @param offset the zone offset to change to, not null
* @return an {@code OffsetTime} based on this time with the requested offset, not null
*/
public OffsetTime withOffsetSameInstant(ZoneOffset offset) {
if (offset.equals(this.offset)) {
return this;
}
int difference = offset.getTotalSeconds() - this.offset.getTotalSeconds();
LocalTime adjusted = time.plusSeconds(difference);
return new OffsetTime(adjusted, offset);
}
//-----------------------------------------------------------------------
/**
* Gets the hour-of-day field.
*
* @return the hour-of-day, from 0 to 23
*/
public int getHour() {
return time.getHour();
}
/**
* Gets the minute-of-hour field.
*
* @return the minute-of-hour, from 0 to 59
*/
public int getMinute() {
return time.getMinute();
}
/**
* Gets the second-of-minute field.
*
* @return the second-of-minute, from 0 to 59
*/
public int getSecond() {
return time.getSecond();
}
/**
* Gets the nano-of-second field.
*
* @return the nano-of-second, from 0 to 999,999,999
*/
public int getNano() {
return time.getNano();
}
//-----------------------------------------------------------------------
/**
* Returns an adjusted copy of this time.
*
* This returns a new {@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.
*
* 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 {@link LocalTime} and {@link ZoneOffset} implement {@code 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
* {@link TemporalAdjuster#adjustInto(Temporal)} method on the
* specified adjuster passing {@code this} as the argument.
*
* This instance is immutable and unaffected by this method call.
*
* @param adjuster the adjuster to use, not null
* @return an {@code OffsetTime} based on {@code this} with the adjustment made, not null
* @throws DateTimeException if the adjustment cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public OffsetTime with(TemporalAdjuster adjuster) {
// optimizations
if (adjuster instanceof LocalTime) {
return with((LocalTime) adjuster, offset);
} else if (adjuster instanceof ZoneOffset) {
return with(time, (ZoneOffset) adjuster);
} else if (adjuster instanceof OffsetTime) {
return (OffsetTime) adjuster;
}
return (OffsetTime) adjuster.adjustInto(this);
}
/**
* Returns a copy of this time with the specified field set to a new value.
*
* This returns a new {@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.
*
* If the field is a {@link ChronoField} then the adjustment is implemented here.
*
* 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.
*
* 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.
*
* All other {@code ChronoField} instances will throw a {@code DateTimeException}.
*
* 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.
*
* This instance is immutable and unaffected by this method call.
*
* @param field the field to set in the result, not null
* @param newValue the new value of the field in the result
* @return an {@code OffsetTime} based on {@code this} with the specified field set, not null
* @throws DateTimeException if the field cannot be set
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public OffsetTime with(TemporalField field, long newValue) {
if (field instanceof ChronoField) {
if (field == OFFSET_SECONDS) {
ChronoField f = (ChronoField) field;
return with(time, ZoneOffset.ofTotalSeconds(f.checkValidIntValue(newValue)));
}
return with(time.with(field, newValue), offset);
}
return field.adjustInto(this, newValue);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this {@code 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.
*
* @param hour the hour-of-day to set in the result, from 0 to 23
* @return an {@code OffsetTime} based on this time with the requested hour, not null
* @throws DateTimeException if the hour value is invalid
*/
public OffsetTime withHour(int hour) {
return with(time.withHour(hour), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param minute the minute-of-hour to set in the result, from 0 to 59
* @return an {@code OffsetTime} based on this time with the requested minute, not null
* @throws DateTimeException if the minute value is invalid
*/
public OffsetTime withMinute(int minute) {
return with(time.withMinute(minute), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param second the second-of-minute to set in the result, from 0 to 59
* @return an {@code OffsetTime} based on this time with the requested second, not null
* @throws DateTimeException if the second value is invalid
*/
public OffsetTime withSecond(int second) {
return with(time.withSecond(second), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param nanoOfSecond the nano-of-second to set in the result, from 0 to 999,999,999
* @return an {@code OffsetTime} based on this time with the requested nanosecond, not null
* @throws DateTimeException if the nanos value is invalid
*/
public OffsetTime withNano(int nanoOfSecond) {
return with(time.withNano(nanoOfSecond), offset);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this {@code 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 {@link ChronoUnit#MINUTES minutes} unit
* will set the second-of-minute and nano-of-second field to zero.
*
* 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.
*
* 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.
*
* @param unit the unit to truncate to, not null
* @return an {@code OffsetTime} based on this time with the time truncated, not null
* @throws DateTimeException if unable to truncate
*/
public OffsetTime truncatedTo(TemporalUnit unit) {
return with(time.truncatedTo(unit), offset);
}
//-----------------------------------------------------------------------
/**
* 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 {@link Period} but may be any other type implementing
* the {@link TemporalAmount} interface.
* The calculation is delegated to the specified adjuster, which typically calls
* back to {@link #plus(long, TemporalUnit)}.
* 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.
*
* @param amount the amount to add, not null
* @return an {@code OffsetTime} based on this time with the addition made, not null
* @throws DateTimeException if the addition cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public OffsetTime plus(TemporalAmount amount) {
return (OffsetTime) amount.addTo(this);
}
/**
* 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.
*
* @param amountToAdd the amount of the unit to add to the result, may be negative
* @param unit the unit of the period to add, not null
* @return an {@code OffsetTime} based on this time with the specified period added, not null
* @throws DateTimeException if the unit cannot be added to this type
*/
@Override
public OffsetTime plus(long amountToAdd, TemporalUnit unit) {
if (unit instanceof ChronoUnit) {
return with(time.plus(amountToAdd, unit), offset);
}
return unit.addTo(this, amountToAdd);
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this {@code 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.
*
* @param hours the hours to add, may be negative
* @return an {@code OffsetTime} based on this time with the hours added, not null
*/
public OffsetTime plusHours(long hours) {
return with(time.plusHours(hours), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param minutes the minutes to add, may be negative
* @return an {@code OffsetTime} based on this time with the minutes added, not null
*/
public OffsetTime plusMinutes(long minutes) {
return with(time.plusMinutes(minutes), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param seconds the seconds to add, may be negative
* @return an {@code OffsetTime} based on this time with the seconds added, not null
*/
public OffsetTime plusSeconds(long seconds) {
return with(time.plusSeconds(seconds), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param nanos the nanos to add, may be negative
* @return an {@code OffsetTime} based on this time with the nanoseconds added, not null
*/
public OffsetTime plusNanos(long nanos) {
return with(time.plusNanos(nanos), offset);
}
//-----------------------------------------------------------------------
/**
* 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 {@link Period} but may be any other type implementing
* the {@link TemporalAmount} interface.
* The calculation is delegated to the specified adjuster, which typically calls
* back to {@link #minus(long, TemporalUnit)}.
* 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.
*
* @param amount the amount to subtract, not null
* @return an {@code OffsetTime} based on this time with the subtraction made, not null
* @throws DateTimeException if the subtraction cannot be made
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public OffsetTime minus(TemporalAmount amount) {
return (OffsetTime) amount.subtractFrom(this);
}
/**
* 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.
*
* @param amountToSubtract the amount of the unit to subtract from the result, may be negative
* @param unit the unit of the period to subtract, not null
* @return an {@code OffsetTime} based on this time with the specified period subtracted, not null
* @throws DateTimeException if the unit cannot be added to this type
*/
@Override
public OffsetTime minus(long amountToSubtract, TemporalUnit unit) {
return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit));
}
//-----------------------------------------------------------------------
/**
* Returns a copy of this {@code 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.
*
* @param hours the hours to subtract, may be negative
* @return an {@code OffsetTime} based on this time with the hours subtracted, not null
*/
public OffsetTime minusHours(long hours) {
return with(time.minusHours(hours), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param minutes the minutes to subtract, may be negative
* @return an {@code OffsetTime} based on this time with the minutes subtracted, not null
*/
public OffsetTime minusMinutes(long minutes) {
return with(time.minusMinutes(minutes), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param seconds the seconds to subtract, may be negative
* @return an {@code OffsetTime} based on this time with the seconds subtracted, not null
*/
public OffsetTime minusSeconds(long seconds) {
return with(time.minusSeconds(seconds), offset);
}
/**
* Returns a copy of this {@code 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.
*
* @param nanos the nanos to subtract, may be negative
* @return an {@code OffsetTime} based on this time with the nanoseconds subtracted, not null
*/
public OffsetTime minusNanos(long nanos) {
return with(time.minusNanos(nanos), offset);
}
//-----------------------------------------------------------------------
/**
* Queries this time using the specified query.
*
* 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.
*
* 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.
*
* @param the type of the result
* @param query the query to invoke, not null
* @return the query result, null may be returned (defined by the query)
* @throws DateTimeException if unable to query (defined by the query)
* @throws ArithmeticException if numeric overflow occurs (defined by the query)
*/
@SuppressWarnings("unchecked")
@Override
public R query(TemporalQuery query) {
if (query == TemporalQueries.precision()) {
return (R) NANOS;
} else if (query == TemporalQueries.offset() || query == TemporalQueries.zone()) {
return (R) getOffset();
} else if (query == TemporalQueries.localTime()) {
return (R) time;
} else if (query == TemporalQueries.chronology() || query == TemporalQueries.localDate() || query == TemporalQueries.zoneId()) {
return null;
}
return super.query(query);
}
/**
* 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 {@link Temporal#with(TemporalField, long)}
* twice, passing {@link ChronoField#NANO_OF_DAY} and
* {@link ChronoField#OFFSET_SECONDS} as the fields.
*
* In most cases, it is clearer to reverse the calling pattern by using
* {@link 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.
*
* @param temporal the target object to be adjusted, not null
* @return the adjusted object, not null
* @throws DateTimeException if unable to make the adjustment
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public Temporal adjustInto(Temporal temporal) {
return temporal
.with(NANO_OF_DAY, time.toNanoOfDay())
.with(OFFSET_SECONDS, getOffset().getTotalSeconds());
}
/**
* 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 {@code 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
* using {@code startTime.until(endTime, HOURS)}.
*
* The {@code Temporal} passed to this method must be an {@code OffsetTime}.
* 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 {@link TemporalUnit#between}.
* The result of this method is a {@code long} representing the amount of
* the specified unit. By contrast, the result of {@code between} 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 {@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.
*
* 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 input temporal as
* the second argument.
*
* This instance is immutable and unaffected by this method call.
*
* @param endExclusive the end time, which is converted to an {@code OffsetTime}, not null
* @param unit the unit to measure the period in, not null
* @return the amount of the period between this time and the end time
* @throws DateTimeException if the period cannot be calculated
* @throws ArithmeticException if numeric overflow occurs
*/
@Override
public long until(Temporal endExclusive, TemporalUnit unit) {
OffsetTime end = OffsetTime.from(endExclusive);
if (unit instanceof ChronoUnit) {
long nanosUntil = end.toEpochNano() - toEpochNano(); // no overflow
switch ((ChronoUnit) unit) {
case NANOS: return nanosUntil;
case MICROS: return nanosUntil / 1000;
case MILLIS: return nanosUntil / 1000000;
case SECONDS: return nanosUntil / NANOS_PER_SECOND;
case MINUTES: return nanosUntil / NANOS_PER_MINUTE;
case HOURS: return nanosUntil / NANOS_PER_HOUR;
case HALF_DAYS: return nanosUntil / (12 * NANOS_PER_HOUR);
}
throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
}
return unit.between(this, end);
}
//-----------------------------------------------------------------------
/**
* Combines this time with a date to create an {@code OffsetDateTime}.
*
* This returns an {@code OffsetDateTime} formed from this time and the specified date.
* All possible combinations of date and time are valid.
*
* @param date the date to combine with, not null
* @return the offset date-time formed from this time and the specified date, not null
*/
public OffsetDateTime atDate(LocalDate date) {
return OffsetDateTime.of(date, time, offset);
}
//-----------------------------------------------------------------------
/**
* Gets the {@code LocalTime} part of this date-time.
*
* This returns a {@code LocalTime} with the same hour, minute, second and
* nanosecond as this date-time.
*
* @return the time part of this date-time, not null
*/
public LocalTime toLocalTime() {
return time;
}
//-----------------------------------------------------------------------
/**
* Converts this time to epoch nanos based on 1970-01-01Z.
*
* @return the epoch nanos value
*/
private long toEpochNano() {
long nod = time.toNanoOfDay();
long offsetNanos = offset.getTotalSeconds() * NANOS_PER_SECOND;
return nod - offsetNanos;
}
//-----------------------------------------------------------------------
/**
* Compares this {@code 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 {@link Comparable}.
*
* For example, the following is the comparator order:
*
* - {@code 10:30+01:00}
* - {@code 11:00+01:00}
* - {@code 12:00+02:00}
* - {@code 11:30+01:00}
* - {@code 12:00+01:00}
* - {@code 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 with {@code equals()}.
*
* To compare the underlying local time of two {@code TemporalAccessor} instances,
* use {@link ChronoField#NANO_OF_DAY} as a comparator.
*
* @param other the other time to compare to, not null
* @return the comparator value, negative if less, positive if greater
* @throws NullPointerException if {@code other} is null
*/
@Override
public int compareTo(OffsetTime other) {
if (offset.equals(other.offset)) {
return time.compareTo(other.time);
}
int compare = Jdk8Methods.compareLongs(toEpochNano(), other.toEpochNano());
if (compare == 0) {
compare = time.compareTo(other.time);
}
return compare;
}
//-----------------------------------------------------------------------
/**
* Checks if the instant of this {@code OffsetTime} is after that of the
* specified time applying both times to a common date.
*
* 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.
*
* @param other the other time to compare to, not null
* @return true if this is after the instant of the specified time
*/
public boolean isAfter(OffsetTime other) {
return toEpochNano() > other.toEpochNano();
}
/**
* Checks if the instant of this {@code OffsetTime} is before that of the
* specified time applying both times to a common date.
*
* 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.
*
* @param other the other time to compare to, not null
* @return true if this is before the instant of the specified time
*/
public boolean isBefore(OffsetTime other) {
return toEpochNano() < other.toEpochNano();
}
/**
* Checks if the instant of this {@code OffsetTime} is equal to that of the
* specified time applying both times to a common date.
*
* 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.
*
* @param other the other time to compare to, not null
* @return true if this is equal to the instant of the specified time
*/
public boolean isEqual(OffsetTime other) {
return toEpochNano() == other.toEpochNano();
}
//-----------------------------------------------------------------------
/**
* 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 {@link #isEqual(OffsetTime)}.
*
* 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.
*
* @param obj the object to check, null returns false
* @return true if this is equal to the other time
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof OffsetTime) {
OffsetTime other = (OffsetTime) obj;
return time.equals(other.time) && offset.equals(other.offset);
}
return false;
}
/**
* A hash code for this time.
*
* @return a suitable hash code
*/
@Override
public int hashCode() {
return time.hashCode() ^ offset.hashCode();
}
//-----------------------------------------------------------------------
/**
* Outputs this time as a {@code String}, such as {@code 10:15:30+01:00}.
*
* The output will be one of the following ISO-8601 formats:
*
* - {@code HH:mmXXXXX}
* - {@code HH:mm:ssXXXXX}
* - {@code HH:mm:ss.SSSXXXXX}
* - {@code HH:mm:ss.SSSSSSXXXXX}
* - {@code 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.
*
* @return a string representation of this time, not null
*/
@Override
public String toString() {
return time.toString() + offset.toString();
}
/**
* Outputs this time as a {@code String} using the formatter.
*
* This time will be passed to the formatter
* {@link DateTimeFormatter#format(TemporalAccessor) print method}.
*
* @param formatter the formatter to use, not null
* @return the formatted time string, not null
* @throws DateTimeException if an error occurs during printing
*/
public String format(DateTimeFormatter formatter) {
Jdk8Methods.requireNonNull(formatter, "formatter");
return formatter.format(this);
}
// -----------------------------------------------------------------------
private Object writeReplace() {
return new Ser(Ser.OFFSET_TIME_TYPE, this);
}
/**
* Defend against malicious streams.
* @return never
* @throws InvalidObjectException always
*/
private Object readResolve() throws ObjectStreamException {
throw new InvalidObjectException("Deserialization via serialization delegate");
}
void writeExternal(DataOutput out) throws IOException {
time.writeExternal(out);
offset.writeExternal(out);
}
static OffsetTime readExternal(DataInput in) throws IOException {
LocalTime time = LocalTime.readExternal(in);
ZoneOffset offset = ZoneOffset.readExternal(in);
return OffsetTime.of(time, offset);
}
}