/*

 * Copyright (c) 2012, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/*

 * This file is available under and governed by the GNU General Public

 * License version 2 only, as published by the Free Software Foundation.

 * However, the following notice accompanied the original version of this

 * file:

 *

 * Copyright (c) 2007-2012, 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 java.time;

import static java.time.LocalTime.NANOS_PER_SECOND;

import static java.time.LocalTime.SECONDS_PER_DAY;

import static java.time.LocalTime.SECONDS_PER_HOUR;

import static java.time.LocalTime.SECONDS_PER_MINUTE;

import static java.time.temporal.ChronoField.INSTANT_SECONDS;

import static java.time.temporal.ChronoField.MICRO_OF_SECOND;

import static java.time.temporal.ChronoField.MILLI_OF_SECOND;

import static java.time.temporal.ChronoField.NANO_OF_SECOND;

import static java.time.temporal.ChronoUnit.DAYS;

import static java.time.temporal.ChronoUnit.NANOS;

import java.io.DataInput;

import java.io.DataOutput;

import java.io.IOException;

import java.io.InvalidObjectException;

import java.io.ObjectInputStream;

import java.io.Serializable;

import java.time.format.DateTimeFormatter;

import java.time.format.DateTimeParseException;

import java.time.temporal.ChronoField;

import java.time.temporal.ChronoUnit;

import java.time.temporal.Temporal;

import java.time.temporal.TemporalAccessor;

import java.time.temporal.TemporalAdjuster;

import java.time.temporal.TemporalAmount;

import java.time.temporal.TemporalField;

import java.time.temporal.TemporalQueries;

import java.time.temporal.TemporalQuery;

import java.time.temporal.TemporalUnit;

import java.time.temporal.UnsupportedTemporalTypeException;

import java.time.temporal.ValueRange;

import java.util.Objects;

/**

 * An instantaneous point on the time-line.

 * <p>

 * This class models a single instantaneous point on the time-line.

 * This might be used to record event time-stamps in the application.

 * <p>

 * 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.

 *

 * <h2>Time-scale</h2>

 * <p>

 * 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.

 * <p>

 * 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.

 * <p>

 * 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.

 * <p>

 * 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 <i>leap-seconds</i>.

 * 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.

 * <p>

 * 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.

 * <p>

 * Given the complexity of accurate timekeeping described above, this Java API defines

 * its own time-scale, the <i>Java Time-Scale</i>.

 * <p>

 * 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.

 * <p>

 * 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:

 * <ul>

 * <li>the Java Time-Scale shall closely match the underlying international

 *  civil time scale;</li>

 * <li>the Java Time-Scale shall exactly match the international civil

 *  time scale at noon each day;</li>

 * <li>the Java Time-Scale shall have a precisely-defined relationship to

 *  the international civil time scale.</li>

 * </ul>

 * There are currently, as of 2013, two segments in the Java time-scale.

 * <p>

 * 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

 * <a href="http://www.cl.cam.ac.uk/~mgk25/time/utc-sls/">UTC-SLS</a>.

 * 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.

 * <p>

 * 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.

 * <p>

 * 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.

 * <p>

 * 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}.

 *

 * <p>

 * This is a <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>

 * class; use of identity-sensitive operations (including reference equality

 * ({@code ==}), identity hash code, or synchronization) on instances of

 * {@code Instant} may have unpredictable results and should be avoided.

 * The {@code equals} method should be used for comparisons.

 *

 * @implSpec

 * This class is immutable and thread-safe.

 *

 * @since 1.8

 */

public final class Instant

        implements Temporal, TemporalAdjuster, Comparable<Instant>, Serializable {

    /**

     * Constant for the 1970-01-01T00:00:00Z epoch instant.

     */

    public static final Instant EPOCH = new Instant(0, 0);

    /**

     * The minimum supported epoch second.

     */

    private static final long MIN_SECOND = -31557014167219200L;

    /**

     * The maximum supported epoch second.

     */

    private static final long MAX_SECOND = 31556889864403199L;

    /**

     * The minimum supported {@code Instant}, '-1000000000-01-01T00:00Z'.

     * This could be used by an application as a "far past" instant.

     * <p>

     * 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.

     * <p>

     * 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);

    /**

     * Serialization version.

     */

    private static final long serialVersionUID = -665713676816604388L;

    /**

     * 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.

     * <p>

     * This will query the {@link Clock#systemUTC() system UTC clock} to

     * obtain the current instant.

     * <p>

     * 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.

     * <p>

     * This will query the specified clock to obtain the current time.

     * <p>

     * 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) {

        Objects.requireNonNull(clock, "clock");

        return clock.instant();

    }

    //-----------------------------------------------------------------------

    /**

     * Obtains an instance of {@code Instant} using seconds from the

     * epoch of 1970-01-01T00:00:00Z.

     * <p>

     * 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.

     * <p>

     * 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 exactly the same instant:

     * <pre>

     *  Instant.ofEpochSecond(3, 1);

     *  Instant.ofEpochSecond(4, -999_999_999);

     *  Instant.ofEpochSecond(2, 1000_000_001);

     * </pre>

     *

     * @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

     * @throws ArithmeticException if numeric overflow occurs

     */

    public static Instant ofEpochSecond(long epochSecond, long nanoAdjustment) {

        long secs = Math.addExact(epochSecond, Math.floorDiv(nanoAdjustment, NANOS_PER_SECOND));

        int nos = (int)Math.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.

     * <p>

     * 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 = Math.floorDiv(epochMilli, 1000);

        int mos = Math.floorMod(epochMilli, 1000);

        return create(secs, mos * 1000_000);

    }

    //-----------------------------------------------------------------------

    /**

     * Obtains an instance of {@code Instant} from a temporal object.

     * <p>

     * 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}.

     * <p>

     * The conversion extracts the {@link ChronoField#INSTANT_SECONDS INSTANT_SECONDS}

     * and {@link ChronoField#NANO_OF_SECOND NANO_OF_SECOND} fields.

     * <p>

     * 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;

        }

        Objects.requireNonNull(temporal, "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} from a text string such as

     * {@code 2007-12-03T10:15:30.00Z}.

     * <p>

     * The string must represent a valid instant in UTC and is parsed using

     * {@link DateTimeFormatter#ISO_INSTANT}.

     *

     * @param text  the text to parse, not null

     * @return the parsed instant, not null

     * @throws DateTimeParseException if the text cannot be parsed

     */

    public static Instant parse(final CharSequence text) {

        return DateTimeFormatter.ISO_INSTANT.parse(text, Instant::from);

    }

    //-----------------------------------------------------------------------

    /**

     * 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.

     * <p>

     * 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.

     * <p>

     * If the field is a {@link ChronoField} then the query is implemented here.

     * The supported fields are:

     * <ul>

     * <li>{@code NANO_OF_SECOND}

     * <li>{@code MICRO_OF_SECOND}

     * <li>{@code MILLI_OF_SECOND}

     * <li>{@code INSTANT_SECONDS}

     * </ul>

     * All other {@code ChronoField} instances will return false.

     * <p>

     * If the field is not a {@code ChronoField}, then the result of this method

     * is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)}

     * passing {@code this} as the argument.

     * Whether the field is supported is determined by the field.

     *

     * @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(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.

     * <p>

     * This checks if the specified unit can be added to, or subtracted from, this date-time.

     * If false, then calling the {@link #plus(long, TemporalUnit)} and

     * {@link #minus(long, TemporalUnit) minus} methods will throw an exception.

     * <p>

     * If the unit is a {@link ChronoUnit} then the query is implemented here.

     * The supported units are:

     * <ul>

     * <li>{@code NANOS}

     * <li>{@code MICROS}

     * <li>{@code MILLIS}

     * <li>{@code SECONDS}

     * <li>{@code MINUTES}

     * <li>{@code HOURS}

     * <li>{@code HALF_DAYS}

     * <li>{@code DAYS}

     * </ul>

     * All other {@code ChronoUnit} instances will return false.

     * <p>

     * If the unit is not a {@code ChronoUnit}, then the result of this method

     * is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)}

     * passing {@code this} as the argument.

     * Whether the unit is supported is determined by the unit.

     *

     * @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(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.

     * <p>

     * 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.

     * <p>

     * If the field is a {@link ChronoField} then the query is implemented here.

     * The {@link #isSupported(TemporalField) supported fields} will return

     * appropriate range instances.

     * All other {@code ChronoField} instances will throw an {@code UnsupportedTemporalTypeException}.

     * <p>