/*

 * Copyright (c) 2012, 2013, 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.temporal.ChronoField.HOUR_OF_DAY;

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

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

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

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

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

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

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

/**

 * A time without time-zone in the ISO-8601 calendar system,

 * such as {@code 10:15:30}.

 * <p>

 * {@code LocalTime} is an immutable date-time object that represents a time,

 * often viewed as hour-minute-second.

 * Time is represented to nanosecond precision.

 * For example, the value "13:45.30.123456789" can be stored in a {@code LocalTime}.

 * <p>

 * It does not store or represent a date or time-zone.

 * Instead, it is a description of the local time as seen on a wall clock.

 * It cannot represent an instant on the time-line without additional information

 * such as an offset or time-zone.

 * <p>

 * The ISO-8601 calendar system is the modern civil calendar system used today

 * in most of the world. This API assumes that all calendar systems use the same

 * representation, this class, for time-of-day.

 *

 * @implSpec

 * This class is immutable and thread-safe.

 *

 * @since 1.8

 */

public final class LocalTime

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

    /**

     * The minimum supported {@code LocalTime}, '00:00'.

     * This is the time of midnight at the start of the day.

     */

    public static final LocalTime MIN;

    /**

     * The maximum supported {@code LocalTime}, '23:59:59.999999999'.

     * This is the time just before midnight at the end of the day.

     */

    public static final LocalTime MAX;

    /**

     * The time of midnight at the start of the day, '00:00'.

     */

    public static final LocalTime MIDNIGHT;

    /**

     * The time of noon in the middle of the day, '12:00'.

     */

    public static final LocalTime NOON;

    /**

     * Constants for the local time of each hour.

     */

    private static final LocalTime[] HOURS = new LocalTime[24];

    static {

        for (int i = 0; i < HOURS.length; i++) {

            HOURS[i] = new LocalTime(i, 0, 0, 0);

        }

        MIDNIGHT = HOURS[0];

        NOON = HOURS[12];

        MIN = HOURS[0];

        MAX = new LocalTime(23, 59, 59, 999_999_999);

    }

    /**

     * Hours per day.

     */

    static final int HOURS_PER_DAY = 24;

    /**

     * Minutes per hour.

     */

    static final int MINUTES_PER_HOUR = 60;

    /**

     * Minutes per day.

     */

    static final int MINUTES_PER_DAY = MINUTES_PER_HOUR * HOURS_PER_DAY;

    /**

     * Seconds per minute.

     */

    static final int SECONDS_PER_MINUTE = 60;

    /**

     * Seconds per hour.

     */

    static final int SECONDS_PER_HOUR = SECONDS_PER_MINUTE * MINUTES_PER_HOUR;

    /**

     * Seconds per day.

     */

    static final int SECONDS_PER_DAY = SECONDS_PER_HOUR * HOURS_PER_DAY;

    /**

     * Milliseconds per day.

     */

    static final long MILLIS_PER_DAY = SECONDS_PER_DAY * 1000L;

    /**

     * Microseconds per day.

     */

    static final long MICROS_PER_DAY = SECONDS_PER_DAY * 1000_000L;

    /**

     * Nanos per second.

     */

    static final long NANOS_PER_SECOND = 1000_000_000L;

    /**

     * Nanos per minute.

     */

    static final long NANOS_PER_MINUTE = NANOS_PER_SECOND * SECONDS_PER_MINUTE;

    /**

     * Nanos per hour.

     */

    static final long NANOS_PER_HOUR = NANOS_PER_MINUTE * MINUTES_PER_HOUR;

    /**

     * Nanos per day.

     */

    static final long NANOS_PER_DAY = NANOS_PER_HOUR * HOURS_PER_DAY;

    /**

     * Serialization version.

     */

    private static final long serialVersionUID = 6414437269572265201L;

    /**

     * The hour.

     */

    private final byte hour;

    /**

     * The minute.

     */

    private final byte minute;

    /**

     * The second.

     */

    private final byte second;

    /**

     * The nanosecond.

     */

    private final int nano;

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

    /**

     * Obtains the current time from the system clock in the default time-zone.

     * <p>

     * This will query the {@link Clock#systemDefaultZone() system clock} in the default

     * time-zone to obtain the current time.

     * <p>

     * 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 and default time-zone, not null

     */

    public static LocalTime now() {

        return now(Clock.systemDefaultZone());

    }

    /**

     * Obtains the current time from the system clock in the specified time-zone.

     * <p>

     * This will query the {@link Clock#system(ZoneId) system clock} to obtain the current time.

     * Specifying the time-zone avoids dependence on the default time-zone.

     * <p>

     * 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 LocalTime now(ZoneId zone) {

        return now(Clock.system(zone));

    }

    /**

     * Obtains the current time from the specified clock.

     * <p>

     * 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 time, not null

     */

    public static LocalTime now(Clock clock) {

        Objects.requireNonNull(clock, "clock");

        // inline OffsetTime factory to avoid creating object and InstantProvider checks

        final Instant now = clock.instant();  // called once

        ZoneOffset offset = clock.getZone().getRules().getOffset(now);

        long localSecond = now.getEpochSecond() + offset.getTotalSeconds();  // overflow caught later

        int secsOfDay = (int) Math.floorMod(localSecond, SECONDS_PER_DAY);

        return ofNanoOfDay(secsOfDay * NANOS_PER_SECOND + now.getNano());

    }

    //------------------------get-----------------------------------------------

    /**

     * Obtains an instance of {@code LocalTime} from an hour and minute.

     * <p>

     * This returns a {@code LocalTime} with the specified hour and minute.

     * The second and nanosecond fields will be set to zero.

     *

     * @param hour  the hour-of-day to represent, from 0 to 23

     * @param minute  the minute-of-hour to represent, from 0 to 59

     * @return the local time, not null

     * @throws DateTimeException if the value of any field is out of range

     */

    public static LocalTime of(int hour, int minute) {

        HOUR_OF_DAY.checkValidValue(hour);

        if (minute == 0) {

            return HOURS[hour];  // for performance

        }

        MINUTE_OF_HOUR.checkValidValue(minute);

        return new LocalTime(hour, minute, 0, 0);

    }

    /**

     * Obtains an instance of {@code LocalTime} from an hour, minute and second.

     * <p>

     * This returns a {@code LocalTime} with the specified hour, minute and second.

     * The nanosecond field will be set to zero.

     *

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

     * @return the local time, not null

     * @throws DateTimeException if the value of any field is out of range

     */

    public static LocalTime of(int hour, int minute, int second) {

        HOUR_OF_DAY.checkValidValue(hour);

        if ((minute | second) == 0) {

            return HOURS[hour];  // for performance

        }

        MINUTE_OF_HOUR.checkValidValue(minute);

        SECOND_OF_MINUTE.checkValidValue(second);

        return new LocalTime(hour, minute, second, 0);

    }

    /**

     * Obtains an instance of {@code LocalTime} from an hour, minute, second and nanosecond.

     * <p>

     * This returns a {@code LocalTime} with the specified hour, minute, second and nanosecond.

     *

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

     * @return the local time, not null

     * @throws DateTimeException if the value of any field is out of range

     */

    public static LocalTime of(int hour, int minute, int second, int nanoOfSecond) {

        HOUR_OF_DAY.checkValidValue(hour);

        MINUTE_OF_HOUR.checkValidValue(minute);

        SECOND_OF_MINUTE.checkValidValue(second);

        NANO_OF_SECOND.checkValidValue(nanoOfSecond);

        return create(hour, minute, second, nanoOfSecond);

    }

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

    /**

     * Obtains an instance of {@code LocalTime} from a second-of-day value.

     * <p>

     * This returns a {@code LocalTime} with the specified second-of-day.

     * The nanosecond field will be set to zero.

     *

     * @param secondOfDay  the second-of-day, from {@code 0} to {@code 24 * 60 * 60 - 1}

     * @return the local time, not null

     * @throws DateTimeException if the second-of-day value is invalid

     */

    public static LocalTime ofSecondOfDay(long secondOfDay) {

        SECOND_OF_DAY.checkValidValue(secondOfDay);

        int hours = (int) (secondOfDay / SECONDS_PER_HOUR);

        secondOfDay -= hours * SECONDS_PER_HOUR;

        int minutes = (int) (secondOfDay / SECONDS_PER_MINUTE);

        secondOfDay -= minutes * SECONDS_PER_MINUTE;

        return create(hours, minutes, (int) secondOfDay, 0);

    }

    /**

     * Obtains an instance of {@code LocalTime} from a nanos-of-day value.

     * <p>

     * This returns a {@code LocalTime} with the specified nanosecond-of-day.

     *

     * @param nanoOfDay  the nano of day, from {@code 0} to {@code 24 * 60 * 60 * 1,000,000,000 - 1}

     * @return the local time, not null

     * @throws DateTimeException if the nanos of day value is invalid

     */

    public static LocalTime ofNanoOfDay(long nanoOfDay) {

        NANO_OF_DAY.checkValidValue(nanoOfDay);

        int hours = (int) (nanoOfDay / NANOS_PER_HOUR);

        nanoOfDay -= hours * NANOS_PER_HOUR;

        int minutes = (int) (nanoOfDay / NANOS_PER_MINUTE);

        nanoOfDay -= minutes * NANOS_PER_MINUTE;

        int seconds = (int) (nanoOfDay / NANOS_PER_SECOND);

        nanoOfDay -= seconds * NANOS_PER_SECOND;

        return create(hours, minutes, seconds, (int) nanoOfDay);

    }

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

    /**

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

     * <p>

     * This obtains a local time based on the specified temporal.

     * A {@code TemporalAccessor} represents an arbitrary set of date and time information,

     * which this factory converts to an instance of {@code LocalTime}.

     * <p>

     * The conversion uses the {@link TemporalQueries#localTime()} query, which relies

     * on extracting the {@link ChronoField#NANO_OF_DAY NANO_OF_DAY} field.

     * <p>

     * This method matches the signature of the functional interface {@link TemporalQuery}

     * allowing it to be used in queries via method reference, {@code LocalTime::from}.

     *

     * @param temporal  the temporal object to convert, not null

     * @return the local time, not null

     * @throws DateTimeException if unable to convert to a {@code LocalTime}

     */

    public static LocalTime from(TemporalAccessor temporal) {

        Objects.requireNonNull(temporal, "temporal");

        LocalTime time = temporal.query(TemporalQueries.localTime());

        if (time == null) {

            throw new DateTimeException("Unable to obtain LocalTime from TemporalAccessor: " +

                    temporal + " of type " + temporal.getClass().getName());

        }

        return time;

    }

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

    /**

     * Obtains an instance of {@code LocalTime} from a text string such as {@code 10:15}.

     * <p>

     * The string must represent a valid time and is parsed using

     * {@link java.time.format.DateTimeFormatter#ISO_LOCAL_TIME}.

     *

     * @param text the text to parse such as "10:15:30", not null

     * @return the parsed local time, not null

     * @throws DateTimeParseException if the text cannot be parsed

     */

    public static LocalTime parse(CharSequence text) {

        return parse(text, DateTimeFormatter.ISO_LOCAL_TIME);

    }

    /**

     * Obtains an instance of {@code LocalTime} from a text string using a specific formatter.

     * <p>

     * 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 local time, not null

     * @throws DateTimeParseException if the text cannot be parsed

     */

    public static LocalTime parse(CharSequence text, DateTimeFormatter formatter) {

        Objects.requireNonNull(formatter, "formatter");

        return formatter.parse(text, LocalTime::from);

    }

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

    /**

     * Creates a local time from the hour, minute, second and nanosecond fields.

     * <p>

     * This factory may return a cached value, but applications must not rely on this.

     *

     * @param hour  the hour-of-day to represent, validated from 0 to 23

     * @param minute  the minute-of-hour to represent, validated from 0 to 59

     * @param second  the second-of-minute to represent, validated from 0 to 59

     * @param nanoOfSecond  the nano-of-second to represent, validated from 0 to 999,999,999

     * @return the local time, not null

     */

    private static LocalTime create(int hour, int minute, int second, int nanoOfSecond) {

        if ((minute | second | nanoOfSecond) == 0) {

            return HOURS[hour];

        }

        return new LocalTime(hour, minute, second, nanoOfSecond);

    }

    /**

     * Constructor, previously validated.

     *

     * @param hour  the hour-of-day to represent, validated from 0 to 23

     * @param minute  the minute-of-hour to represent, validated from 0 to 59

     * @param second  the second-of-minute to represent, validated from 0 to 59

     * @param nanoOfSecond  the nano-of-second to represent, validated from 0 to 999,999,999

     */

    private LocalTime(int hour, int minute, int second, int nanoOfSecond) {

        this.hour = (byte) hour;

        this.minute = (byte) minute;

        this.second = (byte) second;

        this.nano = nanoOfSecond;

    }

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

    /**

     * Checks if the specified field is supported.

     * <p>

     * This checks if this time can be queried for the specified field.

     * If false, then calling the {@link #range(TemporalField) range},

     * {@link #get(TemporalField) get} and {@link #with(TemporalField, long)}

     * methods will throw an exception.

     * <p>

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

     * The supported fields are:

     * <ul>

     * <li>{@code NANO_OF_SECOND}

     * <li>{@code NANO_OF_DAY}

     * <li>{@code MICRO_OF_SECOND}

     * <li>{@code MICRO_OF_DAY}

     * <li>{@code MILLI_OF_SECOND}

     * <li>{@code MILLI_OF_DAY}

     * <li>{@code SECOND_OF_MINUTE}

     * <li>{@code SECOND_OF_DAY}

     * <li>{@code MINUTE_OF_HOUR}

     * <li>{@code MINUTE_OF_DAY}

     * <li>{@code HOUR_OF_AMPM}

     * <li>{@code CLOCK_HOUR_OF_AMPM}

     * <li>{@code HOUR_OF_DAY}

     * <li>{@code CLOCK_HOUR_OF_DAY}

     * <li>{@code AMPM_OF_DAY}

     * </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 time, false if not

     */

    @Override

    public boolean isSupported(TemporalField field) {

        if (field instanceof ChronoField) {

            return field.isTimeBased();

        }

        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.