/*

 * 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) 2008-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.format;

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

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

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

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

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

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

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

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

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

import java.lang.ref.SoftReference;

import java.math.BigDecimal;

import java.math.BigInteger;

import java.math.RoundingMode;

import java.text.ParsePosition;

import java.time.DateTimeException;

import java.time.Instant;

import java.time.LocalDateTime;

import java.time.ZoneId;

import java.time.ZoneOffset;

import java.time.format.DateTimeTextProvider.LocaleStore;

import java.time.temporal.Chrono;

import java.time.temporal.ChronoField;

import java.time.temporal.ISOChrono;

import java.time.temporal.ISOFields;

import java.time.temporal.Queries;

import java.time.temporal.TemporalAccessor;

import java.time.temporal.TemporalField;

import java.time.temporal.TemporalQuery;

import java.time.temporal.ValueRange;

import java.time.temporal.WeekFields;

import java.time.zone.ZoneRulesProvider;

import java.util.AbstractMap.SimpleImmutableEntry;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.Comparator;

import java.util.HashMap;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Locale;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Objects;

import java.util.Set;

import java.util.TimeZone;

import java.util.concurrent.ConcurrentHashMap;

import sun.util.locale.provider.TimeZoneNameUtility;

/**

 * Builder to create date-time formatters.

 * <p>

 * This allows a {@code DateTimeFormatter} to be created.

 * All date-time formatters are created ultimately using this builder.

 * <p>

 * The basic elements of date-time can all be added:

 * <p><ul>

 * <li>Value - a numeric value</li>

 * <li>Fraction - a fractional value including the decimal place. Always use this when

 * outputting fractions to ensure that the fraction is parsed correctly</li>

 * <li>Text - the textual equivalent for the value</li>

 * <li>OffsetId/Offset - the {@linkplain ZoneOffset zone offset}</li>

 * <li>ZoneId - the {@linkplain ZoneId time-zone} id</li>

 * <li>ZoneText - the name of the time-zone</li>

 * <li>Literal - a text literal</li>

 * <li>Nested and Optional - formats can be nested or made optional</li>

 * <li>Other - the printer and parser interfaces can be used to add user supplied formatting</li>

 * </ul><p>

 * In addition, any of the elements may be decorated by padding, either with spaces or any other character.

 * <p>

 * Finally, a shorthand pattern, mostly compatible with {@code java.text.SimpleDateFormat SimpleDateFormat}

 * can be used, see {@link #appendPattern(String)}.

 * In practice, this simply parses the pattern and calls other methods on the builder.

 *

 * <h3>Specification for implementors</h3>

 * This class is a mutable builder intended for use from a single thread.

 *

 * @since 1.8

 */

public final class DateTimeFormatterBuilder {

    /**

     * Query for a time-zone that is region-only.

     */

    private static final TemporalQuery<ZoneId> QUERY_REGION_ONLY = (temporal) -> {

        ZoneId zone = temporal.query(Queries.zoneId());

        return (zone != null && zone instanceof ZoneOffset == false ? zone : null);

    };

    /**

     * The currently active builder, used by the outermost builder.

     */

    private DateTimeFormatterBuilder active = this;

    /**

     * The parent builder, null for the outermost builder.

     */

    private final DateTimeFormatterBuilder parent;

    /**

     * The list of printers that will be used.

     */

    private final List<DateTimePrinterParser> printerParsers = new ArrayList<>();

    /**

     * Whether this builder produces an optional formatter.

     */

    private final boolean optional;

    /**

     * The width to pad the next field to.

     */

    private int padNextWidth;

    /**

     * The character to pad the next field with.

     */

    private char padNextChar;

    /**

     * The index of the last variable width value parser.

     */

    private int valueParserIndex = -1;

    /**

     * Constructs a new instance of the builder.

     */

    public DateTimeFormatterBuilder() {

        super();

        parent = null;

        optional = false;

    }

    /**

     * Constructs a new instance of the builder.

     *

     * @param parent  the parent builder, not null

     * @param optional  whether the formatter is optional, not null

     */

    private DateTimeFormatterBuilder(DateTimeFormatterBuilder parent, boolean optional) {

        super();

        this.parent = parent;

        this.optional = optional;

    }

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

    /**

     * Changes the parse style to be case sensitive for the remainder of the formatter.

     * <p>

     * Parsing can be case sensitive or insensitive - by default it is case sensitive.

     * This method allows the case sensitivity setting of parsing to be changed.

     * <p>

     * Calling this method changes the state of the builder such that all

     * subsequent builder method calls will parse text in case sensitive mode.

     * See {@link #parseCaseInsensitive} for the opposite setting.

     * The parse case sensitive/insensitive methods may be called at any point

     * in the builder, thus the parser can swap between case parsing modes

     * multiple times during the parse.

     * <p>

     * Since the default is case sensitive, this method should only be used after

     * a previous call to {@code #parseCaseInsensitive}.

     *

     * @return this, for chaining, not null

     */

    public DateTimeFormatterBuilder parseCaseSensitive() {

        appendInternal(SettingsParser.SENSITIVE);

        return this;

    }

    /**

     * Changes the parse style to be case insensitive for the remainder of the formatter.

     * <p>

     * Parsing can be case sensitive or insensitive - by default it is case sensitive.

     * This method allows the case sensitivity setting of parsing to be changed.

     * <p>

     * Calling this method changes the state of the builder such that all

     * subsequent builder method calls will parse text in case insensitive mode.

     * See {@link #parseCaseSensitive()} for the opposite setting.

     * The parse case sensitive/insensitive methods may be called at any point

     * in the builder, thus the parser can swap between case parsing modes

     * multiple times during the parse.

     *

     * @return this, for chaining, not null

     */

    public DateTimeFormatterBuilder parseCaseInsensitive() {

        appendInternal(SettingsParser.INSENSITIVE);

        return this;

    }

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

    /**

     * Changes the parse style to be strict for the remainder of the formatter.

     * <p>

     * Parsing can be strict or lenient - by default its strict.

     * This controls the degree of flexibility in matching the text and sign styles.

     * <p>

     * When used, this method changes the parsing to be strict from this point onwards.

     * As strict is the default, this is normally only needed after calling {@link #parseLenient()}.

     * The change will remain in force until the end of the formatter that is eventually

     * constructed or until {@code parseLenient} is called.

     *

     * @return this, for chaining, not null

     */

    public DateTimeFormatterBuilder parseStrict() {

        appendInternal(SettingsParser.STRICT);

        return this;

    }

    /**

     * Changes the parse style to be lenient for the remainder of the formatter.

     * Note that case sensitivity is set separately to this method.

     * <p>

     * Parsing can be strict or lenient - by default its strict.

     * This controls the degree of flexibility in matching the text and sign styles.

     * Applications calling this method should typically also call {@link #parseCaseInsensitive()}.

     * <p>

     * When used, this method changes the parsing to be lenient from this point onwards.

     * The change will remain in force until the end of the formatter that is eventually

     * constructed or until {@code parseStrict} is called.

     *

     * @return this, for chaining, not null

     */

    public DateTimeFormatterBuilder parseLenient() {

        appendInternal(SettingsParser.LENIENT);

        return this;

    }

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

    /**

     * Appends the value of a date-time field to the formatter using a normal

     * output style.

     * <p>

     * The value of the field will be output during a print.

     * If the value cannot be obtained then an exception will be thrown.

     * <p>

     * The value will be printed as per the normal print of an integer value.

     * Only negative numbers will be signed. No padding will be added.

     * <p>

     * The parser for a variable width value such as this normally behaves greedily,

     * requiring one digit, but accepting as many digits as possible.

     * This behavior can be affected by 'adjacent value parsing'.

     * See {@link #appendValue(java.time.temporal.TemporalField, int)} for full details.

     *

     * @param field  the field to append, not null

     * @return this, for chaining, not null

     */

    public DateTimeFormatterBuilder appendValue(TemporalField field) {

        Objects.requireNonNull(field, "field");

        active.valueParserIndex = appendInternal(new NumberPrinterParser(field, 1, 19, SignStyle.NORMAL));

        return this;

    }

    /**

     * Appends the value of a date-time field to the formatter using a fixed

     * width, zero-padded approach.

     * <p>

     * The value of the field will be output during a print.

     * If the value cannot be obtained then an exception will be thrown.

     * <p>

     * The value will be zero-padded on the left. If the size of the value

     * means that it cannot be printed within the width then an exception is thrown.

     * If the value of the field is negative then an exception is thrown during printing.

     * <p>

     * This method supports a special technique of parsing known as 'adjacent value parsing'.

     * This technique solves the problem where a variable length value is followed by one or more

     * fixed length values. The standard parser is greedy, and thus it would normally

     * steal the digits that are needed by the fixed width value parsers that follow the

     * variable width one.

     * <p>

     * No action is required to initiate 'adjacent value parsing'.

     * When a call to {@code appendValue} with a variable width is made, the builder

     * enters adjacent value parsing setup mode. If the immediately subsequent method

     * call or calls on the same builder are to this method, then the parser will reserve

     * space so that the fixed width values can be parsed.

     * <p>

     * For example, consider {@code builder.appendValue(YEAR).appendValue(MONTH_OF_YEAR, 2);}

     * The year is a variable width parse of between 1 and 19 digits.

     * The month is a fixed width parse of 2 digits.

     * Because these were appended to the same builder immediately after one another,

     * the year parser will reserve two digits for the month to parse.

     * Thus, the text '201106' will correctly parse to a year of 2011 and a month of 6.

     * Without adjacent value parsing, the year would greedily parse all six digits and leave

     * nothing for the month.

     * <p>

     * Adjacent value parsing applies to each set of fixed width not-negative values in the parser

     * that immediately follow any kind of variable width value.

     * Calling any other append method will end the setup of adjacent value parsing.

     * Thus, in the unlikely event that you need to avoid adjacent value parsing behavior,

     * simply add the {@code appendValue} to another {@code DateTimeFormatterBuilder}

     * and add that to this builder.

     * <p>

     * If adjacent parsing is active, then parsing must match exactly the specified

     * number of digits in both strict and lenient modes.

     * In addition, no positive or negative sign is permitted.

     *

     * @param field  the field to append, not null

     * @param width  the width of the printed field, from 1 to 19

     * @return this, for chaining, not null

     * @throws IllegalArgumentException if the width is invalid

     */

    public DateTimeFormatterBuilder appendValue(TemporalField field, int width) {

        Objects.requireNonNull(field, "field");

        if (width < 1 || width > 19) {

            throw new IllegalArgumentException("The width must be from 1 to 19 inclusive but was " + width);

        }

        NumberPrinterParser pp = new NumberPrinterParser(field, width, width, SignStyle.NOT_NEGATIVE);

        return appendFixedWidth(width, pp);

    }

    /**

     * Appends the value of a date-time field to the formatter providing full

     * control over printing.

     * <p>

     * The value of the field will be output during a print.

     * If the value cannot be obtained then an exception will be thrown.

     * <p>

     * This method provides full control of the numeric formatting, including

     * zero-padding and the positive/negative sign.

     * <p>

     * The parser for a variable width value such as this normally behaves greedily,

     * accepting as many digits as possible.

     * This behavior can be affected by 'adjacent value parsing'.

     * See {@link #appendValue(java.time.temporal.TemporalField, int)} for full details.

     * <p>

     * In strict parsing mode, the minimum number of parsed digits is {@code minWidth}.

     * In lenient parsing mode, the minimum number of parsed digits is one.

     * <p>

     * If this method is invoked with equal minimum and maximum widths and a sign style of

     * {@code NOT_NEGATIVE} then it delegates to {@code appendValue(TemporalField,int)}.

     * In this scenario, the printing and parsing behavior described there occur.

     *

     * @param field  the field to append, not null

     * @param minWidth  the minimum field width of the printed field, from 1 to 19

     * @param maxWidth  the maximum field width of the printed field, from 1 to 19

     * @param signStyle  the positive/negative output style, not null

     * @return this, for chaining, not null

     * @throws IllegalArgumentException if the widths are invalid

     */

    public DateTimeFormatterBuilder appendValue(

            TemporalField field, int minWidth, int maxWidth, SignStyle signStyle) {

        if (minWidth == maxWidth && signStyle == SignStyle.NOT_NEGATIVE) {

            return appendValue(field, maxWidth);

        }

        Objects.requireNonNull(field, "field");

        Objects.requireNonNull(signStyle, "signStyle");

        if (minWidth < 1 || minWidth > 19) {

            throw new IllegalArgumentException("The minimum width must be from 1 to 19 inclusive but was " + minWidth);

        }

        if (maxWidth < 1 || maxWidth > 19) {

            throw new IllegalArgumentException("The maximum width must be from 1 to 19 inclusive but was " + maxWidth);

        }

        if (maxWidth < minWidth) {

            throw new IllegalArgumentException("The maximum width must exceed or equal the minimum width but " +

                    maxWidth + " < " + minWidth);

        }

        NumberPrinterParser pp = new NumberPrinterParser(field, minWidth, maxWidth, signStyle);

        if (minWidth == maxWidth) {

            appendInternal(pp);

        } else {

            active.valueParserIndex = appendInternal(pp);

        }

        return this;

    }

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

    /**

     * Appends the reduced value of a date-time field to the formatter.

     * <p>

     * This is typically used for printing and parsing a two digit year.

     * The {@code width} is the printed and parsed width.

     * The {@code baseValue} is used during parsing to determine the valid range.

     * <p>

     * For printing, the width is used to determine the number of characters to print.

     * The rightmost characters are output to match the width, left padding with zero.

     * <p>

     * For parsing, exactly the number of characters specified by the width are parsed.

     * This is incomplete information however, so the base value is used to complete the parse.

     * The base value is the first valid value in a range of ten to the power of width.

     * <p>

     * For example, a base value of {@code 1980} and a width of {@code 2} will have

     * valid values from {@code 1980} to {@code 2079}.

     * During parsing, the text {@code "12"} will result in the value {@code 2012} as that

     * is the value within the range where the last two digits are "12".

     * <p>

     * This is a fixed width parser operating using 'adjacent value parsing'.

     * See {@link #appendValue(java.time.temporal.TemporalField, int)} for full details.

     *

     * @param field  the field to append, not null

     * @param width  the width of the printed and parsed field, from 1 to 18

     * @param baseValue  the base value of the range of valid values

     * @return this, for chaining, not null

     * @throws IllegalArgumentException if the width or base value is invalid

     */

    public DateTimeFormatterBuilder appendValueReduced(

            TemporalField field, int width, int baseValue) {

        Objects.requireNonNull(field, "field");

        ReducedPrinterParser pp = new ReducedPrinterParser(field, width, baseValue);

        appendFixedWidth(width, pp);

        return this;

    }

    /**

     * Appends a fixed width printer-parser.

     *

     * @param width  the width

     * @param pp  the printer-parser, not null

     * @return this, for chaining, not null

     */

    private DateTimeFormatterBuilder appendFixedWidth(int width, NumberPrinterParser pp) {

        if (active.valueParserIndex >= 0) {

            // adjacent parsing mode, update setting in previous parsers

            NumberPrinterParser basePP = (NumberPrinterParser) active.printerParsers.get(active.valueParserIndex);

            basePP = basePP.withSubsequentWidth(width);

            int activeValueParser = active.valueParserIndex;

            active.printerParsers.set(active.valueParserIndex, basePP);

            appendInternal(pp.withFixedWidth());

            active.valueParserIndex = activeValueParser;

        } else {

            // not adjacent parsing

            appendInternal(pp);

        }

        return this;

    }

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

    /**

     * Appends the fractional value of a date-time field to the formatter.

     * <p>

     * The fractional value of the field will be output including the

     * preceding decimal point. The preceding value is not output.

     * For example, the second-of-minute value of 15 would be output as {@code .25}.

     * <p>

     * The width of the printed fraction can be controlled. Setting the

     * minimum width to zero will cause no output to be generated.

     * The printed fraction will have the minimum width necessary between

     * the minimum and maximum widths - trailing zeroes are omitted.

     * No rounding occurs due to the maximum width - digits are simply dropped.

     * <p>

     * When parsing in strict mode, the number of parsed digits must be between

     * the minimum and maximum width. When parsing in lenient mode, the minimum

     * width is considered to be zero and the maximum is nine.

     * <p>

     * If the value cannot be obtained then an exception will be thrown.

     * If the value is negative an exception will be thrown.

     * If the field does not have a fixed set of valid values then an

     * exception will be thrown.

     * If the field value in the date-time to be printed is invalid it

     * cannot be printed and an exception will be thrown.

     *

     * @param field  the field to append, not null

     * @param minWidth  the minimum width of the field excluding the decimal point, from 0 to 9

     * @param maxWidth  the maximum width of the field excluding the decimal point, from 1 to 9

     * @param decimalPoint  whether to output the localized decimal point symbol

     * @return this, for chaining, not null

     * @throws IllegalArgumentException if the field has a variable set of valid values or

     *  either width is invalid

     */

    public DateTimeFormatterBuilder appendFraction(

            TemporalField field, int minWidth, int maxWidth, boolean decimalPoint) {

        appendInternal(new FractionPrinterParser(field, minWidth, maxWidth, decimalPoint));

        return this;

    }

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

    /**

     * Appends the text of a date-time field to the formatter using the full

     * text style.

     * <p>

     * The text of the field will be output during a print.

     * The value must be within the valid range of the field.