// ***************************************************************************************************************************
// * 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.urlencoding;

import static org.apache.juneau.urlencoding.UrlEncodingSerializer.*;

import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.http.*;
import org.apache.juneau.serializer.*;
import org.apache.juneau.uon.*;

/**
 * Builder class for building instances of URL-Encoding serializers.
 */
public class UrlEncodingSerializerBuilder extends UonSerializerBuilder {

   /**
    * Constructor, default settings.
    */
   public UrlEncodingSerializerBuilder() {
      super();
   }

   /**
    * Constructor.
    *
    * @param ps The initial configuration settings for this builder.
    */
   public UrlEncodingSerializerBuilder(PropertyStore ps) {
      super(ps);
   }

   @Override /* ContextBuilder */
   public UrlEncodingSerializer build() {
      return build(UrlEncodingSerializer.class);
   }


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

   /**
    * Configuration property:  Serialize bean property collections/arrays as separate key/value pairs.
    *
    * <p>
    * If <jk>false</jk>, serializing the array <code>[1,2,3]</code> results in <code>?key=$a(1,2,3)</code>.
    * <br>If <jk>true</jk>, serializing the same array results in <code>?key=1&amp;key=2&amp;key=3</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default value is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public UrlEncodingSerializerBuilder expandedParams(boolean value) {
      return set(URLENC_expandedParams, value);
   }

   /**
    * Configuration property:  Serialize bean property collections/arrays as separate key/value pairs.
    *
    * <p>
    * Shortcut for calling <code>expandedParams(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link UrlEncodingSerializer#URLENC_expandedParams}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public UrlEncodingSerializerBuilder expandedParams() {
      return set(URLENC_expandedParams, true);
   }

   @Override /* UonSerializerBuilder */
   public UrlEncodingSerializerBuilder encoding(boolean value) {
      super.encoding(value);
      return this;
   }

   @Override /* UonSerializerBuilder */
   public UrlEncodingSerializerBuilder encoding() {
      super.encoding();
      return this;
   }

   @Override /* UonSerializerBuilder */
   public UrlEncodingSerializerBuilder paramFormat(ParamFormat paramFormat) {
      super.paramFormat(paramFormat);
      return this;
   }

   @Override /* UonSerializerBuilder */
   public UrlEncodingSerializerBuilder paramFormatPlain() {
      super.paramFormatPlain();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder addBeanTypes(boolean value) {
      super.addBeanTypes(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder addBeanTypes() {
      super.addBeanTypes();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder addRootType(boolean value) {
      super.addRootType(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder addRootType() {
      super.addRootType();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder detectRecursions(boolean value) {
      super.detectRecursions(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder detectRecursions() {
      super.detectRecursions();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder ignoreRecursions(boolean value) {
      super.ignoreRecursions(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder ignoreRecursions() {
      super.ignoreRecursions();
      return this;
   }
   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder initialDepth(int value) {
      super.initialDepth(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder listener(Class<? extends SerializerListener> value) {
      super.listener(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder maxDepth(int value) {
      super.maxDepth(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder maxIndent(int value) {
      super.maxIndent(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder quoteChar(char value) {
      super.quoteChar(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder sortCollections(boolean value) {
      super.sortCollections(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder sortCollections() {
      super.sortCollections();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder sortMaps(boolean value) {
      super.sortMaps(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder sortMaps() {
      super.sortMaps();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder sq() {
      super.sq();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimEmptyCollections(boolean value) {
      super.trimEmptyCollections(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimEmptyCollections() {
      super.trimEmptyCollections();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimEmptyMaps(boolean value) {
      super.trimEmptyMaps(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimEmptyMaps() {
      super.trimEmptyMaps();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimNullProperties(boolean value) {
      super.trimNullProperties(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimStrings(boolean value) {
      super.trimStrings(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder trimStrings() {
      super.trimStrings();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder uriContext(UriContext value) {
      super.uriContext(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder uriRelativity(UriRelativity value) {
      super.uriRelativity(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder uriResolution(UriResolution value) {
      super.uriResolution(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder useWhitespace(boolean value) {
      super.useWhitespace(value);
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder useWhitespace() {
      super.useWhitespace();
      return this;
   }

   @Override /* SerializerBuilder */
   public UrlEncodingSerializerBuilder ws() {
      super.ws();
      return this;
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   /**
    * @deprecated Use {@link Serializer#SERIALIZER_addRootType}.
    */
   @Override
   @Deprecated
   public UrlEncodingSerializerBuilder abridged(boolean value) {
      return this;
   }

   /**
    * @deprecated Use {@link Serializer#SERIALIZER_addRootType}.
    */
   @Override
   @Deprecated
   public UrlEncodingSerializerBuilder abridged() {
      return this;
   }

   /**
    * @deprecated {@link #addBeanTypes(boolean)}
    */
   @Override
   @Deprecated
   public UrlEncodingSerializerBuilder addBeanTypeProperties(boolean value) {
      this.addBeanTypes(value);
      return this;
   }
}