// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.parser;

import static org.apache.juneau.internal.CollectionUtils.*;
import static org.apache.juneau.parser.InputStreamParser.*;
import static org.apache.juneau.parser.ReaderParser.*;

import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.http.*;
import org.apache.juneau.internal.*;

/**
 * Builder class for creating instances of {@link ParserGroup}.
 */
public class ParserGroupBuilder extends BeanContextBuilder {

   private final List<Object> parsers;

   /**
    * Create an empty parser group builder.
    */
   public ParserGroupBuilder() {
      this.parsers = new ArrayList<>();
   }

   /**
    * Clone an existing parser group builder.
    *
    * @param copyFrom The parser group that we're copying settings and parsers from.
    */
   public ParserGroupBuilder(ParserGroup copyFrom) {
      super(copyFrom.getPropertyStore());
      this.parsers = new ArrayList<>();
      addReverse(parsers, copyFrom.getParsers());
   }

   /**
    * Registers the specified parsers with this group.
    *
    * @param p The parsers to append to this group.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder append(Class<?>...p) {
      addReverse(parsers, p);
      return this;
   }

   /**
    * Registers the specified parsers with this group.
    *
    * <p>
    * When passing in pre-instantiated parsers to this group, applying properties and transforms to the group
    * do not affect them.
    *
    * @param p The parsers to append to this group.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder append(Parser...p) {
      addReverse(parsers, p);
      return this;
   }

   /**
    * Registers the specified parsers with this group.
    *
    * <p>
    * Objects can either be instances of parsers or parser classes.
    *
    * @param p The parsers to append to this group.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder append(List<Object> p) {
      addReverse(parsers, p);
      return this;
   }

   /**
    * Registers the specified parsers with this group.
    *
    * <p>
    * Objects can either be instances of parsers or parser classes.
    *
    * @param p The parsers to append to this group.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder append(Object...p) {
      addReverse(parsers, p);
      return this;
   }

   /**
    * Creates a new {@link ParserGroup} object using a snapshot of the settings defined in this builder.
    *
    * <p>
    * This method can be called multiple times to produce multiple parser groups.
    *
    * @return A new {@link ParserGroup} object.
    */
   @Override /* Context */
   @SuppressWarnings("unchecked")
   public ParserGroup build() {
      List<Parser> l = new ArrayList<>();
      for (Object p : parsers) {
         Class<? extends Parser> c = null;
         PropertyStore ps = getPropertyStore();
         if (p instanceof Class) {
            c = (Class<? extends Parser>)p;
            l.add(ContextCache.INSTANCE.create(c, ps));
         } else {
            l.add((Parser)p);
         }
      }
      return new ParserGroup(getPropertyStore(), ArrayUtils.toReverseArray(Parser.class, l));
   }


   //-----------------------------------------------------------------------------------------------------------------
   // Properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * Configuration property:  Auto-close streams.
    *
    * <p>
    * If <jk>true</jk>, <l>InputStreams</l> and <l>Readers</l> passed into parsers will be closed
    * after parsing is complete.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_autoCloseStreams}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder autoCloseStreams(boolean value) {
      return set(PARSER_autoCloseStreams, value);
   }

   /**
    * Configuration property:  Auto-close streams.
    * <p>
    * Shortcut for calling <code>autoCloseStreams(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_autoCloseStreams}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder autoCloseStreams() {
      return set(PARSER_autoCloseStreams, true);
   }

   /**
    * Configuration property:  Debug output lines.
    *
    * When parse errors occur, this specifies the number of lines of input before and after the
    * error location to be printed as part of the exception message.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_debugOutputLines}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <code>5</code>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder debugOutputLines(int value) {
      set(PARSER_debugOutputLines, value);
      return this;
   }

   /**
    * Configuration property:  Parser listener.
    *
    * <p>
    * Class used to listen for errors and warnings that occur during parsing.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_listener}
    * </ul>
    *
    * @param value The new value for this property.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder listener(Class<? extends ParserListener> value) {
      return set(PARSER_listener, value);
   }

   /**
    * Configuration property:  Strict mode.
    *
    * <p>
    * If <jk>true</jk>, strict mode for the parsers are enabled.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_strict}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder strict(boolean value) {
      return set(PARSER_strict, value);
   }

   /**
    * Configuration property:  Strict mode.
    *
    * <p>
    * Shortcut for calling <code>strict(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_strict}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder strict() {
      return set(PARSER_strict, true);
   }

   /**
    * Configuration property:  Trim parsed strings.
    *
    * <p>
    * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
    * the POJO.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_trimStrings}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder trimStrings(boolean value) {
      return set(PARSER_trimStrings, value);
   }

   /**
    * Configuration property:  Trim parsed strings.
    *
    * <p>
    * Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_trimStrings}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder trimStrings() {
      return set(PARSER_trimStrings, true);
   }

   /**
    * Configuration property:  Unbuffered.
    *
    * <p>
    * If <jk>true</jk>, don't use internal buffering during parsing.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_unbuffered}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder unbuffered(boolean value) {
      return set(PARSER_unbuffered, value);
   }

   /**
    * Configuration property:  Unbuffered.
    *
    * <p>
    * Shortcut for calling <code>unbuffered(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link Parser#PARSER_unbuffered}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder unbuffered() {
      return set(PARSER_unbuffered, true);
   }

   /**
    * Configuration property:  File charset.
    *
    * <p>
    * The character set to use for reading <code>Files</code> from the file system.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link ReaderParser#RPARSER_fileCharset}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <js>"DEFAULT"</js> which causes the system default to be used.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder fileCharset(String value) {
      return set(RPARSER_fileCharset, value);
   }

   /**
    * Configuration property:  Input stream charset.
    *
    * <p>
    * The character set to use for converting <code>InputStreams</code> and byte arrays to readers.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link ReaderParser#RPARSER_inputStreamCharset}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <js>"UTF-8"</js>.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder inputStreamCharset(String value) {
      return set(RPARSER_inputStreamCharset, value);
   }

   /**
    * Configuration property:  Binary input format.
    *
    * <p>
    * When using the {@link Parser#parse(Object,Class)} method on stream-based parsers and the input is a string, this defines the format to use
    * when converting the string into a byte array.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link InputStreamParser#ISPARSER_binaryFormat}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is {@link BinaryFormat#HEX}.
    * @return This object (for method chaining).
    */
   public ParserGroupBuilder binaryFormat(BinaryFormat value) {
      return set(ISPARSER_binaryFormat, value);
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanClassVisibility(Visibility value) {
      super.beanClassVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanConstructorVisibility(Visibility value) {
      super.beanConstructorVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanDictionary(boolean append, Object...values) {
      super.beanDictionary(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanDictionary(Class<?>...values) {
      super.beanDictionary(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanDictionary(Object...values) {
      super.beanDictionary(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanDictionaryRemove(Object...values) {
      super.beanDictionaryRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanFieldVisibility(Visibility value) {
      super.beanFieldVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanFilters(boolean append, Object...values) {
      super.beanFilters(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanFilters(Class<?>...values) {
      super.beanFilters(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanFilters(Object...values) {
      super.beanFilters(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanFiltersRemove(Object...values) {
      super.beanFiltersRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanMapPutReturnsOldValue(boolean value) {
      super.beanMapPutReturnsOldValue(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanMapPutReturnsOldValue() {
      super.beanMapPutReturnsOldValue();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanMethodVisibility(Visibility value) {
      super.beanMethodVisibility(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireDefaultConstructor(boolean value) {
      super.beansRequireDefaultConstructor(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireDefaultConstructor() {
      super.beansRequireDefaultConstructor();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireSerializable(boolean value) {
      super.beansRequireSerializable(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireSerializable() {
      super.beansRequireSerializable();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireSettersForGetters(boolean value) {
      super.beansRequireSettersForGetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireSettersForGetters() {
      super.beansRequireSettersForGetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beansRequireSomeProperties(boolean value) {
      super.beansRequireSomeProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder beanTypePropertyName(String value) {
      super.beanTypePropertyName(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder debug() {
      super.debug();
      return this;
   }

   @Override /* BeanContextBuilder */
   public <T> ParserGroupBuilder example(Class<T> c, T o) {
      super.example(c, o);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
      super.ignoreInvocationExceptionsOnGetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreInvocationExceptionsOnGetters() {
      super.ignoreInvocationExceptionsOnGetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
      super.ignoreInvocationExceptionsOnSetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreInvocationExceptionsOnSetters() {
      super.ignoreInvocationExceptionsOnSetters();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignorePropertiesWithoutSetters(boolean value) {
      super.ignorePropertiesWithoutSetters(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreUnknownBeanProperties(boolean value) {
      super.ignoreUnknownBeanProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreUnknownBeanProperties() {
      super.ignoreUnknownBeanProperties();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder ignoreUnknownNullBeanProperties(boolean value) {
      super.ignoreUnknownNullBeanProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public <T> ParserGroupBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass) {
      super.implClass(interfaceClass, implClass);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder implClasses(Map<String,Class<?>> values) {
      super.implClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder locale(Locale value) {
      super.locale(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder mediaType(MediaType value) {
      super.mediaType(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanClasses(boolean append, Object...values) {
      super.notBeanClasses(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanClasses(Class<?>...values) {
      super.notBeanClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanClasses(Object...values) {
      super.notBeanClasses(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanClassesRemove(Object...values) {
      super.notBeanClassesRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanPackages(boolean append, Object...values) {
      super.notBeanPackages(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanPackages(Object...values) {
      super.notBeanPackages(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanPackages(String...values) {
      super.notBeanPackages(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder notBeanPackagesRemove(Object...values) {
      super.notBeanPackagesRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder pojoSwaps(boolean append, Object...values) {
      super.pojoSwaps(append, values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder pojoSwaps(Class<?>...values) {
      super.pojoSwaps(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder pojoSwaps(Object...values) {
      super.pojoSwaps(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder pojoSwapsRemove(Object...values) {
      super.pojoSwapsRemove(values);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder sortProperties(boolean value) {
      super.sortProperties(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder sortProperties() {
      super.sortProperties();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder timeZone(TimeZone value) {
      super.timeZone(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder useEnumNames() {
      super.useEnumNames();
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder useInterfaceProxies(boolean value) {
      super.useInterfaceProxies(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder useJavaBeanIntrospector(boolean value) {
      super.useJavaBeanIntrospector(value);
      return this;
   }

   @Override /* BeanContextBuilder */
   public ParserGroupBuilder useJavaBeanIntrospector() {
      super.useJavaBeanIntrospector();
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder set(String name, Object value) {
      super.set(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder set(boolean append, String name, Object value) {
      super.set(append, name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder set(Map<String,Object> properties) {
      super.set(properties);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder add(Map<String,Object> properties) {
      super.add(properties);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder addTo(String name, Object value) {
      super.addTo(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder addTo(String name, String key, Object value) {
      super.addTo(name, key, value);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder removeFrom(String name, Object value) {
      super.removeFrom(name, value);
      return this;
   }

   @Override /* ContextBuilder */
   public ParserGroupBuilder apply(PropertyStore copyFrom) {
      super.apply(copyFrom);
      return this;
   }
}