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

import java.lang.annotation.*;
import java.nio.charset.*;
import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.commons.collections.*;
import org.apache.juneau.commons.function.*;
import org.apache.juneau.commons.reflect.*;
import org.apache.juneau.json.*;
import org.apache.juneau.jsonschema.*;
import org.apache.juneau.xml.*;

/**
 * Serializes POJO metamodels to HTML.
 *
 * <h5 class='topic'>Media types</h5>
 *
 * Handles <c>Accept</c> types:  <bc>text/html+schema</bc>
 * <p>
 * Produces <c>Content-Type</c> types:  <bc>text/html</bc>
 *
 * <h5 class='topic'>Description</h5>
 *
 * Essentially the same as {@link HtmlDocSerializer}, except serializes the POJO metamodel instead of the model itself.
 *
 * <p>
 * Produces output that describes the POJO metamodel similar to an XML schema document.
 *
 * <p>
 * The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()},
 * which will create a schema serializer with the same settings as the originating serializer.
 *
 * <h5 class='section'>Notes:</h5><ul>
 *    <li class='note'>This class is thread safe and reusable.
 * </ul>
 *
 * <h5 class='section'>See Also:</h5><ul>
 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/HtmlBasics">HTML Basics</a>

 * </ul>
 */
public class HtmlSchemaDocSerializer extends HtmlDocSerializer {
   /**
    * Builder class.
    */
   public static class Builder extends HtmlDocSerializer.Builder {

      JsonSchemaGenerator.Builder generatorBuilder;

      /**
       * Constructor, default settings.
       */
      protected Builder() {
         produces("text/html");
         accept("text/html+schema");
         generatorBuilder = JsonSchemaGenerator.create().beanContext(beanContext());
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The builder to copy from.
       */
      protected Builder(Builder copyFrom) {
         super(copyFrom);
         generatorBuilder = copyFrom.generatorBuilder.copy().beanContext(beanContext());
      }

      /**
       * Copy constructor.
       *
       * @param copyFrom The bean to copy from.
       */
      protected Builder(HtmlSchemaDocSerializer copyFrom) {
         super(copyFrom);
         generatorBuilder = copyFrom.generator.copy().beanContext(beanContext());
      }

      @Override /* Overridden from Builder */
      public Builder accept(String value) {
         super.accept(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypes() {
         super.addBeanTypes();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypes(boolean value) {
         super.addBeanTypes(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypesHtml() {
         super.addBeanTypesHtml();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypesHtml(boolean value) {
         super.addBeanTypesHtml(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypesXml() {
         super.addBeanTypesXml();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addBeanTypesXml(boolean value) {
         super.addBeanTypesXml(value);
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  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#getName()}.
       *
       * <h5 class='section'>See Also:</h5><ul>
       *    <li class='jm'>{@link org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#addDescriptionsTo(TypeCategory...)}
       * </ul>
       *
       * @param values
       *    The values to add to this setting.
       *    <br>The default is an empty string.
       * @return This object.
       */
      public Builder addDescriptionsTo(TypeCategory...values) {
         generatorBuilder.addDescriptionsTo(values);
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  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,JsonParserSession)} which in turn gets examples
       * from the following:
       * <ul class='javatree'>
       *    <li class='ja'>{@link Example}
       *    <li class='ja'>{@link Marshalled#example() Marshalled(example)}
       * </ul>
       *
       * <h5 class='section'>See Also:</h5><ul>
       *    <li class='jm'>{@link org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#addExamplesTo(TypeCategory...)}
       * </ul>
       *
       * @param values
       *    The values to add to this setting.
       *    <br>The default is an empty string.
       * @return This object.
       */
      public Builder addExamplesTo(TypeCategory...values) {
         generatorBuilder.addExamplesTo(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addKeyValueTableHeaders() {
         super.addKeyValueTableHeaders();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addKeyValueTableHeaders(boolean value) {
         super.addKeyValueTableHeaders(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addNamespaceUrisToRoot() {
         super.addNamespaceUrisToRoot();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addNamespaceUrisToRoot(boolean value) {
         super.addNamespaceUrisToRoot(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addRootType() {
         super.addRootType();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder addRootType(boolean value) {
         super.addRootType(value);
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  Allow nested descriptions.
       *
       * <p>
       * Identifies whether nested descriptions are allowed in schema definitions.
       *
       * <h5 class='section'>See Also:</h5><ul>
       *    <li class='jm'>{@link org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#allowNestedDescriptions()}
       * </ul>
       *
       * @return This object.
       */
      public Builder allowNestedDescriptions() {
         generatorBuilder.allowNestedDescriptions();
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  Allow nested examples.
       *
       * <p>
       * Identifies whether nested examples are allowed in schema definitions.
       *
       * <h5 class='section'>See Also:</h5><ul>
       *    <li class='jm'>{@link org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#allowNestedExamples()}
       * </ul>
       *
       * @return This object.
       */
      public Builder allowNestedExamples() {
         generatorBuilder.allowNestedExamples();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder annotations(Annotation...values) {
         super.annotations(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder apply(AnnotationWorkList work) {
         super.apply(work);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder applyAnnotations(Class<?>...from) {
         super.applyAnnotations(from);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder applyAnnotations(Object...from) {
         super.applyAnnotations(from);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder aside(String...value) {
         super.aside(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder asideFloat(AsideFloat value) {
         super.asideFloat(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanClassVisibility(Visibility value) {
         super.beanClassVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanConstructorVisibility(Visibility value) {
         super.beanConstructorVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanContext(BeanContext value) {
         super.beanContext(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanContext(BeanContext.Builder value) {
         super.beanContext(value);
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  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 org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#useBeanDefs()} is not enabled.
       *
       * <h5 class='section'>See Also:</h5><ul>
       *    <li class='jm'>{@link org.apache.juneau.jsonschema.JsonSchemaGenerator.Builder#beanDefMapper(Class)}
       * </ul>
       *
       * @param value
       *    The new value for this property.
       *    <br>The default is {@link org.apache.juneau.jsonschema.BasicBeanDefMapper}.
       * @return This object.
       */
      public Builder beanDefMapper(Class<? extends BeanDefMapper> value) {
         generatorBuilder.beanDefMapper(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanDictionary(java.lang.Class<?>...values) {
         super.beanDictionary(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanFieldVisibility(Visibility value) {
         super.beanFieldVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.swap.BeanInterceptor<?>> value) {
         super.beanInterceptor(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanMapPutReturnsOldValue() {
         super.beanMapPutReturnsOldValue();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanMethodVisibility(Visibility value) {
         super.beanMethodVisibility(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(Class<?> beanClass, String properties) {
         super.beanProperties(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(Map<String,Object> values) {
         super.beanProperties(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanProperties(String beanClassName, String properties) {
         super.beanProperties(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(Class<?> beanClass, String properties) {
         super.beanPropertiesExcludes(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(Map<String,Object> values) {
         super.beanPropertiesExcludes(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesExcludes(String beanClassName, String properties) {
         super.beanPropertiesExcludes(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesReadOnly(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(Map<String,Object> values) {
         super.beanPropertiesReadOnly(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesReadOnly(String beanClassName, String properties) {
         super.beanPropertiesReadOnly(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(Class<?> beanClass, String properties) {
         super.beanPropertiesWriteOnly(beanClass, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(Map<String,Object> values) {
         super.beanPropertiesWriteOnly(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {
         super.beanPropertiesWriteOnly(beanClassName, properties);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireDefaultConstructor() {
         super.beansRequireDefaultConstructor();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireSerializable() {
         super.beansRequireSerializable();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder beansRequireSettersForGetters() {
         super.beansRequireSettersForGetters();
         return this;
      }

      @Override /* Overridden from Context.Builder */
      public HtmlSchemaDocSerializer build() {
         return build(HtmlSchemaDocSerializer.class);
      }

      @Override /* Overridden from Builder */
      public Builder cache(Cache<HashKey,? extends org.apache.juneau.Context> value) {
         super.cache(value);
         return this;
      }

      @Override /* Overridden from Context.Builder */
      public Builder copy() {
         return new Builder(this);
      }

      @Override /* Overridden from Builder */
      public Builder debug() {
         super.debug();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder debug(boolean value) {
         super.debug(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder defaultNamespace(Namespace value) {
         super.defaultNamespace(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder detectRecursions() {
         super.detectRecursions();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder detectRecursions(boolean value) {
         super.detectRecursions(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
         super.dictionaryOn(on, values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableAutoDetectNamespaces() {
         super.disableAutoDetectNamespaces();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableAutoDetectNamespaces(boolean value) {
         super.disableAutoDetectNamespaces(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableBeansRequireSomeProperties() {
         super.disableBeansRequireSomeProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableDetectLabelParameters() {
         super.disableDetectLabelParameters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableDetectLabelParameters(boolean value) {
         super.disableDetectLabelParameters(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableDetectLinksInStrings() {
         super.disableDetectLinksInStrings();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableDetectLinksInStrings(boolean value) {
         super.disableDetectLinksInStrings(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreMissingSetters() {
         super.disableIgnoreMissingSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreTransientFields() {
         super.disableIgnoreTransientFields();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableIgnoreUnknownNullBeanProperties() {
         super.disableIgnoreUnknownNullBeanProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder disableInterfaceProxies() {
         super.disableInterfaceProxies();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder enableNamespaces() {
         super.enableNamespaces();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder enableNamespaces(boolean value) {
         super.enableNamespaces(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T> Builder example(Class<T> pojoClass, String json) {
         super.example(pojoClass, json);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T> Builder example(Class<T> pojoClass, T o) {
         super.example(pojoClass, o);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder fileCharset(Charset value) {
         super.fileCharset(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder findFluentSetters() {
         super.findFluentSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder findFluentSetters(Class<?> on) {
         super.findFluentSetters(on);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder footer(String...value) {
         super.footer(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder head(String...value) {
         super.head(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder header(String...value) {
         super.header(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreInvocationExceptionsOnGetters() {
         super.ignoreInvocationExceptionsOnGetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreInvocationExceptionsOnSetters() {
         super.ignoreInvocationExceptionsOnSetters();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreRecursions() {
         super.ignoreRecursions();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreRecursions(boolean value) {
         super.ignoreRecursions(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreUnknownBeanProperties() {
         super.ignoreUnknownBeanProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ignoreUnknownEnumValues() {
         super.ignoreUnknownEnumValues();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder impl(Context value) {
         super.impl(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder implClass(Class<?> interfaceClass, Class<?> implClass) {
         super.implClass(interfaceClass, implClass);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder implClasses(Map<Class<?>,Class<?>> values) {
         super.implClasses(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder initialDepth(int value) {
         super.initialDepth(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder interfaceClass(Class<?> on, Class<?> value) {
         super.interfaceClass(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder interfaces(java.lang.Class<?>...value) {
         super.interfaces(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder keepNullProperties() {
         super.keepNullProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder keepNullProperties(boolean value) {
         super.keepNullProperties(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder labelParameter(String value) {
         super.labelParameter(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder listener(Class<? extends org.apache.juneau.serializer.SerializerListener> value) {
         super.listener(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder locale(Locale value) {
         super.locale(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder maxDepth(int value) {
         super.maxDepth(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder maxIndent(int value) {
         super.maxIndent(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder mediaType(MediaType value) {
         super.mediaType(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder namespaces(Namespace...values) {
         super.namespaces(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder nav(String...value) {
         super.nav(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder navlinks(String...value) {
         super.navlinks(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder noResultsMessage(String value) {
         super.noResultsMessage(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder notBeanClasses(java.lang.Class<?>...values) {
         super.notBeanClasses(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder notBeanPackages(String...values) {
         super.notBeanPackages(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder nowrap() {
         super.nowrap();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder nowrap(boolean value) {
         super.nowrap(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ns() {
         super.ns();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder produces(String value) {
         super.produces(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
         super.propertyNamer(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder quoteChar(char value) {
         super.quoteChar(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder quoteCharOverride(char value) {
         super.quoteCharOverride(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder script(String...value) {
         super.script(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortCollections() {
         super.sortCollections();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortCollections(boolean value) {
         super.sortCollections(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortMaps() {
         super.sortMaps();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortMaps(boolean value) {
         super.sortMaps(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortProperties() {
         super.sortProperties();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sortProperties(java.lang.Class<?>...on) {
         super.sortProperties(on);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder sq() {
         super.sq();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder stopClass(Class<?> on, Class<?> value) {
         super.stopClass(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder streamCharset(Charset value) {
         super.streamCharset(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder style(String...value) {
         super.style(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder stylesheet(String...value) {
         super.stylesheet(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T,S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction) {
         super.swap(normalClass, swappedClass, swapFunction);
         return this;
      }

      @Override /* Overridden from Builder */
      public <T,S> Builder swap(Class<T> normalClass, Class<S> swappedClass, ThrowingFunction<T,S> swapFunction, ThrowingFunction<S,T> unswapFunction) {
         super.swap(normalClass, swappedClass, swapFunction, unswapFunction);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder swaps(Class<?>...values) {
         super.swaps(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder swaps(Object...values) {
         super.swaps(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder template(Class<? extends org.apache.juneau.html.HtmlDocTemplate> value) {
         super.template(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder timeZone(TimeZone value) {
         super.timeZone(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimEmptyCollections() {
         super.trimEmptyCollections();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimEmptyCollections(boolean value) {
         super.trimEmptyCollections(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimEmptyMaps() {
         super.trimEmptyMaps();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimEmptyMaps(boolean value) {
         super.trimEmptyMaps(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimStrings() {
         super.trimStrings();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder trimStrings(boolean value) {
         super.trimStrings(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder type(Class<? extends org.apache.juneau.Context> value) {
         super.type(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typeName(Class<?> on, String value) {
         super.typeName(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typePropertyName(Class<?> on, String value) {
         super.typePropertyName(on, value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder typePropertyName(String value) {
         super.typePropertyName(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder uriAnchorText(AnchorText value) {
         super.uriAnchorText(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder uriContext(UriContext value) {
         super.uriContext(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder uriRelativity(UriRelativity value) {
         super.uriRelativity(value);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder uriResolution(UriResolution value) {
         super.uriResolution(value);
         return this;
      }

      /**
       * <i><l>HtmlSchemaSerializer</l> configuration property:&emsp;</i>  Use bean definitions.
       *
       * <p>
       * When enabled, schemas on beans will be serialized as the following:
       * <p class='bjson'>
       *    {
       *       type: <js>'object'</js>,
       *       <js>'$ref'</js>: <js>'#/definitions/TypeId'</js>
       *    }
       * </p>
       *
       * @return This object.
       */
      public Builder useBeanDefs() {
         generatorBuilder.useBeanDefs();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useEnumNames() {
         super.useEnumNames();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useJavaBeanIntrospector() {
         super.useJavaBeanIntrospector();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useWhitespace() {
         super.useWhitespace();
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder useWhitespace(boolean value) {
         super.useWhitespace(value);
         return this;
      }

      @Override /* Overridden from Builder */
      @SuppressWarnings("unchecked")
      public Builder widgets(java.lang.Class<? extends org.apache.juneau.html.HtmlWidget>...values) {
         super.widgets(values);
         return this;
      }

      @Override /* Overridden from Builder */
      public Builder ws() {
         super.ws();
         return this;
      }
   }

   /**
    * Creates a new builder for this object.
    *
    * @return A new builder.
    */
   public static Builder create() {
      return new Builder();
   }

   final JsonSchemaGenerator generator;

   /**
    * Constructor.
    *
    * @param builder
    *    The builder for this object.
    */
   public HtmlSchemaDocSerializer(HtmlDocSerializer.Builder builder) {
      super(builder.detectRecursions().ignoreRecursions());

      generator = JsonSchemaGenerator.create().beanContext(getBeanContext()).build();
   }

   @Override /* Overridden from Context */
   public Builder copy() {
      return new Builder(this);
   }

   @Override /* Overridden from Context */
   public HtmlSchemaDocSerializerSession.Builder createSession() {
      return HtmlSchemaDocSerializerSession.create(this);
   }

   @Override /* Overridden from Context */
   public HtmlSchemaDocSerializerSession getSession() { return createSession().build(); }

   JsonSchemaGenerator getGenerator() { return generator; }
}