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.jso;
014
015import java.lang.reflect.*;
016import java.util.*;
017
018import org.apache.juneau.*;
019import org.apache.juneau.http.*;
020import org.apache.juneau.reflect.*;
021import org.apache.juneau.serializer.*;
022import org.apache.juneau.svl.*;
023
024/**
025 * Builder class for building instances of Java Serialized Object serializers.
026 */
027public class JsoSerializerBuilder extends OutputStreamSerializerBuilder {
028
029   /**
030    * Constructor, default settings.
031    */
032   public JsoSerializerBuilder() {
033      super();
034   }
035
036   /**
037    * Constructor.
038    *
039    * @param ps The initial configuration settings for this builder.
040    */
041   public JsoSerializerBuilder(PropertyStore ps) {
042      super(ps);
043   }
044
045   @Override /* ContextBuilder */
046   public JsoSerializer build() {
047      return build(JsoSerializer.class);
048   }
049
050   //-----------------------------------------------------------------------------------------------------------------
051   // Properties
052   //-----------------------------------------------------------------------------------------------------------------
053
054   @Override /* OutputStreamSerializerBuilder */
055   public JsoSerializerBuilder binaryFormat(BinaryFormat value) {
056      super.binaryFormat(value);
057      return this;
058   }
059
060   @Override /* SerializerBuilder */
061   public JsoSerializerBuilder addBeanTypes(boolean value) {
062      super.addBeanTypes(value);
063      return this;
064   }
065
066   @Override /* SerializerBuilder */
067   public JsoSerializerBuilder addBeanTypes() {
068      super.addBeanTypes();
069      return this;
070   }
071
072   @Override /* SerializerBuilder */
073   public JsoSerializerBuilder addRootType(boolean value) {
074      super.addRootType(value);
075      return this;
076   }
077
078   @Override /* SerializerBuilder */
079   public JsoSerializerBuilder addRootType() {
080      super.addRootType();
081      return this;
082   }
083
084   @Override /* SerializerBuilder */
085   public JsoSerializerBuilder detectRecursions(boolean value) {
086      super.detectRecursions(value);
087      return this;
088   }
089
090   @Override /* SerializerBuilder */
091   public JsoSerializerBuilder detectRecursions() {
092      super.detectRecursions();
093      return this;
094   }
095
096   @Override /* SerializerBuilder */
097   public JsoSerializerBuilder ignoreRecursions(boolean value) {
098      super.ignoreRecursions(value);
099      return this;
100   }
101
102   @Override /* SerializerBuilder */
103   public JsoSerializerBuilder ignoreRecursions() {
104      super.ignoreRecursions();
105      return this;
106   }
107   @Override /* SerializerBuilder */
108   public JsoSerializerBuilder initialDepth(int value) {
109      super.initialDepth(value);
110      return this;
111   }
112
113   @Override /* SerializerBuilder */
114   public JsoSerializerBuilder listener(Class<? extends SerializerListener> value) {
115      super.listener(value);
116      return this;
117   }
118
119   @Override /* SerializerBuilder */
120   public JsoSerializerBuilder maxDepth(int value) {
121      super.maxDepth(value);
122      return this;
123   }
124
125   @Override /* SerializerBuilder */
126   public JsoSerializerBuilder sortCollections(boolean value) {
127      super.sortCollections(value);
128      return this;
129   }
130
131   @Override /* SerializerBuilder */
132   public JsoSerializerBuilder sortCollections() {
133      super.sortCollections();
134      return this;
135   }
136
137   @Override /* SerializerBuilder */
138   public JsoSerializerBuilder sortMaps(boolean value) {
139      super.sortMaps(value);
140      return this;
141   }
142
143   @Override /* SerializerBuilder */
144   public JsoSerializerBuilder sortMaps() {
145      super.sortMaps();
146      return this;
147   }
148
149   @Override /* SerializerBuilder */
150   public JsoSerializerBuilder trimEmptyCollections(boolean value) {
151      super.trimEmptyCollections(value);
152      return this;
153   }
154
155   @Override /* SerializerBuilder */
156   public JsoSerializerBuilder trimEmptyCollections() {
157      super.trimEmptyCollections();
158      return this;
159   }
160
161   @Override /* SerializerBuilder */
162   public JsoSerializerBuilder trimEmptyMaps(boolean value) {
163      super.trimEmptyMaps(value);
164      return this;
165   }
166
167   @Override /* SerializerBuilder */
168   public JsoSerializerBuilder trimEmptyMaps() {
169      super.trimEmptyMaps();
170      return this;
171   }
172
173   @Override /* SerializerBuilder */
174   public JsoSerializerBuilder trimNullProperties(boolean value) {
175      super.trimNullProperties(value);
176      return this;
177   }
178
179   @Override /* SerializerBuilder */
180   public JsoSerializerBuilder trimStrings(boolean value) {
181      super.trimStrings(value);
182      return this;
183   }
184
185   @Override /* SerializerBuilder */
186   public JsoSerializerBuilder trimStrings() {
187      super.trimStrings();
188      return this;
189   }
190
191   @Override /* SerializerBuilder */
192   public JsoSerializerBuilder uriContext(UriContext value) {
193      super.uriContext(value);
194      return this;
195   }
196
197   @Override /* SerializerBuilder */
198   public JsoSerializerBuilder uriRelativity(UriRelativity value) {
199      super.uriRelativity(value);
200      return this;
201   }
202
203   @Override /* SerializerBuilder */
204   public JsoSerializerBuilder uriResolution(UriResolution value) {
205      super.uriResolution(value);
206      return this;
207   }
208
209   @Override /* BeanContextBuilder */
210   public JsoSerializerBuilder beanClassVisibility(Visibility value) {
211      super.beanClassVisibility(value);
212      return this;
213   }
214
215   @Override /* BeanContextBuilder */
216   public JsoSerializerBuilder beanConstructorVisibility(Visibility value) {
217      super.beanConstructorVisibility(value);
218      return this;
219   }
220
221   @Override /* BeanContextBuilder */
222   public JsoSerializerBuilder beanDictionary(Class<?>...values) {
223      super.beanDictionary(values);
224      return this;
225   }
226
227   @Override /* BeanContextBuilder */
228   public JsoSerializerBuilder beanDictionary(Object...values) {
229      super.beanDictionary(values);
230      return this;
231   }
232
233   @Override /* BeanContextBuilder */
234   public JsoSerializerBuilder beanDictionaryReplace(Class<?>...values) {
235      super.beanDictionaryReplace(values);
236      return this;
237   }
238
239   @Override /* BeanContextBuilder */
240   public JsoSerializerBuilder beanDictionaryReplace(Object...values) {
241      super.beanDictionaryReplace(values);
242      return this;
243   }
244
245   @Override /* BeanContextBuilder */
246   public JsoSerializerBuilder beanDictionaryRemove(Class<?>...values) {
247      super.beanDictionaryRemove(values);
248      return this;
249   }
250
251   @Override /* BeanContextBuilder */
252   public JsoSerializerBuilder beanDictionaryRemove(Object...values) {
253      super.beanDictionaryRemove(values);
254      return this;
255   }
256
257   @Override /* BeanContextBuilder */
258   public JsoSerializerBuilder beanFieldVisibility(Visibility value) {
259      super.beanFieldVisibility(value);
260      return this;
261   }
262
263   @Override /* BeanContextBuilder */
264   public JsoSerializerBuilder beanFilters(Class<?>...values) {
265      super.beanFilters(values);
266      return this;
267   }
268
269   @Override /* BeanContextBuilder */
270   public JsoSerializerBuilder beanFilters(Object...values) {
271      super.beanFilters(values);
272      return this;
273   }
274
275   @Override /* BeanContextBuilder */
276   public JsoSerializerBuilder beanFiltersReplace(Class<?>...values) {
277      super.beanFiltersReplace(values);
278      return this;
279   }
280
281   @Override /* BeanContextBuilder */
282   public JsoSerializerBuilder beanFiltersReplace(Object...values) {
283      super.beanFiltersReplace(values);
284      return this;
285   }
286
287   @Override /* BeanContextBuilder */
288   public JsoSerializerBuilder beanFiltersRemove(Class<?>...values) {
289      super.beanFiltersRemove(values);
290      return this;
291   }
292
293   @Override /* BeanContextBuilder */
294   public JsoSerializerBuilder beanFiltersRemove(Object...values) {
295      super.beanFiltersRemove(values);
296      return this;
297   }
298
299   @Override /* BeanContextBuilder */
300   public JsoSerializerBuilder beanMapPutReturnsOldValue(boolean value) {
301      super.beanMapPutReturnsOldValue(value);
302      return this;
303   }
304
305   @Override /* BeanContextBuilder */
306   public JsoSerializerBuilder beanMapPutReturnsOldValue() {
307      super.beanMapPutReturnsOldValue();
308      return this;
309   }
310
311   @Override /* BeanContextBuilder */
312   public JsoSerializerBuilder beanMethodVisibility(Visibility value) {
313      super.beanMethodVisibility(value);
314      return this;
315   }
316
317   @Override /* BeanContextBuilder */
318   public JsoSerializerBuilder beansRequireDefaultConstructor(boolean value) {
319      super.beansRequireDefaultConstructor(value);
320      return this;
321   }
322
323   @Override /* BeanContextBuilder */
324   public JsoSerializerBuilder beansRequireDefaultConstructor() {
325      super.beansRequireDefaultConstructor();
326      return this;
327   }
328
329   @Override /* BeanContextBuilder */
330   public JsoSerializerBuilder beansRequireSerializable(boolean value) {
331      super.beansRequireSerializable(value);
332      return this;
333   }
334
335   @Override /* BeanContextBuilder */
336   public JsoSerializerBuilder beansRequireSerializable() {
337      super.beansRequireSerializable();
338      return this;
339   }
340
341   @Override /* BeanContextBuilder */
342   public JsoSerializerBuilder beansRequireSettersForGetters(boolean value) {
343      super.beansRequireSettersForGetters(value);
344      return this;
345   }
346
347   @Override /* BeanContextBuilder */
348   public JsoSerializerBuilder beansRequireSettersForGetters() {
349      super.beansRequireSettersForGetters();
350      return this;
351   }
352
353   @Override /* BeanContextBuilder */
354   public JsoSerializerBuilder beansRequireSomeProperties(boolean value) {
355      super.beansRequireSomeProperties(value);
356      return this;
357   }
358
359   @Override /* BeanContextBuilder */
360   public JsoSerializerBuilder beanTypePropertyName(String value) {
361      super.beanTypePropertyName(value);
362      return this;
363   }
364
365   @Override /* BeanContextBuilder */
366   public JsoSerializerBuilder debug() {
367      super.debug();
368      return this;
369   }
370
371   @Override /* BeanContextBuilder */
372   public <T> JsoSerializerBuilder example(Class<T> c, T o) {
373      super.example(c, o);
374      return this;
375   }
376
377   @Override /* BeanContextBuilder */
378   public <T> JsoSerializerBuilder exampleJson(Class<T> c, String value) {
379      super.exampleJson(c, value);
380      return this;
381   }
382
383   @Override /* BeanContextBuilder */
384   public JsoSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
385      super.ignoreInvocationExceptionsOnGetters(value);
386      return this;
387   }
388
389   @Override /* BeanContextBuilder */
390   public JsoSerializerBuilder ignoreInvocationExceptionsOnGetters() {
391      super.ignoreInvocationExceptionsOnGetters();
392      return this;
393   }
394
395   @Override /* BeanContextBuilder */
396   public JsoSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
397      super.ignoreInvocationExceptionsOnSetters(value);
398      return this;
399   }
400
401   @Override /* BeanContextBuilder */
402   public JsoSerializerBuilder ignoreInvocationExceptionsOnSetters() {
403      super.ignoreInvocationExceptionsOnSetters();
404      return this;
405   }
406
407   @Override /* BeanContextBuilder */
408   public JsoSerializerBuilder ignorePropertiesWithoutSetters(boolean value) {
409      super.ignorePropertiesWithoutSetters(value);
410      return this;
411   }
412
413   @Override /* BeanContextBuilder */
414   public JsoSerializerBuilder ignoreUnknownBeanProperties(boolean value) {
415      super.ignoreUnknownBeanProperties(value);
416      return this;
417   }
418
419   @Override /* BeanContextBuilder */
420   public JsoSerializerBuilder ignoreUnknownBeanProperties() {
421      super.ignoreUnknownBeanProperties();
422      return this;
423   }
424
425   @Override /* BeanContextBuilder */
426   public JsoSerializerBuilder ignoreUnknownNullBeanProperties(boolean value) {
427      super.ignoreUnknownNullBeanProperties(value);
428      return this;
429   }
430
431   @Override /* BeanContextBuilder */
432   public JsoSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
433      super.implClass(interfaceClass, implClass);
434      return this;
435   }
436
437   @Override /* BeanContextBuilder */
438   public JsoSerializerBuilder implClasses(Map<String,Class<?>> values) {
439      super.implClasses(values);
440      return this;
441   }
442
443   @Override /* BeanContextBuilder */
444   public JsoSerializerBuilder locale(Locale value) {
445      super.locale(value);
446      return this;
447   }
448
449   @Override /* BeanContextBuilder */
450   public JsoSerializerBuilder mediaType(MediaType value) {
451      super.mediaType(value);
452      return this;
453   }
454
455   @Override /* BeanContextBuilder */
456   public JsoSerializerBuilder notBeanClasses(Class<?>...values) {
457      super.notBeanClasses(values);
458      return this;
459   }
460
461   @Override /* BeanContextBuilder */
462   public JsoSerializerBuilder notBeanClasses(Object...values) {
463      super.notBeanClasses(values);
464      return this;
465   }
466
467   @Override /* BeanContextBuilder */
468   public JsoSerializerBuilder notBeanClassesReplace(Class<?>...values) {
469      super.notBeanClassesReplace(values);
470      return this;
471   }
472
473   @Override /* BeanContextBuilder */
474   public JsoSerializerBuilder notBeanClassesReplace(Object...values) {
475      super.notBeanClassesReplace(values);
476      return this;
477   }
478
479   @Override /* BeanContextBuilder */
480   public JsoSerializerBuilder notBeanClassesRemove(Class<?>...values) {
481      super.notBeanClassesRemove(values);
482      return this;
483   }
484
485   @Override /* BeanContextBuilder */
486   public JsoSerializerBuilder notBeanClassesRemove(Object...values) {
487      super.notBeanClassesRemove(values);
488      return this;
489   }
490
491   @Override /* BeanContextBuilder */
492   public JsoSerializerBuilder notBeanPackages(Object...values) {
493      super.notBeanPackages(values);
494      return this;
495   }
496
497   @Override /* BeanContextBuilder */
498   public JsoSerializerBuilder notBeanPackages(String...values) {
499      super.notBeanPackages(values);
500      return this;
501   }
502
503   @Override /* BeanContextBuilder */
504   public JsoSerializerBuilder notBeanPackagesReplace(String...values) {
505      super.notBeanPackagesReplace(values);
506      return this;
507   }
508
509   @Override /* BeanContextBuilder */
510   public JsoSerializerBuilder notBeanPackagesReplace(Object...values) {
511      super.notBeanPackagesReplace(values);
512      return this;
513   }
514
515   @Override /* BeanContextBuilder */
516   public JsoSerializerBuilder notBeanPackagesRemove(String...values) {
517      super.notBeanPackagesRemove(values);
518      return this;
519   }
520
521   @Override /* BeanContextBuilder */
522   public JsoSerializerBuilder notBeanPackagesRemove(Object...values) {
523      super.notBeanPackagesRemove(values);
524      return this;
525   }
526
527   @Override /* BeanContextBuilder */
528   public JsoSerializerBuilder pojoSwaps(Class<?>...values) {
529      super.pojoSwaps(values);
530      return this;
531   }
532
533   @Override /* BeanContextBuilder */
534   public JsoSerializerBuilder pojoSwaps(Object...values) {
535      super.pojoSwaps(values);
536      return this;
537   }
538
539   @Override /* BeanContextBuilder */
540   public JsoSerializerBuilder pojoSwapsReplace(Class<?>...values) {
541      super.pojoSwapsReplace(values);
542      return this;
543   }
544
545   @Override /* BeanContextBuilder */
546   public JsoSerializerBuilder pojoSwapsReplace(Object...values) {
547      super.pojoSwapsReplace(values);
548      return this;
549   }
550
551   @Override /* BeanContextBuilder */
552   public JsoSerializerBuilder pojoSwapsRemove(Class<?>...values) {
553      super.pojoSwapsRemove(values);
554      return this;
555   }
556
557   @Override /* BeanContextBuilder */
558   public JsoSerializerBuilder pojoSwapsRemove(Object...values) {
559      super.pojoSwapsRemove(values);
560      return this;
561   }
562
563   @Override /* BeanContextBuilder */
564   public JsoSerializerBuilder sortProperties(boolean value) {
565      super.sortProperties(value);
566      return this;
567   }
568
569   @Override /* BeanContextBuilder */
570   public JsoSerializerBuilder sortProperties() {
571      super.sortProperties();
572      return this;
573   }
574
575   @Override /* BeanContextBuilder */
576   public JsoSerializerBuilder timeZone(TimeZone value) {
577      super.timeZone(value);
578      return this;
579   }
580
581   @Override /* BeanContextBuilder */
582   public JsoSerializerBuilder useEnumNames(boolean value) {
583      super.useEnumNames(value);
584      return this;
585   }
586
587   @Override /* BeanContextBuilder */
588   public JsoSerializerBuilder useEnumNames() {
589      super.useEnumNames();
590      return this;
591   }
592
593   @Override /* BeanContextBuilder */
594   public JsoSerializerBuilder useInterfaceProxies(boolean value) {
595      super.useInterfaceProxies(value);
596      return this;
597   }
598
599   @Override /* BeanContextBuilder */
600   public JsoSerializerBuilder useJavaBeanIntrospector(boolean value) {
601      super.useJavaBeanIntrospector(value);
602      return this;
603   }
604
605   @Override /* BeanContextBuilder */
606   public JsoSerializerBuilder useJavaBeanIntrospector() {
607      super.useJavaBeanIntrospector();
608      return this;
609   }
610
611   @Override /* ContextBuilder */
612   public JsoSerializerBuilder set(String name, Object value) {
613      super.set(name, value);
614      return this;
615   }
616
617   @Override /* ContextBuilder */
618   public JsoSerializerBuilder set(Map<String,Object> properties) {
619      super.set(properties);
620      return this;
621   }
622
623   @Override /* ContextBuilder */
624   public JsoSerializerBuilder add(Map<String,Object> properties) {
625      super.add(properties);
626      return this;
627   }
628
629   @Override /* ContextBuilder */
630   public JsoSerializerBuilder addTo(String name, Object value) {
631      super.addTo(name, value);
632      return this;
633   }
634
635   @Override /* ContextBuilder */
636   public JsoSerializerBuilder addTo(String name, String key, Object value) {
637      super.addTo(name, key, value);
638      return this;
639   }
640
641   @Override /* ContextBuilder */
642   public JsoSerializerBuilder removeFrom(String name, Object value) {
643      super.removeFrom(name, value);
644      return this;
645   }
646
647   @Override /* ContextBuilder */
648   public JsoSerializerBuilder apply(PropertyStore copyFrom) {
649      super.apply(copyFrom);
650      return this;
651   }
652
653   @Override /* ContextBuilder */
654   public JsoSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs) {
655      super.applyAnnotations(al, vrs);
656      return this;
657   }
658
659   @Override /* ContextBuilder */
660   public JsoSerializerBuilder applyAnnotations(Class<?> fromClass) {
661      super.applyAnnotations(fromClass);
662      return this;
663   }
664
665   @Override /* ContextBuilder */
666   public JsoSerializerBuilder applyAnnotations(Method fromMethod) {
667      super.applyAnnotations(fromMethod);
668      return this;
669   }
670}