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

import static org.apache.juneau.BeanTraverseContext.*;

import java.lang.annotation.*;
import java.lang.reflect.*;
import java.util.*;

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

/**
 * Builder class for building instances of bean traversals.
 */
public class BeanTraverseBuilder extends BeanContextBuilder {

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

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

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

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Automatically detect POJO recursions.
    *
    * <div class='warn'>
    *    <b>Deprecated</b> - Use {@link #detectRecursions()}
    * </div>
    */
   @SuppressWarnings("javadoc")
   @FluentSetter
   @Deprecated
   public BeanTraverseBuilder detectRecursions(boolean value) {
      return set(BEANTRAVERSE_detectRecursions, value);
   }

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Automatically detect POJO recursions.
    *
    * <p>
    * When enabled, specifies that recursions should be checked for during traversal.
    *
    * <p>
    * Recursions can occur when traversing models that aren't true trees but rather contain loops.
    * <br>In general, unchecked recursions cause stack-overflow-errors.
    * <br>These show up as {@link BeanRecursionException BeanRecursionException} with the message <js>"Depth too deep.  Stack overflow occurred."</js>.
    *
    * <ul class='notes'>
    *    <li>
    *       Checking for recursion can cause a small performance penalty.
    * </ul>
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create a serializer that automatically checks for recursions.</jc>
    *    WriterSerializer s = JsonSerializer
    *       .<jsm>create</jsm>()
    *       .detectRecursions()
    *       .build();
    *
    *    <jc>// Create a POJO model with a recursive loop.</jc>
    *    <jk>public class</jk> A {
    *       <jk>public</jk> Object <jf>f</jf>;
    *    }
    *    A a = <jk>new</jk> A();
    *    a.<jf>f</jf> = a;
    *
    *    <jc>// Throws a SerializeException and not a StackOverflowError</jc>
    *    String json = s.serialize(a);
    * </p>
    *
    * <ul class='seealso'>
    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_detectRecursions}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   @FluentSetter
   public BeanTraverseBuilder detectRecursions() {
      return set(BEANTRAVERSE_detectRecursions, true);
   }

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Ignore recursion errors.
    *
    * <div class='warn'>
    *    <b>Deprecated</b> - Use {@link #ignoreRecursions()}
    * </div>
    */
   @SuppressWarnings("javadoc")
   @FluentSetter
   @Deprecated
   public BeanTraverseBuilder ignoreRecursions(boolean value) {
      return set(BEANTRAVERSE_ignoreRecursions, value);
   }

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Ignore recursion errors.
    *
    * <p>
    * When enabled, when we encounter the same object when traversing a tree, we set the value to <jk>null</jk>.
    *
    * <p>
    * For example, if a model contains the links A-&gt;B-&gt;C-&gt;A, then the JSON generated will look like
    *    the following when <jsf>BEANTRAVERSE_ignoreRecursions</jsf> is <jk>true</jk>...
    *
    * <p class='bcode w800'>
    *    {A:{B:{C:<jk>null</jk>}}}
    * </p>
    *
    * <ul class='notes'>
    *    <li>
    *       Checking for recursion can cause a small performance penalty.
    * </ul>
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create a serializer ignores recursions.</jc>
    *    WriterSerializer s = JsonSerializer
    *       .<jsm>create</jsm>()
    *       .ignoreRecursions()
    *       .build();
    *
    *    <jc>// Create a POJO model with a recursive loop.</jc>
    *    <jk>public class</jk> A {
    *       <jk>public</jk> Object <jf>f</jf>;
    *    }
    *    A a = <jk>new</jk> A();
    *    a.<jf>f</jf> = a;
    *
    *    <jc>// Produces "{f:null}"</jc>
    *    String json = s.serialize(a);
    * </p>
    *
    * <ul class='seealso'>
    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_ignoreRecursions}
    * </ul>
    *
    * @return This object (for method chaining).
    */
   @FluentSetter
   public BeanTraverseBuilder ignoreRecursions() {
      return set(BEANTRAVERSE_ignoreRecursions, true);
   }

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Initial depth.
    *
    * <p>
    * The initial indentation level at the root.
    *
    * <p>
    * Useful when constructing document fragments that need to be indented at a certain level when whitespace is enabled.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create a serializer with whitespace enabled and an initial depth of 2.</jc>
    *    WriterSerializer s = JsonSerializer
    *       .<jsm>create</jsm>()
    *       .ws()
    *       .initialDepth(2)
    *       .build();
    *
    *    <jc>// Produces "\t\t{\n\t\t\t'foo':'bar'\n\t\t}\n"</jc>
    *    String json = s.serialize(<jk>new</jk> MyBean());
    * </p>
    *
    * <ul class='seealso'>
    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_initialDepth}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <c>0</c>.
    * @return This object (for method chaining).
    */
   @FluentSetter
   public BeanTraverseBuilder initialDepth(int value) {
      return set(BEANTRAVERSE_initialDepth, value);
   }

   /**
    * <i><l>BeanTraverse</l> configuration property:&emsp;</i>  Max traversal depth.
    *
    * <p>
    * When enabled, abort traversal if specified depth is reached in the POJO tree.
    *
    * <p>
    * If this depth is exceeded, an exception is thrown.
    *
    * <p>
    * This prevents stack overflows from occurring when trying to traverse models with recursive references.
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create a serializer that throws an exception if the depth reaches greater than 20.</jc>
    *    WriterSerializer s = JsonSerializer
    *       .<jsm>create</jsm>()
    *       .maxDepth(20)
    *       .build();
    * </p>
    *
    * <ul class='seealso'>
    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_maxDepth}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is <c>100</c>.
    * @return This object (for method chaining).
    */
   @FluentSetter
   public BeanTraverseBuilder maxDepth(int value) {
      return set(BEANTRAVERSE_maxDepth, value);
   }

   // <FluentSetters>

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

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

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder appendTo(String name, Object value) {
      super.appendTo(name, value);
      return this;
   }

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

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
      super.applyAnnotations(fromClasses);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder applyAnnotations(Method...fromMethods) {
      super.applyAnnotations(fromMethods);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
      super.applyAnnotations(al, r);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder debug() {
      super.debug();
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder locale(Locale value) {
      super.locale(value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder mediaType(MediaType value) {
      super.mediaType(value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder prependTo(String name, Object value) {
      super.prependTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder putAllTo(String name, Object value) {
      super.putAllTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder putTo(String name, String key, Object value) {
      super.putTo(name, key, value);
      return this;
   }

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

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

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

   @Override /* GENERATED - ContextBuilder */
   public BeanTraverseBuilder timeZone(TimeZone value) {
      super.timeZone(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder annotations(Annotation...values) {
      super.annotations(values);
      return this;
   }

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

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

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
      super.beanInterceptor(on, value);
      return this;
   }

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

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder beansDontRequireSomeProperties() {
      super.beansDontRequireSomeProperties();
      return this;
   }

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

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

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpi(Map<String,Object> values) {
      super.bpi(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpi(Class<?> beanClass, String properties) {
      super.bpi(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpi(String beanClassName, String properties) {
      super.bpi(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpro(Map<String,Object> values) {
      super.bpro(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpro(Class<?> beanClass, String properties) {
      super.bpro(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpro(String beanClassName, String properties) {
      super.bpro(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpwo(Map<String,Object> values) {
      super.bpwo(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpwo(Class<?> beanClass, String properties) {
      super.bpwo(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpwo(String beanClassName, String properties) {
      super.bpwo(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpx(Map<String,Object> values) {
      super.bpx(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpx(Class<?> beanClass, String properties) {
      super.bpx(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder bpx(String beanClassName, String properties) {
      super.bpx(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dictionary(Object...values) {
      super.dictionary(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
      super.dictionaryOn(on, values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dontIgnorePropertiesWithoutSetters() {
      super.dontIgnorePropertiesWithoutSetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dontIgnoreTransientFields() {
      super.dontIgnoreTransientFields();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dontIgnoreUnknownNullBeanProperties() {
      super.dontIgnoreUnknownNullBeanProperties();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder dontUseInterfaceProxies() {
      super.dontUseInterfaceProxies();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public <T> BeanTraverseBuilder example(Class<T> pojoClass, T o) {
      super.example(pojoClass, o);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public <T> BeanTraverseBuilder exampleJson(Class<T> pojoClass, String json) {
      super.exampleJson(pojoClass, json);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder fluentSetters() {
      super.fluentSetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder fluentSetters(Class<?> on) {
      super.fluentSetters(on);
      return this;
   }

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

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

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
      super.implClass(interfaceClass, implClass);
      return this;
   }

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder interfaceClass(Class<?> on, Class<?> value) {
      super.interfaceClass(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder interfaces(java.lang.Class<?>...value) {
      super.interfaces(value);
      return this;
   }

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

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
      super.propertyNamer(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
      super.propertyNamer(on, value);
      return this;
   }

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

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder sortProperties(java.lang.Class<?>...on) {
      super.sortProperties(on);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder stopClass(Class<?> on, Class<?> value) {
      super.stopClass(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder swaps(Object...values) {
      super.swaps(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder typeName(Class<?> on, String value) {
      super.typeName(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder typePropertyName(String value) {
      super.typePropertyName(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public BeanTraverseBuilder typePropertyName(Class<?> on, String value) {
      super.typePropertyName(on, value);
      return this;
   }

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

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

   // </FluentSetters>

   @Override /* Context */
   public BeanTraverseContext build() {
      return null;
   }
}