* This class models a single instantaneous point on the time-line. This might be used to record event time-stamps in * the application. *
* The range of an instant requires the storage of a number larger than a {@code long}. To achieve this, the class * stores a {@code long} representing epoch-seconds and an {@code int} representing nanosecond-of-second, which will * always be between 0 and 999,999,999. The epoch-seconds are measured from the standard Java epoch of * {@code 1970-01-01T00:00:00Z} where instants after the epoch have positive values, and earlier instants have negative * values. For both the epoch-second and nanosecond parts, a larger value is always later on the time-line than a * smaller value. *
* The length of the solar day is the standard way that humans measure time. This has traditionally been subdivided into * 24 hours of 60 minutes of 60 seconds, forming a 86400 second day. *
* Modern timekeeping is based on atomic clocks which precisely define an SI second relative to the transitions of a * Caesium atom. The length of an SI second was defined to be very close to the 86400th fraction of a day. *
* Unfortunately, as the Earth rotates the length of the day varies. In addition, over time the average length of the * day is getting longer as the Earth slows. As a result, the length of a solar day in 2012 is slightly longer than * 86400 SI seconds. The actual length of any given day and the amount by which the Earth is slowing are not predictable * and can only be determined by measurement. The UT1 time-scale captures the accurate length of day, but is only * available some time after the day has completed. *
* The UTC time-scale is a standard approach to bundle up all the additional fractions of a second from UT1 into whole * seconds, known as leap-seconds. A leap-second may be added or removed depending on the Earth's rotational * changes. As such, UTC permits a day to have 86399 SI seconds or 86401 SI seconds where necessary in order to keep the * day aligned with the Sun. *
* The modern UTC time-scale was introduced in 1972, introducing the concept of whole leap-seconds. Between 1958 and * 1972, the definition of UTC was complex, with minor sub-second leaps and alterations to the length of the notional * second. As of 2012, discussions are underway to change the definition of UTC again, with the potential to remove leap * seconds or introduce other changes. *
* Given the complexity of accurate timekeeping described above, this Java API defines its own time-scale, the Java * Time-Scale. *
* The Java Time-Scale divides each calendar day into exactly 86400 subdivisions, known as seconds. These seconds may * differ from the SI second. It closely matches the de facto international civil time scale, the definition of which * changes from time to time. *
* The Java Time-Scale has slightly different definitions for different segments of the time-line, each based on the * consensus international time scale that is used as the basis for civil time. Whenever the internationally-agreed time * scale is modified or replaced, a new segment of the Java Time-Scale must be defined for it. Each segment must meet * these requirements: *
* For the segment from 1972-11-03 (exact boundary discussed below) until further notice, the consensus international * time scale is UTC (with leap seconds). In this segment, the Java Time-Scale is identical to * UTC-SLS. This is identical to UTC on days that do not have * a leap second. On days that do have a leap second, the leap second is spread equally over the last 1000 seconds of * the day, maintaining the appearance of exactly 86400 seconds per day. *
* For the segment prior to 1972-11-03, extending back arbitrarily far, the consensus international time scale is * defined to be UT1, applied proleptically, which is equivalent to the (mean) solar time on the prime meridian * (Greenwich). In this segment, the Java Time-Scale is identical to the consensus international time scale. The exact * boundary between the two segments is the instant where UT1 = UTC between 1972-11-03T00:00 and 1972-11-04T12:00. *
* Implementations of the Java time-scale using the JSR-310 API are not required to provide any clock that is sub-second * accurate, or that progresses monotonically or smoothly. Implementations are therefore not required to actually * perform the UTC-SLS slew or to otherwise be aware of leap seconds. JSR-310 does, however, require that * implementations must document the approach they use when defining a clock representing the current instant. See * {@link Clock} for details on the available clocks. *
* The Java time-scale is used for all date-time classes. This includes {@code Instant}, {@code LocalDate}, * {@code LocalTime}, {@code OffsetDateTime}, {@code ZonedDateTime} and {@code Duration}. * *
* This is a value-based class; use of identity-sensitive * operations (including reference equality ({@code ==}), identity hash code, or synchronization) on instances of * {@code Instant} may have unpredictable results and should be avoided. The {@code equals} method should be used for * comparisons. *
This class is immutable and thread-safe.
*/
public final class Instant implements Temporal, TemporalAdjuster, Comparable
* This is one year earlier than the minimum {@code LocalDateTime}. This provides sufficient values to handle the
* range of {@code ZoneOffset} which affect the instant in addition to the local date-time. The value is also chosen
* such that the value of the year fits in an {@code int}.
*/
public static final Instant MIN = Instant.ofEpochSecond(MIN_SECOND, 0);
/**
* The maximum supported {@code Instant}, '1000000000-12-31T23:59:59.999999999Z'. This could be used by an
* application as a "far future" instant.
*
* This is one year later than the maximum {@code LocalDateTime}. This provides sufficient values to handle the
* range of {@code ZoneOffset} which affect the instant in addition to the local date-time. The value is also chosen
* such that the value of the year fits in an {@code int}.
*/
public static final Instant MAX = Instant.ofEpochSecond(MAX_SECOND, 999_999_999);
/**
* The number of seconds from the epoch of 1970-01-01T00:00:00Z.
*/
private final long seconds;
/**
* The number of nanoseconds, later along the time-line, from the seconds field. This is always positive, and never
* exceeds 999,999,999.
*/
private final int nanos;
// -----------------------------------------------------------------------
/**
* Obtains the current instant from the system clock.
*
* This will query the {@link Clock#systemUTC() system UTC clock} to obtain the current instant.
*
* Using this method will prevent the ability to use an alternate time-source for testing because the clock is
* effectively hard-coded.
*
* @return the current instant using the system clock, not null
*/
public static Instant now() {
return Clock.systemUTC().instant();
}
/**
* Obtains the current instant from the specified clock.
*
* This will query the specified clock to obtain the current time.
*
* 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 instant, not null
*/
public static Instant now(Clock clock) {
return clock.instant();
}
// -----------------------------------------------------------------------
/**
* Obtains an instance of {@code Instant} using seconds from the epoch of 1970-01-01T00:00:00Z.
*
* The nanosecond field is set to zero.
*
* @param epochSecond
* the number of seconds from 1970-01-01T00:00:00Z
* @return an instant, not null
* @throws DateTimeException
* if the instant exceeds the maximum or minimum instant
*/
public static Instant ofEpochSecond(long epochSecond) {
return create(epochSecond, 0);
}
/**
* Obtains an instance of {@code Instant} using seconds from the epoch of 1970-01-01T00:00:00Z and nanosecond
* fraction of second.
*
* This method allows an arbitrary number of nanoseconds to be passed in. The factory will alter the values of the
* second and nanosecond in order to ensure that the stored nanosecond is in the range 0 to 999,999,999. For
* example, the following will result in the exactly the same instant:
*
*
* The seconds and nanoseconds are extracted from the specified milliseconds.
*
* @param epochMilli
* the number of milliseconds from 1970-01-01T00:00:00Z
* @return an instant, not null
* @throws DateTimeException
* if the instant exceeds the maximum or minimum instant
*/
public static Instant ofEpochMilli(long epochMilli) {
long secs = MathUtils.floorDiv(epochMilli, 1000);
int mos = (int) MathUtils.floorMod(epochMilli, 1000);
return create(secs, mos * 1000_000);
}
// -----------------------------------------------------------------------
/**
* Obtains an instance of {@code Instant} from a temporal object.
*
* This obtains an instant 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 Instant}.
*
* The conversion extracts the {@link ChronoField#INSTANT_SECONDS INSTANT_SECONDS} and
* {@link ChronoField#NANO_OF_SECOND NANO_OF_SECOND} fields.
*
* This method matches the signature of the functional interface {@link TemporalQuery} allowing it to be used as a
* query via method reference, {@code Instant::from}.
*
* @param temporal
* the temporal object to convert, not null
* @return the instant, not null
* @throws DateTimeException
* if unable to convert to an {@code Instant}
*/
public static Instant from(TemporalAccessor temporal) {
if (temporal instanceof Instant) {
return (Instant) temporal;
}
try {
long instantSecs = temporal.getLong(INSTANT_SECONDS);
int nanoOfSecond = temporal.get(NANO_OF_SECOND);
return Instant.ofEpochSecond(instantSecs, nanoOfSecond);
} catch (DateTimeException ex) {
throw new DateTimeException("Unable to obtain Instant from TemporalAccessor: " + temporal + " of type "
+ temporal.getClass().getName(), ex);
}
}
// -----------------------------------------------------------------------
/**
* Obtains an instance of {@code Instant} using seconds and nanoseconds.
*
* @param seconds
* the length of the duration in seconds
* @param nanoOfSecond
* the nano-of-second, from 0 to 999,999,999
* @throws DateTimeException
* if the instant exceeds the maximum or minimum instant
*/
private static Instant create(long seconds, int nanoOfSecond) {
if ((seconds | nanoOfSecond) == 0) {
return EPOCH;
}
if (seconds < MIN_SECOND || seconds > MAX_SECOND) {
throw new DateTimeException("Instant exceeds minimum or maximum instant");
}
return new Instant(seconds, nanoOfSecond);
}
/**
* Constructs an instance of {@code Instant} using seconds from the epoch of 1970-01-01T00:00:00Z and nanosecond
* fraction of second.
*
* @param epochSecond
* the number of seconds from 1970-01-01T00:00:00Z
* @param nanos
* the nanoseconds within the second, must be positive
*/
private Instant(long epochSecond, int nanos) {
super();
this.seconds = epochSecond;
this.nanos = nanos;
}
// -----------------------------------------------------------------------
/**
* Checks if the specified field is supported.
*
* This checks if this instant 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.
*
* If the field is a {@link ChronoField} then the query is implemented here. The supported fields are:
*
* 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 instant, false if not
*/
@Override
public boolean isSupported(@Nullable TemporalField field) {
if (field instanceof ChronoField) {
return field == INSTANT_SECONDS || field == NANO_OF_SECOND || field == MICRO_OF_SECOND
|| field == MILLI_OF_SECOND;
}
return field != null && field.isSupportedBy(this);
}
/**
* Checks if the specified unit is supported.
*
* 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.
*
* If the unit is a {@link ChronoUnit} then the query is implemented here. The supported units are:
*
* 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.
*
* @param unit
* the unit to check, null returns false
* @return true if the unit can be added/subtracted, false if not
*/
@Override
public boolean isSupported(@Nullable TemporalUnit unit) {
if (unit instanceof ChronoUnit) {
return unit.isTimeBased() || unit == DAYS;
}
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 instant 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 an
* {@code UnsupportedTemporalTypeException}.
*
* 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
* @throws UnsupportedTemporalTypeException
* if the field is not supported
*/
@Override // override for Javadoc
public ValueRange range(TemporalField field) {
if (field instanceof ChronoField) {
if (isSupported(field)) {
return field.range();
}
throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
}
return field.rangeRefinedBy(this);
}
/**
* Gets the value of the specified field from this instant as an {@code int}.
*
* This queries this instant for the value of the specified field. The returned value will always be within the
* valid range of values for the field. If it is not possible to return the value, because the field is not
* supported or for some other reason, an exception is thrown.
*
* If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField)
* supported fields} will return valid values based on this date-time, except {@code INSTANT_SECONDS} which is too
* large to fit in an {@code int} and throws a {@code DateTimeException}. All other {@code ChronoField} instances
* will throw an {@code UnsupportedTemporalTypeException}.
*
* 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 or the value is outside the range of valid values for the
* field
* @throws UnsupportedTemporalTypeException
* if the field is not supported or the range of values exceeds an {@code int}
*
*/
@Override // override for Javadoc and performance
public int get(TemporalField field) {
if (field instanceof ChronoField) {
switch ((ChronoField) field) {
case NANO_OF_SECOND:
return this.nanos;
case MICRO_OF_SECOND:
return this.nanos / 1000;
case MILLI_OF_SECOND:
return this.nanos / 1000_000;
case INSTANT_SECONDS:
INSTANT_SECONDS.checkValidIntValue(this.seconds);
}
throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
}
return range(field).checkValidIntValue(field.getFrom(this), field);
}
/**
* Gets the value of the specified field from this instant as a {@code long}.
*
* This queries this instant for the value of the specified field. If it is not possible to return the value,
* because the field is not supported or for some other reason, an exception is thrown.
*
* If the field is a {@link ChronoField} then the query is implemented here. The {@link #isSupported(TemporalField)
* supported fields} will return valid values based on this date-time. All other {@code ChronoField} instances will
* throw an {@code UnsupportedTemporalTypeException}.
*
* 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 UnsupportedTemporalTypeException
* if the field is not supported
*
*/
@Override
public long getLong(TemporalField field) {
if (field instanceof ChronoField) {
switch ((ChronoField) field) {
case NANO_OF_SECOND:
return this.nanos;
case MICRO_OF_SECOND:
return this.nanos / 1000;
case MILLI_OF_SECOND:
return this.nanos / 1000_000;
case INSTANT_SECONDS:
return this.seconds;
}
throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
}
return field.getFrom(this);
}
// -----------------------------------------------------------------------
/**
* Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z.
*
* The epoch second count is a simple incrementing count of seconds where second 0 is 1970-01-01T00:00:00Z. The
* nanosecond part of the day is returned by {@code getNanosOfSecond}.
*
* @return the seconds from the epoch of 1970-01-01T00:00:00Z
*/
public long getEpochSecond() {
return this.seconds;
}
/**
* Gets the number of nanoseconds, later along the time-line, from the start of the second.
*
* The nanosecond-of-second value measures the total number of nanoseconds from the second returned by
* {@code getEpochSecond}.
*
* @return the nanoseconds within the second, always positive, never exceeds 999,999,999
*/
public int getNano() {
return this.nanos;
}
// -------------------------------------------------------------------------
/**
* Returns an adjusted copy of this instant.
*
* This returns an {@code Instant}, based on this one, with the instant adjusted. The adjustment takes place using
* the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will
* be made.
*
* 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 Instant} based on {@code this} with the adjustment made, not null
* @throws DateTimeException
* if the adjustment cannot be made
*
*/
@Override
public Instant with(TemporalAdjuster adjuster) {
return (Instant) adjuster.adjustInto(this);
}
/**
* Returns a copy of this instant with the specified field set to a new value.
*
* This returns an {@code Instant}, based on this one, with the value for the specified field changed. 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 supported fields behave as
* follows:
*
* In all cases, if the new value is outside the valid range of values for the field then a
* {@code DateTimeException} will be thrown.
*
* All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* 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 Instant} based on {@code this} with the specified field set, not null
* @throws DateTimeException
* if the field cannot be set
* @throws UnsupportedTemporalTypeException
* if the field is not supported
*
*/
@Override
public Instant with(TemporalField field, long newValue) {
if (field instanceof ChronoField) {
ChronoField f = (ChronoField) field;
f.checkValidValue(newValue);
switch (f) {
case MILLI_OF_SECOND: {
int nval = (int) newValue * 1000_000;
return (nval != this.nanos ? create(this.seconds, nval) : this);
}
case MICRO_OF_SECOND: {
int nval = (int) newValue * 1000;
return (nval != this.nanos ? create(this.seconds, nval) : this);
}
case NANO_OF_SECOND:
return (newValue != this.nanos ? create(this.seconds, (int) newValue) : this);
case INSTANT_SECONDS:
return (newValue != this.seconds ? create(newValue, this.nanos) : this);
}
throw new UnsupportedTemporalTypeException("Unsupported field: " + field);
}
return field.adjustInto(this, newValue);
}
// -----------------------------------------------------------------------
/**
* Returns a copy of this {@code Instant} truncated to the specified unit.
*
* Truncating the instant returns a copy of the original with fields smaller than the specified unit set to zero.
* The fields are calculated on the basis of using a UTC offset as seen in {@code toString}. For example, truncating
* with the {@link ChronoUnit#MINUTES MINUTES} unit will round down to the nearest minute, setting the seconds and
* nanoseconds 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.
*
* This instance is immutable and unaffected by this method call.
*
* @param unit
* the unit to truncate to, not null
* @return an {@code Instant} based on this instant with the time truncated, not null
* @throws DateTimeException
* if the unit is invalid for truncation
* @throws UnsupportedTemporalTypeException
* if the unit is not supported
*/
public Instant truncatedTo(TemporalUnit unit) {
if (unit == ChronoUnit.NANOS) {
return this;
}
Duration unitDur = unit.getDuration();
if (unitDur.getSeconds() > LocalTime.SECONDS_PER_DAY) {
throw new UnsupportedTemporalTypeException("Unit is too large to be used for truncation");
}
long dur = unitDur.toNanos();
if ((LocalTime.NANOS_PER_DAY % dur) != 0) {
throw new UnsupportedTemporalTypeException("Unit must divide into a standard day without remainder");
}
long nod = (this.seconds % LocalTime.SECONDS_PER_DAY) * LocalTime.NANOS_PER_SECOND + this.nanos;
long result = (nod / dur) * dur;
return plusNanos(result - nod);
}
// -----------------------------------------------------------------------
/**
* Returns a copy of this instant with the specified amount added.
*
* This returns an {@code Instant}, 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.
*
* 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.
*
* This instance is immutable and unaffected by this method call.
*
* @param amountToAdd
* the amount to add, not null
* @return an {@code Instant} based on this instant with the addition made, not null
* @throws DateTimeException
* if the addition cannot be made
*
*/
@Override
public Instant plus(TemporalAmount amountToAdd) {
return (Instant) amountToAdd.addTo(this);
}
/**
* Returns a copy of this instant with the specified amount added.
*
* This returns an {@code Instant}, based on this one, with the amount in terms of the unit added. If it is not
* possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.
*
* If the field is a {@link ChronoUnit} then the addition is implemented here. The supported fields behave as
* follows:
*
* All other {@code ChronoUnit} instances will throw an {@code UnsupportedTemporalTypeException}.
*
* 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.
*
* 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 amount to add, not null
* @return an {@code Instant} based on this instant with the specified amount added, not null
* @throws DateTimeException
* if the addition cannot be made
* @throws UnsupportedTemporalTypeException
* if the unit is not supported
*
*/
@Override
public Instant plus(long amountToAdd, TemporalUnit unit) {
if (unit instanceof ChronoUnit) {
switch ((ChronoUnit) unit) {
case NANOS:
return plusNanos(amountToAdd);
case MICROS:
return plus(amountToAdd / 1000_000, (amountToAdd % 1000_000) * 1000);
case MILLIS:
return plusMillis(amountToAdd);
case SECONDS:
return plusSeconds(amountToAdd);
case MINUTES:
return plusSeconds(amountToAdd * SECONDS_PER_MINUTE);
case HOURS:
return plusSeconds(amountToAdd * SECONDS_PER_HOUR);
case HALF_DAYS:
return plusSeconds(amountToAdd * SECONDS_PER_DAY / 2);
case DAYS:
return plusSeconds(amountToAdd * SECONDS_PER_DAY);
}
throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
}
return unit.addTo(this, amountToAdd);
}
// -----------------------------------------------------------------------
/**
* Returns a copy of this instant with the specified duration in seconds added.
*
* This instance is immutable and unaffected by this method call.
*
* @param secondsToAdd
* the seconds to add, positive or negative
* @return an {@code Instant} based on this instant with the specified seconds added, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant plusSeconds(long secondsToAdd) {
return plus(secondsToAdd, 0);
}
/**
* Returns a copy of this instant with the specified duration in milliseconds added.
*
* This instance is immutable and unaffected by this method call.
*
* @param millisToAdd
* the milliseconds to add, positive or negative
* @return an {@code Instant} based on this instant with the specified milliseconds added, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant plusMillis(long millisToAdd) {
return plus(millisToAdd / 1000, (millisToAdd % 1000) * 1000_000);
}
/**
* Returns a copy of this instant with the specified duration in nanoseconds added.
*
* This instance is immutable and unaffected by this method call.
*
* @param nanosToAdd
* the nanoseconds to add, positive or negative
* @return an {@code Instant} based on this instant with the specified nanoseconds added, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant plusNanos(long nanosToAdd) {
return plus(0, nanosToAdd);
}
/**
* Returns a copy of this instant with the specified duration added.
*
* This instance is immutable and unaffected by this method call.
*
* @param secondsToAdd
* the seconds to add, positive or negative
* @param nanosToAdd
* the nanos to add, positive or negative
* @return an {@code Instant} based on this instant with the specified seconds added, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
private Instant plus(long secondsToAdd, long nanosToAdd) {
if ((secondsToAdd | nanosToAdd) == 0) {
return this;
}
long epochSec = this.seconds + secondsToAdd;
epochSec = epochSec + nanosToAdd / NANOS_PER_SECOND;
nanosToAdd = nanosToAdd % NANOS_PER_SECOND;
long nanoAdjustment = this.nanos + nanosToAdd; // safe int+NANOS_PER_SECOND
return ofEpochSecond(epochSec, nanoAdjustment);
}
// -----------------------------------------------------------------------
/**
* Returns a copy of this instant with the specified amount subtracted.
*
* This returns an {@code Instant}, 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.
*
* 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.
*
* This instance is immutable and unaffected by this method call.
*
* @param amountToSubtract
* the amount to subtract, not null
* @return an {@code Instant} based on this instant with the subtraction made, not null
* @throws DateTimeException
* if the subtraction cannot be made
*
*/
@Override
public Instant minus(TemporalAmount amountToSubtract) {
return (Instant) amountToSubtract.subtractFrom(this);
}
/**
* Returns a copy of this instant with the specified amount subtracted.
*
* This returns a {@code Instant}, based on this one, with the amount in terms of the unit subtracted. If it is not
* possible to subtract the amount, because the unit is not supported or for some other reason, an exception is
* thrown.
*
* This method is equivalent to {@link #plus(long, TemporalUnit)} with the amount negated. See that method for a
* full description of how addition, and thus subtraction, works.
*
* This instance is immutable and unaffected by this method call.
*
* @param amountToSubtract
* the amount of the unit to subtract from the result, may be negative
* @param unit
* the unit of the amount to subtract, not null
* @return an {@code Instant} based on this instant with the specified amount subtracted, not null
* @throws DateTimeException
* if the subtraction cannot be made
* @throws UnsupportedTemporalTypeException
* if the unit is not supported
*
*/
@Override
public Instant 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 instant with the specified duration in seconds subtracted.
*
* This instance is immutable and unaffected by this method call.
*
* @param secondsToSubtract
* the seconds to subtract, positive or negative
* @return an {@code Instant} based on this instant with the specified seconds subtracted, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant minusSeconds(long secondsToSubtract) {
if (secondsToSubtract == Long.MIN_VALUE) {
return plusSeconds(Long.MAX_VALUE).plusSeconds(1);
}
return plusSeconds(-secondsToSubtract);
}
/**
* Returns a copy of this instant with the specified duration in milliseconds subtracted.
*
* This instance is immutable and unaffected by this method call.
*
* @param millisToSubtract
* the milliseconds to subtract, positive or negative
* @return an {@code Instant} based on this instant with the specified milliseconds subtracted, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant minusMillis(long millisToSubtract) {
if (millisToSubtract == Long.MIN_VALUE) {
return plusMillis(Long.MAX_VALUE).plusMillis(1);
}
return plusMillis(-millisToSubtract);
}
/**
* Returns a copy of this instant with the specified duration in nanoseconds subtracted.
*
* This instance is immutable and unaffected by this method call.
*
* @param nanosToSubtract
* the nanoseconds to subtract, positive or negative
* @return an {@code Instant} based on this instant with the specified nanoseconds subtracted, not null
* @throws DateTimeException
* if the result exceeds the maximum or minimum instant
*
*/
public Instant minusNanos(long nanosToSubtract) {
if (nanosToSubtract == Long.MIN_VALUE) {
return plusNanos(Long.MAX_VALUE).plusNanos(1);
}
return plusNanos(-nanosToSubtract);
}
// -------------------------------------------------------------------------
/**
* Queries this instant using the specified query.
*
* This queries this instant 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
* This returns a temporal object of the same observable type as the input with the instant changed to be the same
* as this.
*
* The adjustment is equivalent to using {@link Temporal#with(TemporalField, long)} twice, passing
* {@link ChronoField#INSTANT_SECONDS} and {@link ChronoField#NANO_OF_SECOND} as the fields.
*
* In most cases, it is clearer to reverse the calling pattern by using {@link Temporal#with(TemporalAdjuster)}:
*
*
* 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
*
*/
@Override
public Temporal adjustInto(Temporal temporal) {
return temporal.with(INSTANT_SECONDS, this.seconds).with(NANO_OF_SECOND, this.nanos);
}
/**
* Calculates the amount of time until another instant in terms of the specified unit.
*
* This calculates the amount of time between two {@code Instant} objects in terms of a single {@code TemporalUnit}.
* The start and end points are {@code this} and the specified instant. The result will be negative if the end is
* before the start. The calculation returns a whole number, representing the number of complete units between the
* two instants. The {@code Temporal} passed to this method is converted to a {@code Instant} using
* {@link #from(TemporalAccessor)}. For example, the amount in days between two dates can be calculated using
* {@code startInstant.until(endInstant, SECONDS)}.
*
* 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)}:
*
*
* The calculation is implemented in this method for {@link ChronoUnit}. The units {@code NANOS}, {@code MICROS},
* {@code MILLIS}, {@code SECONDS}, {@code MINUTES}, {@code HOURS}, {@code HALF_DAYS} and {@code 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 converted
* input temporal as the second argument.
*
* This instance is immutable and unaffected by this method call.
*
* @param endExclusive
* the end date, exclusive, which is converted to an {@code Instant}, not null
* @param unit
* the unit to measure the amount in, not null
* @return the amount of time between this instant and the end instant
* @throws DateTimeException
* if the amount cannot be calculated, or the end temporal cannot be converted to an {@code Instant}
* @throws UnsupportedTemporalTypeException
* if the unit is not supported
*
*/
@Override
public long until(Temporal endExclusive, TemporalUnit unit) {
Instant end = Instant.from(endExclusive);
if (unit instanceof ChronoUnit) {
ChronoUnit f = (ChronoUnit) unit;
switch (f) {
case NANOS:
return nanosUntil(end);
case MICROS:
return nanosUntil(end) / 1000;
case MILLIS:
return end.toEpochMilli() - toEpochMilli();
case SECONDS:
return secondsUntil(end);
case MINUTES:
return secondsUntil(end) / SECONDS_PER_MINUTE;
case HOURS:
return secondsUntil(end) / SECONDS_PER_HOUR;
case HALF_DAYS:
return secondsUntil(end) / (12 * SECONDS_PER_HOUR);
case DAYS:
return secondsUntil(end) / (SECONDS_PER_DAY);
}
throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit);
}
return unit.between(this, end);
}
private long nanosUntil(Instant end) {
long secsDiff = end.seconds - this.seconds;
long totalNanos = secsDiff * NANOS_PER_SECOND;
return totalNanos + (end.nanos - this.nanos);
}
private long secondsUntil(Instant end) {
long secsDiff = end.seconds - this.seconds;
long nanosDiff = end.nanos - this.nanos;
if (secsDiff > 0 && nanosDiff < 0) {
secsDiff--;
} else if (secsDiff < 0 && nanosDiff > 0) {
secsDiff++;
}
return secsDiff;
}
// -----------------------------------------------------------------------
/**
* Combines this instant with an offset to create an {@code OffsetDateTime}.
*
* This returns an {@code OffsetDateTime} formed from this instant at the specified offset from UTC/Greenwich. An
* exception will be thrown if the instant is too large to fit into an offset date-time.
*
* This method is equivalent to {@link OffsetDateTime#ofInstant(Instant, ZoneId) OffsetDateTime.ofInstant(this,
* offset)}.
*
* @param offset
* the offset to combine with, not null
* @return the offset date-time formed from this instant and the specified offset, not null
* @throws DateTimeException
* if the result exceeds the supported range
*/
public OffsetDateTime atOffset(ZoneOffset offset) {
return OffsetDateTime.ofInstant(this, offset);
}
/**
* Combines this instant with a time-zone to create a {@code ZonedDateTime}.
*
* This returns an {@code ZonedDateTime} formed from this instant at the specified time-zone. An exception will be
* thrown if the instant is too large to fit into a zoned date-time.
*
* This method is equivalent to {@link ZonedDateTime#ofInstant(Instant, ZoneId) ZonedDateTime.ofInstant(this,
* zone)}.
*
* @param zone
* the zone to combine with, not null
* @return the zoned date-time formed from this instant and the specified zone, not null
* @throws DateTimeException
* if the result exceeds the supported range
*/
public ZonedDateTime atZone(ZoneId zone) {
return ZonedDateTime.ofInstant(this, zone);
}
// -----------------------------------------------------------------------
/**
* Converts this instant to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z.
*
* If this instant represents a point on the time-line too far in the future or past to fit in a {@code long}
* milliseconds, then an exception is thrown.
*
* If this instant has greater than millisecond precision, then the conversion will drop any excess precision
* information as though the amount in nanoseconds was subject to integer division by one million.
*
* @return the number of milliseconds since the epoch of 1970-01-01T00:00:00Z
*
*/
public long toEpochMilli() {
if (this.seconds < 0 && this.nanos > 0) {
long millis = (this.seconds + 1) * 1000;
long adjustment = this.nanos / 1000_000 - 1000;
return millis + adjustment;
} else {
long millis = this.seconds * 1000;
return millis + this.nanos / 1000_000;
}
}
// -----------------------------------------------------------------------
/**
* Compares this instant to the specified instant.
*
* The comparison is based on the time-line position of the instants. It is "consistent with equals", as defined by
* {@link Comparable}.
*
* @param otherInstant
* the other instant to compare to, not null
* @return the comparator value, negative if less, positive if greater
* @throws NullPointerException
* if otherInstant is null
*/
@Override
public int compareTo(Instant otherInstant) {
int cmp = Long.compare(this.seconds, otherInstant.seconds);
if (cmp != 0) {
return cmp;
}
return this.nanos - otherInstant.nanos;
}
/**
* Checks if this instant is after the specified instant.
*
* The comparison is based on the time-line position of the instants.
*
* @param otherInstant
* the other instant to compare to, not null
* @return true if this instant is after the specified instant
* @throws NullPointerException
* if otherInstant is null
*/
public boolean isAfter(Instant otherInstant) {
return compareTo(otherInstant) > 0;
}
/**
* Checks if this instant is before the specified instant.
*
* The comparison is based on the time-line position of the instants.
*
* @param otherInstant
* the other instant to compare to, not null
* @return true if this instant is before the specified instant
* @throws NullPointerException
* if otherInstant is null
*/
public boolean isBefore(Instant otherInstant) {
return compareTo(otherInstant) < 0;
}
// -----------------------------------------------------------------------
/**
* Checks if this instant is equal to the specified instant.
*
* The comparison is based on the time-line position of the instants.
*
* @param otherInstant
* the other instant, null returns false
* @return true if the other instant is equal to this one
*/
@Override
public boolean equals(@Nullable Object otherInstant) {
if (this == otherInstant) {
return true;
}
if (otherInstant instanceof Instant) {
Instant other = (Instant) otherInstant;
return this.seconds == other.seconds && this.nanos == other.nanos;
}
return false;
}
/**
* Returns a hash code for this instant.
*
* @return a suitable hash code
*/
@Override
public int hashCode() {
return ((int) (this.seconds ^ (this.seconds >>> 32))) + 51 * this.nanos;
}
}
* Instant.ofEpochSecond(3, 1);
* Instant.ofEpochSecond(4, -999_999_999);
* Instant.ofEpochSecond(2, 1000_000_001);
*
*
* @param epochSecond
* the number of seconds from 1970-01-01T00:00:00Z
* @param nanoAdjustment
* the nanosecond adjustment to the number of seconds, positive or negative
* @return an instant, not null
* @throws DateTimeException
* if the instant exceeds the maximum or minimum instant
*
*/
public static Instant ofEpochSecond(long epochSecond, long nanoAdjustment) {
long secs = epochSecond + MathUtils.floorDiv(nanoAdjustment, NANOS_PER_SECOND);
int nos = (int) MathUtils.floorMod(nanoAdjustment, NANOS_PER_SECOND);
return create(secs, nos);
}
/**
* Obtains an instance of {@code Instant} using milliseconds from the epoch of 1970-01-01T00:00:00Z.
*
*
* All other {@code ChronoField} instances will return false.
*
*
* All other {@code ChronoUnit} instances will return false.
*
*
*
*
*
* // these two lines are equivalent, but the second approach is recommended
* temporal = thisInstant.adjustInto(temporal);
* temporal = temporal.with(thisInstant);
*
*
* // these two lines are equivalent
* amount = start.until(end, SECONDS);
* amount = SECONDS.between(start, end);
*
*
* The choice should be made based on which makes the code more readable.
*