001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau;
014
015import static org.apache.juneau.BeanTraverseContext.*;
016
017import java.lang.reflect.*;
018import java.util.*;
019
020import org.apache.juneau.http.*;
021import org.apache.juneau.reflect.*;
022import org.apache.juneau.svl.*;
023
024/**
025 * Builder class for building instances of bean traversals.
026 */
027public class BeanTraverseBuilder extends BeanContextBuilder {
028
029   /**
030    * Constructor, default settings.
031    */
032   public BeanTraverseBuilder() {
033      super();
034   }
035
036   /**
037    * Constructor.
038    *
039    * @param ps The initial configuration settings for this builder.
040    */
041   public BeanTraverseBuilder(PropertyStore ps) {
042      super(ps);
043   }
044
045   //-----------------------------------------------------------------------------------------------------------------
046   // Properties
047   //-----------------------------------------------------------------------------------------------------------------
048
049   /**
050    * Configuration property:  Automatically detect POJO recursions.
051    *
052    * <p>
053    * Specifies that recursions should be checked for during traversal.
054    *
055    * <ul class='notes'>
056    *    <li>
057    *       Checking for recursion can cause a small performance penalty.
058    * </ul>
059    *
060    * <ul class='seealso'>
061    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_detectRecursions}
062    * </ul>
063    *
064    * @param value
065    *    The new value for this property.
066    *    <br>The default is <jk>false</jk>.
067    * @return This object (for method chaining).
068    */
069   public BeanTraverseBuilder detectRecursions(boolean value) {
070      return set(BEANTRAVERSE_detectRecursions, value);
071   }
072
073   /**
074    * Configuration property:  Automatically detect POJO recursions.
075    *
076    * <p>
077    * Shortcut for calling <code>detectRecursions(<jk>true</jk>)</code>.
078    *
079    * <ul class='seealso'>
080    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_detectRecursions}
081    * </ul>
082    *
083    * @return This object (for method chaining).
084    */
085   public BeanTraverseBuilder detectRecursions() {
086      return set(BEANTRAVERSE_detectRecursions, true);
087   }
088
089   /**
090    * Configuration property:  Ignore recursion errors.
091    *
092    * <p>
093    * If <jk>true</jk>, when we encounter the same object when traversing a tree, we set the value to <jk>null</jk>.
094    * Otherwise, an exception is thrown.
095    *
096    * <ul class='notes'>
097    *    <li>
098    *       Checking for recursion can cause a small performance penalty.
099    * </ul>
100    *
101    * <ul class='seealso'>
102    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_ignoreRecursions}
103    * </ul>
104    *
105    * @param value
106    *    The new value for this property.
107    *    <br>The default is <jk>false</jk>.
108    * @return This object (for method chaining).
109    */
110   public BeanTraverseBuilder ignoreRecursions(boolean value) {
111      return set(BEANTRAVERSE_ignoreRecursions, value);
112   }
113
114   /**
115    * Configuration property:  Ignore recursion errors.
116    *
117    * <p>
118    * Shortcut for calling <code>ignoreRecursions(<jk>true</jk>)</code>.
119    *
120    * <ul class='seealso'>
121    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_ignoreRecursions}
122    * </ul>
123    *
124    * @return This object (for method chaining).
125    */
126   public BeanTraverseBuilder ignoreRecursions() {
127      return set(BEANTRAVERSE_ignoreRecursions, true);
128   }
129
130   /**
131    * Configuration property:  Initial depth.
132    *
133    * <p>
134    * The initial indentation level at the root.
135    *
136    * <ul class='seealso'>
137    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_initialDepth}
138    * </ul>
139    *
140    * @param value
141    *    The new value for this property.
142    *    <br>The default is <c>0</c>.
143    * @return This object (for method chaining).
144    */
145   public BeanTraverseBuilder initialDepth(int value) {
146      return set(BEANTRAVERSE_initialDepth, value);
147   }
148
149   /**
150    * Configuration property:  Max traversal depth.
151    *
152    * <p>
153    * Abort traversal if specified depth is reached in the POJO tree.
154    * <br>If this depth is exceeded, an exception is thrown.
155    * <br>This prevents stack overflows from occurring when trying to traverse models with recursive references.
156    *
157    * <ul class='seealso'>
158    *    <li class='jf'>{@link BeanTraverseContext#BEANTRAVERSE_maxDepth}
159    * </ul>
160    *
161    * @param value
162    *    The new value for this property.
163    *    <br>The default is <c>100</c>.
164    * @return This object (for method chaining).
165    */
166   public BeanTraverseBuilder maxDepth(int value) {
167      return set(BEANTRAVERSE_maxDepth, value);
168   }
169
170
171   @Override /* BeanContextBuilder */
172   public BeanTraverseBuilder beanClassVisibility(Visibility value) {
173      super.beanClassVisibility(value);
174      return this;
175   }
176
177   @Override /* BeanContextBuilder */
178   public BeanTraverseBuilder beanConstructorVisibility(Visibility value) {
179      super.beanConstructorVisibility(value);
180      return this;
181   }
182
183   @Override /* BeanContextBuilder */
184   public BeanTraverseBuilder beanDictionary(Class<?>...values) {
185      super.beanDictionary(values);
186      return this;
187   }
188
189   @Override /* BeanContextBuilder */
190   public BeanTraverseBuilder beanDictionary(Object...values) {
191      super.beanDictionary(values);
192      return this;
193   }
194
195   @Override /* BeanContextBuilder */
196   public BeanTraverseBuilder beanDictionaryReplace(Class<?>...values) {
197      super.beanDictionaryReplace(values);
198      return this;
199   }
200
201   @Override /* BeanContextBuilder */
202   public BeanTraverseBuilder beanDictionaryReplace(Object...values) {
203      super.beanDictionaryReplace(values);
204      return this;
205   }
206
207   @Override /* BeanContextBuilder */
208   public BeanTraverseBuilder beanDictionaryRemove(Class<?>...values) {
209      super.beanDictionaryRemove(values);
210      return this;
211   }
212
213   @Override /* BeanContextBuilder */
214   public BeanTraverseBuilder beanDictionaryRemove(Object...values) {
215      super.beanDictionaryRemove(values);
216      return this;
217   }
218
219   @Override /* BeanContextBuilder */
220   public BeanTraverseBuilder beanFieldVisibility(Visibility value) {
221      super.beanFieldVisibility(value);
222      return this;
223   }
224
225   @Override /* BeanContextBuilder */
226   public BeanTraverseBuilder beanFilters(Class<?>...values) {
227      super.beanFilters(values);
228      return this;
229   }
230
231   @Override /* BeanContextBuilder */
232   public BeanTraverseBuilder beanFilters(Object...values) {
233      super.beanFilters(values);
234      return this;
235   }
236
237   @Override /* BeanContextBuilder */
238   public BeanTraverseBuilder beanFiltersReplace(Class<?>...values) {
239      super.beanFiltersReplace(values);
240      return this;
241   }
242
243   @Override /* BeanContextBuilder */
244   public BeanTraverseBuilder beanFiltersReplace(Object...values) {
245      super.beanFiltersReplace(values);
246      return this;
247   }
248
249   @Override /* BeanContextBuilder */
250   public BeanTraverseBuilder beanFiltersRemove(Class<?>...values) {
251      super.beanFiltersRemove(values);
252      return this;
253   }
254
255   @Override /* BeanContextBuilder */
256   public BeanTraverseBuilder beanFiltersRemove(Object...values) {
257      super.beanFiltersRemove(values);
258      return this;
259   }
260
261   @Override /* BeanContextBuilder */
262   public BeanTraverseBuilder beanMapPutReturnsOldValue(boolean value) {
263      super.beanMapPutReturnsOldValue(value);
264      return this;
265   }
266
267   @Override /* BeanContextBuilder */
268   public BeanTraverseBuilder beanMapPutReturnsOldValue() {
269      super.beanMapPutReturnsOldValue();
270      return this;
271   }
272
273   @Override /* BeanContextBuilder */
274   public BeanTraverseBuilder beanMethodVisibility(Visibility value) {
275      super.beanMethodVisibility(value);
276      return this;
277   }
278
279   @Override /* BeanContextBuilder */
280   public BeanTraverseBuilder beansRequireDefaultConstructor(boolean value) {
281      super.beansRequireDefaultConstructor(value);
282      return this;
283   }
284
285   @Override /* BeanContextBuilder */
286   public BeanTraverseBuilder beansRequireDefaultConstructor() {
287      super.beansRequireDefaultConstructor();
288      return this;
289   }
290
291   @Override /* BeanContextBuilder */
292   public BeanTraverseBuilder beansRequireSerializable(boolean value) {
293      super.beansRequireSerializable(value);
294      return this;
295   }
296
297   @Override /* BeanContextBuilder */
298   public BeanTraverseBuilder beansRequireSerializable() {
299      super.beansRequireSerializable();
300      return this;
301   }
302
303   @Override /* BeanContextBuilder */
304   public BeanTraverseBuilder beansRequireSettersForGetters(boolean value) {
305      super.beansRequireSettersForGetters(value);
306      return this;
307   }
308
309   @Override /* BeanContextBuilder */
310   public BeanTraverseBuilder beansRequireSettersForGetters() {
311      super.beansRequireSettersForGetters();
312      return this;
313   }
314
315   @Override /* BeanContextBuilder */
316   public BeanTraverseBuilder beansRequireSomeProperties(boolean value) {
317      super.beansRequireSomeProperties(value);
318      return this;
319   }
320
321   @Override /* BeanContextBuilder */
322   public BeanTraverseBuilder beanTypePropertyName(String value) {
323      super.beanTypePropertyName(value);
324      return this;
325   }
326
327   @Override /* BeanContextBuilder */
328   public BeanTraverseBuilder debug() {
329      super.debug();
330      return this;
331   }
332
333   @Override /* BeanContextBuilder */
334   public <T> BeanTraverseBuilder example(Class<T> c, T o) {
335      super.example(c, o);
336      return this;
337   }
338
339   @Override /* BeanContextBuilder */
340   public <T> BeanTraverseBuilder exampleJson(Class<T> c, String value) {
341      super.exampleJson(c, value);
342      return this;
343   }
344
345   @Override /* BeanContextBuilder */
346   public BeanTraverseBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
347      super.ignoreInvocationExceptionsOnGetters(value);
348      return this;
349   }
350
351   @Override /* BeanContextBuilder */
352   public BeanTraverseBuilder ignoreInvocationExceptionsOnGetters() {
353      super.ignoreInvocationExceptionsOnGetters();
354      return this;
355   }
356
357   @Override /* BeanContextBuilder */
358   public BeanTraverseBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
359      super.ignoreInvocationExceptionsOnSetters(value);
360      return this;
361   }
362
363   @Override /* BeanContextBuilder */
364   public BeanTraverseBuilder ignoreInvocationExceptionsOnSetters() {
365      super.ignoreInvocationExceptionsOnSetters();
366      return this;
367   }
368
369   @Override /* BeanContextBuilder */
370   public BeanTraverseBuilder ignorePropertiesWithoutSetters(boolean value) {
371      super.ignorePropertiesWithoutSetters(value);
372      return this;
373   }
374
375   @Override /* BeanContextBuilder */
376   public BeanTraverseBuilder ignoreUnknownBeanProperties(boolean value) {
377      super.ignoreUnknownBeanProperties(value);
378      return this;
379   }
380
381   @Override /* BeanContextBuilder */
382   public BeanTraverseBuilder ignoreUnknownBeanProperties() {
383      super.ignoreUnknownBeanProperties();
384      return this;
385   }
386
387   @Override /* BeanContextBuilder */
388   public BeanTraverseBuilder ignoreUnknownNullBeanProperties(boolean value) {
389      super.ignoreUnknownNullBeanProperties(value);
390      return this;
391   }
392
393   @Override /* BeanContextBuilder */
394   public BeanTraverseBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
395      super.implClass(interfaceClass, implClass);
396      return this;
397   }
398
399   @Override /* BeanContextBuilder */
400   public BeanTraverseBuilder implClasses(Map<String,Class<?>> values) {
401      super.implClasses(values);
402      return this;
403   }
404
405   @Override /* BeanContextBuilder */
406   public BeanTraverseBuilder locale(Locale value) {
407      super.locale(value);
408      return this;
409   }
410
411   @Override /* BeanContextBuilder */
412   public BeanTraverseBuilder mediaType(MediaType value) {
413      super.mediaType(value);
414      return this;
415   }
416
417   @Override /* BeanContextBuilder */
418   public BeanTraverseBuilder notBeanClasses(Class<?>...values) {
419      super.notBeanClasses(values);
420      return this;
421   }
422
423   @Override /* BeanContextBuilder */
424   public BeanTraverseBuilder notBeanClasses(Object...values) {
425      super.notBeanClasses(values);
426      return this;
427   }
428
429   @Override /* BeanContextBuilder */
430   public BeanTraverseBuilder notBeanClassesReplace(Class<?>...values) {
431      super.notBeanClassesReplace(values);
432      return this;
433   }
434
435   @Override /* BeanContextBuilder */
436   public BeanTraverseBuilder notBeanClassesReplace(Object...values) {
437      super.notBeanClassesReplace(values);
438      return this;
439   }
440
441   @Override /* BeanContextBuilder */
442   public BeanTraverseBuilder notBeanClassesRemove(Class<?>...values) {
443      super.notBeanClassesRemove(values);
444      return this;
445   }
446
447   @Override /* BeanContextBuilder */
448   public BeanTraverseBuilder notBeanClassesRemove(Object...values) {
449      super.notBeanClassesRemove(values);
450      return this;
451   }
452
453   @Override /* BeanContextBuilder */
454   public BeanTraverseBuilder notBeanPackages(Object...values) {
455      super.notBeanPackages(values);
456      return this;
457   }
458
459   @Override /* BeanContextBuilder */
460   public BeanTraverseBuilder notBeanPackages(String...values) {
461      super.notBeanPackages(values);
462      return this;
463   }
464
465   @Override /* BeanContextBuilder */
466   public BeanTraverseBuilder notBeanPackagesReplace(String...values) {
467      super.notBeanPackagesReplace(values);
468      return this;
469   }
470
471   @Override /* BeanContextBuilder */
472   public BeanTraverseBuilder notBeanPackagesReplace(Object...values) {
473      super.notBeanPackagesReplace(values);
474      return this;
475   }
476
477   @Override /* BeanContextBuilder */
478   public BeanTraverseBuilder notBeanPackagesRemove(String...values) {
479      super.notBeanPackagesRemove(values);
480      return this;
481   }
482
483   @Override /* BeanContextBuilder */
484   public BeanTraverseBuilder notBeanPackagesRemove(Object...values) {
485      super.notBeanPackagesRemove(values);
486      return this;
487   }
488
489   @Override /* BeanContextBuilder */
490   public BeanTraverseBuilder pojoSwaps(Class<?>...values) {
491      super.pojoSwaps(values);
492      return this;
493   }
494
495   @Override /* BeanContextBuilder */
496   public BeanTraverseBuilder pojoSwaps(Object...values) {
497      super.pojoSwaps(values);
498      return this;
499   }
500
501   @Override /* BeanContextBuilder */
502   public BeanTraverseBuilder pojoSwapsReplace(Class<?>...values) {
503      super.pojoSwapsReplace(values);
504      return this;
505   }
506
507   @Override /* BeanContextBuilder */
508   public BeanTraverseBuilder pojoSwapsReplace(Object...values) {
509      super.pojoSwapsReplace(values);
510      return this;
511   }
512
513   @Override /* BeanContextBuilder */
514   public BeanTraverseBuilder pojoSwapsRemove(Class<?>...values) {
515      super.pojoSwapsRemove(values);
516      return this;
517   }
518
519   @Override /* BeanContextBuilder */
520   public BeanTraverseBuilder pojoSwapsRemove(Object...values) {
521      super.pojoSwapsRemove(values);
522      return this;
523   }
524
525   @Override /* BeanContextBuilder */
526   public BeanTraverseBuilder sortProperties(boolean value) {
527      super.sortProperties(value);
528      return this;
529   }
530
531   @Override /* BeanContextBuilder */
532   public BeanTraverseBuilder sortProperties() {
533      super.sortProperties();
534      return this;
535   }
536
537   @Override /* BeanContextBuilder */
538   public BeanTraverseBuilder timeZone(TimeZone value) {
539      super.timeZone(value);
540      return this;
541   }
542
543   @Override /* BeanContextBuilder */
544   public BeanTraverseBuilder useEnumNames(boolean value) {
545      super.useEnumNames(value);
546      return this;
547   }
548
549   @Override /* BeanContextBuilder */
550   public BeanTraverseBuilder useEnumNames() {
551      super.useEnumNames();
552      return this;
553   }
554
555   @Override /* BeanContextBuilder */
556   public BeanTraverseBuilder useInterfaceProxies(boolean value) {
557      super.useInterfaceProxies(value);
558      return this;
559   }
560
561   @Override /* BeanContextBuilder */
562   public BeanTraverseBuilder useJavaBeanIntrospector(boolean value) {
563      super.useJavaBeanIntrospector(value);
564      return this;
565   }
566
567   @Override /* BeanContextBuilder */
568   public BeanTraverseBuilder useJavaBeanIntrospector() {
569      super.useJavaBeanIntrospector();
570      return this;
571   }
572
573   @Override /* ContextBuilder */
574   public BeanTraverseBuilder set(String name, Object value) {
575      super.set(name, value);
576      return this;
577   }
578
579   @Override /* ContextBuilder */
580   public BeanTraverseBuilder set(Map<String,Object> properties) {
581      super.set(properties);
582      return this;
583   }
584
585   @Override /* ContextBuilder */
586   public BeanTraverseBuilder add(Map<String,Object> properties) {
587      super.add(properties);
588      return this;
589   }
590
591   @Override /* ContextBuilder */
592   public BeanTraverseBuilder addTo(String name, Object value) {
593      super.addTo(name, value);
594      return this;
595   }
596
597   @Override /* ContextBuilder */
598   public BeanTraverseBuilder addTo(String name, String key, Object value) {
599      super.addTo(name, key, value);
600      return this;
601   }
602
603   @Override /* ContextBuilder */
604   public BeanTraverseBuilder removeFrom(String name, Object value) {
605      super.removeFrom(name, value);
606      return this;
607   }
608
609   @Override /* ContextBuilder */
610   public BeanTraverseBuilder apply(PropertyStore copyFrom) {
611      super.apply(copyFrom);
612      return this;
613   }
614
615   @Override /* ContextBuilder */
616   public BeanTraverseBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs) {
617      super.applyAnnotations(al, vrs);
618      return this;
619   }
620
621   @Override /* ContextBuilder */
622   public BeanTraverseBuilder applyAnnotations(Class<?> fromClass) {
623      super.applyAnnotations(fromClass);
624      return this;
625   }
626
627   @Override /* ContextBuilder */
628   public BeanTraverseBuilder applyAnnotations(Method fromMethod) {
629      super.applyAnnotations(fromMethod);
630      return this;
631   }
632
633   @Override /* Context */
634   public BeanTraverseContext build() {
635      return null;
636   }
637}