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

import static org.apache.juneau.jsonschema.JsonSchemaGenerator.*;

import java.util.*;

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

/**
 * Builder class for building instances of JSON Schema generators.
 */
public class JsonSchemaGeneratorBuilder extends BeanTraverseBuilder {

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

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

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


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

   /**
    * Configuration property:  Add descriptions.
    *
    * <p>
    * Identifies which categories of types that descriptions should be automatically added to generated schemas.
    * <p>
    * The description is the result of calling {@link ClassMeta#getReadableName()}.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_addDescriptionsTo}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder addDescriptionsTo(String value) {
      return set(JSONSCHEMA_addDescriptionsTo, value);
   }

   /**
    * Configuration property:  Add examples.
    *
    * <p>
    * Identifies which categories of types that examples should be automatically added to generated schemas.
    * <p>
    * The examples come from calling {@link ClassMeta#getExample(BeanSession)} which in turn gets examples
    * from the following:
    * <ul class='doctree'>
    *    <li class='ja'>{@link Example}
    *    <li class='jf'>{@link BeanContext#BEAN_examples}
    * </ul>
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_addExamplesTo}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder addExamplesTo(String value) {
      return set(JSONSCHEMA_addExamplesTo, value);
   }

   /**
    * Configuration property:  Allow nested descriptions.
    *
    * <p>
    * Identifies whether nested descriptions are allowed in schema definitions.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_allowNestedDescriptions}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder allowNestedDescriptions() {
      return set(JSONSCHEMA_allowNestedDescriptions, true);
   }

   /**
    * Configuration property:  Allow nested examples.
    *
    * <p>
    * Identifies whether nested examples are allowed in schema definitions.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_allowNestedExamples}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder allowNestedExamples() {
      return set(JSONSCHEMA_allowNestedExamples, true);
   }

   /**
    * Configuration property:  Schema definition mapper.
    *
    * <p>
    * Interface to use for converting Bean classes to definition IDs and URIs.
    * <p>
    * Used primarily for defining common definition sections for beans in Swagger JSON.
    * <p>
    * This setting is ignored if {@link JsonSchemaGenerator#JSONSCHEMA_useBeanDefs} is not enabled.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_beanDefMapper}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder beanDefMapper(Class<? extends BeanDefMapper> value) {
      return set(JSONSCHEMA_beanDefMapper, value);
   }

   /**
    * Configuration property:  Bean schema definition mapper.
    *
    * <p>
    * Interface to use for converting Bean classes to definition IDs and URIs.
    * <p>
    * Used primarily for defining common definition sections for beans in Swagger JSON.
    * <p>
    * This setting is ignored if {@link JsonSchemaGenerator#JSONSCHEMA_useBeanDefs} is not enabled.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_beanDefMapper}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <jk>false</jk>.
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder beanDefMapper(BeanDefMapper value) {
      return set(JSONSCHEMA_beanDefMapper, value);
   }

   /**
    * Configuration property:  Default schemas.
    *
    * <p>
    * Allows you to override or provide custom schema information for particular class types.
    * <p>
    * Keys are full class names.
    *
    * <h5 class='section'>See Also:</h5>
    * <ul>
    *    <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_defaultSchemas}
    * </ul>
    *
    * @param c
    *    The class to define a default schema for.
    * @param schema
    *    The schema.
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder defaultSchema(Class<?> c, ObjectMap schema) {
      return addTo(JSONSCHEMA_defaultSchemas, c.getName(), schema);
   }

   /**
    * Configuration property:  Use bean definitions.
    *
    * <p>
    * When enabled, schemas on beans will be serialized as the following:
    * <p class='bcode w800'>
    *    {
    *       type: <js>'object'</js>,
    *       <js>'$ref'</js>: <js>'#/definitions/TypeId'</js>
    *    }
    * </p>
    *
    * <p>
    * The definitions can then be retrieved from the session using {@link JsonSchemaGeneratorSession#getBeanDefs()}.
    * <p>
    * Definitions can also be added programmatically using {@link JsonSchemaGeneratorSession#addBeanDef(String, ObjectMap)}.
    *
    * @return This object (for method chaining).
    */
   public JsonSchemaGeneratorBuilder useBeanDefs() {
      return set(JSONSCHEMA_useBeanDefs, true);
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}