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

import static org.apache.juneau.xml.XmlSerializer.*;

import java.util.*;

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

/**
 * Builder class for building instances of XML serializers.
 */
public class XmlSerializerBuilder extends WriterSerializerBuilder {

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

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

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


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

   /**
    * Configuration property:  Add namespace URLs to the root element.
    *
    * <p>
    * Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_addNamespaceUrisToRoot}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder addNamespaceUrisToRoot(boolean value) {
      return set(XML_addNamespaceUrisToRoot, value);
   }

   /**
    * Configuration property:  Add namespace URLs to the root element.
    *
    * <p>
    * Shortcut for calling <code>addNamespaceUrisToRoot(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_addNamespaceUrisToRoot}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder addNamespaceUrisToRoot() {
      return set(XML_addNamespaceUrisToRoot, true);
   }

   /**
    * Configuration property:  Auto-detect namespace usage.
    *
    * <p>
    * Detect namespace usage before serialization.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_autoDetectNamespaces}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>true</jk>.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder autoDetectNamespaces(boolean value) {
      return set(XML_autoDetectNamespaces, value);
   }

   /**
    * Configuration property:  Default namespace.
    *
    * <p>
    * Specifies the default namespace URI for this document.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_defaultNamespace}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <js>"juneau: http://www.apache.org/2013/Juneau"</js>.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder defaultNamespace(String value) {
      return set(XML_defaultNamespace, value);
   }

   /**
    * Configuration property:  Enable support for XML namespaces.
    *
    * <p>
    * If not enabled, XML output will not contain any namespaces regardless of any other settings.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder enableNamespaces(boolean value) {
      return set(XML_enableNamespaces, value);
   }

   /**
    * Configuration property:  Enable support for XML namespaces.
    *
    * <p>
    * Shortcut for calling <code>enableNamespaces(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder enableNamespaces() {
      return set(XML_enableNamespaces, true);
   }

   /**
    * Configuration property:  Enable support for XML namespaces.
    *
    * <p>
    * Shortcut for calling <code>enableNamespaces(<jk>true</jk>)</code>.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_enableNamespaces}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder ns() {
      return set(XML_enableNamespaces, true);
   }

   /**
    * Configuration property:  Default namespaces.
    *
    * <p>
    * The default list of namespaces associated with this serializer.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_namespaces}
    * </ul>
    *
    * @param values The new value for this property.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder namespaces(Namespace...values) {
      return set(XML_namespaces, values);
   }

   /**
    * Configuration property:  XMLSchema namespace.
    *
    * <p>
    * Specifies the namespace for the <code>XMLSchema</code> namespace, used by the schema generated by the
    * {@link org.apache.juneau.xmlschema.XmlSchemaSerializer} class.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link XmlSerializer#XML_xsNamespace}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <js>"xs: http://www.w3.org/2001/XMLSchema"</js>.
    * @return This object (for method chaining).
    */
   public XmlSerializerBuilder xsNamespace(Namespace value) {
      return set(XML_xsNamespace, value);
   }

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

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

   @Override /* WriterSerializerBuilder */
   public XmlSerializerBuilder sq() {
      super.sq();
      return this;
   }

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

   @Override /* WriterSerializerBuilder */
   public XmlSerializerBuilder useWhitespace() {
      super.useWhitespace();
      return this;
   }

   @Override /* WriterSerializerBuilder */
   public XmlSerializerBuilder ws() {
      super.ws();
      return this;
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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