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.serializer;
014
015import static org.apache.juneau.serializer.WriterSerializer.*;
016
017import java.lang.annotation.*;
018import java.lang.reflect.*;
019import java.nio.charset.*;
020import java.util.*;
021
022import org.apache.juneau.*;
023import org.apache.juneau.http.*;
024import org.apache.juneau.reflect.*;
025import org.apache.juneau.svl.*;
026
027/**
028 * Base class for all writer-based serializer builders.
029 */
030public class WriterSerializerBuilder extends SerializerBuilder {
031
032   /**
033    * Constructor, default settings.
034    */
035   public WriterSerializerBuilder() {
036      super();
037   }
038
039   /**
040    * Constructor.
041    *
042    * @param ps The initial configuration settings for this builder.
043    */
044   public WriterSerializerBuilder(PropertyStore ps) {
045      super(ps);
046   }
047
048   //-----------------------------------------------------------------------------------------------------------------
049   // Properties
050   //-----------------------------------------------------------------------------------------------------------------
051
052   /**
053    * Configuration property: File charset.
054    *
055    * <p>
056    * The character set to use for writing Files to the file system.
057    *
058    * <p>
059    * Used when passing in files to {@link Serializer#serialize(Object, Object)}.
060    *
061    * <ul class='seealso'>
062    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_fileCharset}
063    * </ul>
064    *
065    * @param value
066    *    The new value for this property.
067    *    <br>The default is the system JVM setting.
068    * @return This object (for method chaining).
069    */
070   public WriterSerializerBuilder fileCharset(Charset value) {
071      return set(WSERIALIZER_fileCharset, value);
072   }
073
074   /**
075    * Configuration property:  Maximum indentation.
076    *
077    * <p>
078    * Specifies the maximum indentation level in the serialized document.
079    *
080    * <ul class='seealso'>
081    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_maxIndent}
082    * </ul>
083    *
084    * @param value
085    *    The new value for this property.
086    *    <br>The default is <c>100</c>.
087    * @return This object (for method chaining).
088    */
089   public WriterSerializerBuilder maxIndent(int value) {
090      return set(WSERIALIZER_maxIndent, value);
091   }
092
093   /**
094    * Configuration property:  Quote character.
095    *
096    * <p>
097    * This is the character used for quoting attributes and values.
098    *
099    * <ul class='seealso'>
100    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_quoteChar}
101    * </ul>
102    *
103    * @param value
104    *    The new value for this property.
105    *    <br>The default is <js>'"'</js>.
106    * @return This object (for method chaining).
107    */
108   public WriterSerializerBuilder quoteChar(char value) {
109      return set(WSERIALIZER_quoteChar, value);
110   }
111
112   /**
113    * Configuration property:  Quote character.
114    *
115    * <p>
116    * Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>.
117    *
118    * <ul class='seealso'>
119    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_quoteChar}
120    * </ul>
121    *
122    * @return This object (for method chaining).
123    */
124   public WriterSerializerBuilder sq() {
125      return quoteChar('\'');
126   }
127
128   /**
129    * Configuration property: Output stream charset.
130    *
131    * <p>
132    * The character set to use when writing to OutputStreams.
133    *
134    * <p>
135    * Used when passing in output streams and byte arrays to {@link WriterSerializer#serialize(Object, Object)}.
136    *
137    * <ul class='seealso'>
138    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_streamCharset}
139    * </ul>
140    *
141    * @param value
142    *    The new value for this property.
143    *    <br>The default is the system JVM setting.
144    * @return This object (for method chaining).
145    */
146   public WriterSerializerBuilder streamCharset(Charset value) {
147      return set(WSERIALIZER_streamCharset, value);
148   }
149
150   /**
151    * Configuration property:  Use whitespace.
152    *
153    * <p>
154    * If <jk>true</jk>, newlines and indentation and spaces are added to the output to improve readability.
155    *
156    * <ul class='seealso'>
157    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_useWhitespace}
158    * </ul>
159    *
160    * @param value
161    *    The new value for this property.
162    *    <br>The default is <jk>false</jk>.
163    * @return This object (for method chaining).
164    */
165   public WriterSerializerBuilder useWhitespace(boolean value) {
166      return set(WSERIALIZER_useWhitespace, value);
167   }
168
169   /**
170    * Configuration property:  Use whitespace.
171    *
172    * <p>
173    * Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
174    *
175    * <ul class='seealso'>
176    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_useWhitespace}
177    * </ul>
178    * @return This object (for method chaining).
179    */
180   public WriterSerializerBuilder useWhitespace() {
181      return set(WSERIALIZER_useWhitespace, true);
182   }
183
184   /**
185    * Configuration property:  Use whitespace.
186    *
187    * <p>
188    * Shortcut for calling <code>useWhitespace(<jk>true</jk>)</code>.
189    *
190    * <ul class='seealso'>
191    *    <li class='jf'>{@link WriterSerializer#WSERIALIZER_useWhitespace}
192    * </ul>
193    *
194    * @return This object (for method chaining).
195    */
196   public SerializerBuilder ws() {
197      return useWhitespace();
198   }
199
200   @Override /* BeanContextBuilder */
201   public WriterSerializerBuilder annotations(Annotation...values) {
202      super.annotations(values);
203      return this;
204   }
205
206   @Override /* BeanContextBuilder */
207   public WriterSerializerBuilder beanClassVisibility(Visibility value) {
208      super.beanClassVisibility(value);
209      return this;
210   }
211
212   @Override /* BeanContextBuilder */
213   public WriterSerializerBuilder beanConstructorVisibility(Visibility value) {
214      super.beanConstructorVisibility(value);
215      return this;
216   }
217
218   @Override /* BeanContextBuilder */
219   @Deprecated
220   public WriterSerializerBuilder beanDictionary(Class<?>...values) {
221      super.beanDictionary(values);
222      return this;
223   }
224
225   @Override /* BeanContextBuilder */
226   @Deprecated
227   public WriterSerializerBuilder beanDictionary(Object...values) {
228      super.beanDictionary(values);
229      return this;
230   }
231
232   @Override /* BeanContextBuilder */
233   @Deprecated
234   public WriterSerializerBuilder beanDictionaryReplace(Class<?>...values) {
235      super.beanDictionaryReplace(values);
236      return this;
237   }
238
239   @Override /* BeanContextBuilder */
240   @Deprecated
241   public WriterSerializerBuilder beanDictionaryReplace(Object...values) {
242      super.beanDictionaryReplace(values);
243      return this;
244   }
245
246   @Override /* BeanContextBuilder */
247   @Deprecated
248   public WriterSerializerBuilder beanDictionaryRemove(Class<?>...values) {
249      super.beanDictionaryRemove(values);
250      return this;
251   }
252
253   @Override /* BeanContextBuilder */
254   @Deprecated
255   public WriterSerializerBuilder beanDictionaryRemove(Object...values) {
256      super.beanDictionaryRemove(values);
257      return this;
258   }
259
260   @Override /* BeanContextBuilder */
261   public WriterSerializerBuilder beanFieldVisibility(Visibility value) {
262      super.beanFieldVisibility(value);
263      return this;
264   }
265
266   @Override /* BeanContextBuilder */
267   public WriterSerializerBuilder beanFilters(Class<?>...values) {
268      super.beanFilters(values);
269      return this;
270   }
271
272   @Override /* BeanContextBuilder */
273   public WriterSerializerBuilder beanFilters(Object...values) {
274      super.beanFilters(values);
275      return this;
276   }
277
278   @Override /* BeanContextBuilder */
279   public WriterSerializerBuilder beanFiltersReplace(Class<?>...values) {
280      super.beanFiltersReplace(values);
281      return this;
282   }
283
284   @Override /* BeanContextBuilder */
285   public WriterSerializerBuilder beanFiltersReplace(Object...values) {
286      super.beanFiltersReplace(values);
287      return this;
288   }
289
290   @Override /* BeanContextBuilder */
291   public WriterSerializerBuilder beanFiltersRemove(Class<?>...values) {
292      super.beanFiltersRemove(values);
293      return this;
294   }
295
296   @Override /* BeanContextBuilder */
297   public WriterSerializerBuilder beanFiltersRemove(Object...values) {
298      super.beanFiltersRemove(values);
299      return this;
300   }
301
302   @Override /* BeanContextBuilder */
303   public WriterSerializerBuilder beanMapPutReturnsOldValue(boolean value) {
304      super.beanMapPutReturnsOldValue(value);
305      return this;
306   }
307
308   @Override /* BeanContextBuilder */
309   public WriterSerializerBuilder beanMapPutReturnsOldValue() {
310      super.beanMapPutReturnsOldValue();
311      return this;
312   }
313
314   @Override /* BeanContextBuilder */
315   public WriterSerializerBuilder beanMethodVisibility(Visibility value) {
316      super.beanMethodVisibility(value);
317      return this;
318   }
319
320   @Override /* BeanContextBuilder */
321   public WriterSerializerBuilder beansRequireDefaultConstructor(boolean value) {
322      super.beansRequireDefaultConstructor(value);
323      return this;
324   }
325
326   @Override /* BeanContextBuilder */
327   public WriterSerializerBuilder beansRequireDefaultConstructor() {
328      super.beansRequireDefaultConstructor();
329      return this;
330   }
331
332   @Override /* BeanContextBuilder */
333   public WriterSerializerBuilder beansRequireSerializable(boolean value) {
334      super.beansRequireSerializable(value);
335      return this;
336   }
337
338   @Override /* BeanContextBuilder */
339   public WriterSerializerBuilder beansRequireSerializable() {
340      super.beansRequireSerializable();
341      return this;
342   }
343
344   @Override /* BeanContextBuilder */
345   public WriterSerializerBuilder beansRequireSettersForGetters(boolean value) {
346      super.beansRequireSettersForGetters(value);
347      return this;
348   }
349
350   @Override /* BeanContextBuilder */
351   public WriterSerializerBuilder beansRequireSettersForGetters() {
352      super.beansRequireSettersForGetters();
353      return this;
354   }
355
356   @Override /* BeanContextBuilder */
357   public WriterSerializerBuilder beansRequireSomeProperties(boolean value) {
358      super.beansRequireSomeProperties(value);
359      return this;
360   }
361
362   @Override /* BeanContextBuilder */
363   public WriterSerializerBuilder beanTypePropertyName(String value) {
364      super.beanTypePropertyName(value);
365      return this;
366   }
367
368   @Override /* BeanContextBuilder */
369   public WriterSerializerBuilder bpi(Class<?> beanClass, String value) {
370      super.bpi(beanClass, value);
371      return this;
372   }
373
374   @Override /* BeanContextBuilder */
375   public WriterSerializerBuilder bpi(Map<String,String> values) {
376      super.bpi(values);
377      return this;
378   }
379
380   @Override /* BeanContextBuilder */
381   public WriterSerializerBuilder bpi(String beanClassName, String value) {
382      super.bpi(beanClassName, value);
383      return this;
384   }
385
386   @Override /* BeanContextBuilder */
387   public WriterSerializerBuilder bpx(Class<?> beanClass, String properties) {
388      super.bpx(beanClass, properties);
389      return this;
390   }
391
392   @Override /* BeanContextBuilder */
393   public WriterSerializerBuilder bpx(Map<String,String> values) {
394      super.bpx(values);
395      return this;
396   }
397
398   @Override /* BeanContextBuilder */
399   public WriterSerializerBuilder bpx(String beanClassName, String value) {
400      super.bpx(beanClassName, value);
401      return this;
402   }
403
404   @Override /* BeanContextBuilder */
405   public WriterSerializerBuilder bpro(Class<?> beanClass, String value) {
406      super.bpro(beanClass, value);
407      return this;
408   }
409
410   @Override /* BeanContextBuilder */
411   public WriterSerializerBuilder bpro(Map<String,String> values) {
412      super.bpro(values);
413      return this;
414   }
415
416   @Override /* BeanContextBuilder */
417   public WriterSerializerBuilder bpro(String beanClassName, String value) {
418      super.bpro(beanClassName, value);
419      return this;
420   }
421
422   @Override /* BeanContextBuilder */
423   public WriterSerializerBuilder bpwo(Class<?> beanClass, String properties) {
424      super.bpwo(beanClass, properties);
425      return this;
426   }
427
428   @Override /* BeanContextBuilder */
429   public WriterSerializerBuilder bpwo(Map<String,String> values) {
430      super.bpwo(values);
431      return this;
432   }
433
434   @Override /* BeanContextBuilder */
435   public WriterSerializerBuilder bpwo(String beanClassName, String value) {
436      super.bpwo(beanClassName, value);
437      return this;
438   }
439
440   @Override /* BeanContextBuilder */
441   public WriterSerializerBuilder debug() {
442      super.debug();
443      return this;
444   }
445
446   @Override /* BeanContextBuilder */
447   public WriterSerializerBuilder dictionary(Class<?>...values) {
448      super.dictionary(values);
449      return this;
450   }
451
452   @Override /* BeanContextBuilder */
453   public WriterSerializerBuilder dictionary(Object...values) {
454      super.dictionary(values);
455      return this;
456   }
457
458   @Override /* BeanContextBuilder */
459   public WriterSerializerBuilder dictionaryReplace(Class<?>...values) {
460      super.dictionaryReplace(values);
461      return this;
462   }
463
464   @Override /* BeanContextBuilder */
465   public WriterSerializerBuilder dictionaryReplace(Object...values) {
466      super.dictionaryReplace(values);
467      return this;
468   }
469
470   @Override /* BeanContextBuilder */
471   public WriterSerializerBuilder dictionaryRemove(Class<?>...values) {
472      super.dictionaryRemove(values);
473      return this;
474   }
475
476   @Override /* BeanContextBuilder */
477   public WriterSerializerBuilder dictionaryRemove(Object...values) {
478      super.dictionaryRemove(values);
479      return this;
480   }
481
482   @Override /* BeanContextBuilder */
483   public <T> WriterSerializerBuilder example(Class<T> c, T o) {
484      super.example(c, o);
485      return this;
486   }
487
488   @Override /* BeanContextBuilder */
489   public <T> WriterSerializerBuilder exampleJson(Class<T> c, String value) {
490      super.exampleJson(c, value);
491      return this;
492   }
493
494   @Override /* BeanContextBuilder */
495   public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
496      super.ignoreInvocationExceptionsOnGetters(value);
497      return this;
498   }
499
500   @Override /* BeanContextBuilder */
501   public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters() {
502      super.ignoreInvocationExceptionsOnGetters();
503      return this;
504   }
505
506   @Override /* BeanContextBuilder */
507   public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
508      super.ignoreInvocationExceptionsOnSetters(value);
509      return this;
510   }
511
512   @Override /* BeanContextBuilder */
513   public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters() {
514      super.ignoreInvocationExceptionsOnSetters();
515      return this;
516   }
517
518   @Override /* BeanContextBuilder */
519   public WriterSerializerBuilder ignorePropertiesWithoutSetters(boolean value) {
520      super.ignorePropertiesWithoutSetters(value);
521      return this;
522   }
523
524   @Override /* BeanContextBuilder */
525   public WriterSerializerBuilder ignoreUnknownBeanProperties(boolean value) {
526      super.ignoreUnknownBeanProperties(value);
527      return this;
528   }
529
530   @Override /* BeanContextBuilder */
531   public WriterSerializerBuilder ignoreUnknownBeanProperties() {
532      super.ignoreUnknownBeanProperties();
533      return this;
534   }
535
536   @Override /* BeanContextBuilder */
537   public WriterSerializerBuilder ignoreUnknownNullBeanProperties(boolean value) {
538      super.ignoreUnknownNullBeanProperties(value);
539      return this;
540   }
541
542   @Override /* BeanContextBuilder */
543   public WriterSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
544      super.implClass(interfaceClass, implClass);
545      return this;
546   }
547
548   @Override /* BeanContextBuilder */
549   public WriterSerializerBuilder implClasses(Map<String,Class<?>> values) {
550      super.implClasses(values);
551      return this;
552   }
553
554   @Override /* BeanContextBuilder */
555   public WriterSerializerBuilder locale(Locale value) {
556      super.locale(value);
557      return this;
558   }
559
560   @Override /* BeanContextBuilder */
561   public WriterSerializerBuilder mediaType(MediaType value) {
562      super.mediaType(value);
563      return this;
564   }
565
566   @Override /* BeanContextBuilder */
567   public WriterSerializerBuilder notBeanClasses(Class<?>...values) {
568      super.notBeanClasses(values);
569      return this;
570   }
571
572   @Override /* BeanContextBuilder */
573   public WriterSerializerBuilder notBeanClasses(Object...values) {
574      super.notBeanClasses(values);
575      return this;
576   }
577
578   @Override /* BeanContextBuilder */
579   public WriterSerializerBuilder notBeanClassesReplace(Class<?>...values) {
580      super.notBeanClassesReplace(values);
581      return this;
582   }
583
584   @Override /* BeanContextBuilder */
585   public WriterSerializerBuilder notBeanClassesReplace(Object...values) {
586      super.notBeanClassesReplace(values);
587      return this;
588   }
589
590   @Override /* BeanContextBuilder */
591   public WriterSerializerBuilder notBeanClassesRemove(Class<?>...values) {
592      super.notBeanClassesRemove(values);
593      return this;
594   }
595
596   @Override /* BeanContextBuilder */
597   public WriterSerializerBuilder notBeanClassesRemove(Object...values) {
598      super.notBeanClassesRemove(values);
599      return this;
600   }
601
602   @Override /* BeanContextBuilder */
603   public WriterSerializerBuilder notBeanPackages(Object...values) {
604      super.notBeanPackages(values);
605      return this;
606   }
607
608   @Override /* BeanContextBuilder */
609   public WriterSerializerBuilder notBeanPackages(String...values) {
610      super.notBeanPackages(values);
611      return this;
612   }
613
614   @Override /* BeanContextBuilder */
615   public WriterSerializerBuilder notBeanPackagesReplace(String...values) {
616      super.notBeanPackagesReplace(values);
617      return this;
618   }
619
620   @Override /* BeanContextBuilder */
621   public WriterSerializerBuilder notBeanPackagesReplace(Object...values) {
622      super.notBeanPackagesReplace(values);
623      return this;
624   }
625
626   @Override /* BeanContextBuilder */
627   public WriterSerializerBuilder notBeanPackagesRemove(String...values) {
628      super.notBeanPackagesRemove(values);
629      return this;
630   }
631
632   @Override /* BeanContextBuilder */
633   public WriterSerializerBuilder notBeanPackagesRemove(Object...values) {
634      super.notBeanPackagesRemove(values);
635      return this;
636   }
637
638   @Override /* BeanContextBuilder */
639   public WriterSerializerBuilder pojoSwaps(Class<?>...values) {
640      super.pojoSwaps(values);
641      return this;
642   }
643
644   @Override /* BeanContextBuilder */
645   public WriterSerializerBuilder pojoSwaps(Object...values) {
646      super.pojoSwaps(values);
647      return this;
648   }
649
650   @Override /* BeanContextBuilder */
651   public WriterSerializerBuilder pojoSwapsReplace(Class<?>...values) {
652      super.pojoSwapsReplace(values);
653      return this;
654   }
655
656   @Override /* BeanContextBuilder */
657   public WriterSerializerBuilder pojoSwapsReplace(Object...values) {
658      super.pojoSwapsReplace(values);
659      return this;
660   }
661
662   @Override /* BeanContextBuilder */
663   public WriterSerializerBuilder pojoSwapsRemove(Class<?>...values) {
664      super.pojoSwapsRemove(values);
665      return this;
666   }
667
668   @Override /* BeanContextBuilder */
669   public WriterSerializerBuilder pojoSwapsRemove(Object...values) {
670      super.pojoSwapsRemove(values);
671      return this;
672   }
673
674   @Override /* BeanContextBuilder */
675   public WriterSerializerBuilder sortProperties(boolean value) {
676      super.sortProperties(value);
677      return this;
678   }
679
680   @Override /* BeanContextBuilder */
681   public WriterSerializerBuilder sortProperties() {
682      super.sortProperties();
683      return this;
684   }
685
686   @Override /* BeanContextBuilder */
687   public WriterSerializerBuilder timeZone(TimeZone value) {
688      super.timeZone(value);
689      return this;
690   }
691
692   @Override /* BeanContextBuilder */
693   public WriterSerializerBuilder useEnumNames(boolean value) {
694      super.useEnumNames(value);
695      return this;
696   }
697
698   @Override /* BeanContextBuilder */
699   public WriterSerializerBuilder useEnumNames() {
700      super.useEnumNames();
701      return this;
702   }
703
704   @Override /* BeanContextBuilder */
705   public WriterSerializerBuilder useInterfaceProxies(boolean value) {
706      super.useInterfaceProxies(value);
707      return this;
708   }
709
710   @Override /* BeanContextBuilder */
711   public WriterSerializerBuilder useJavaBeanIntrospector(boolean value) {
712      super.useJavaBeanIntrospector(value);
713      return this;
714   }
715
716   @Override /* BeanContextBuilder */
717   public WriterSerializerBuilder useJavaBeanIntrospector() {
718      super.useJavaBeanIntrospector();
719      return this;
720   }
721
722   @Override /* ContextBuilder */
723   public WriterSerializerBuilder set(String name, Object value) {
724      super.set(name, value);
725      return this;
726   }
727
728   @Override /* ContextBuilder */
729   public WriterSerializerBuilder set(Map<String,Object> properties) {
730      super.set(properties);
731      return this;
732   }
733
734   @Override /* ContextBuilder */
735   public WriterSerializerBuilder add(Map<String,Object> properties) {
736      super.add(properties);
737      return this;
738   }
739
740   @Override /* ContextBuilder */
741   public WriterSerializerBuilder addTo(String name, Object value) {
742      super.addTo(name, value);
743      return this;
744   }
745
746   @Override /* ContextBuilder */
747   public WriterSerializerBuilder addTo(String name, String key, Object value) {
748      super.addTo(name, key, value);
749      return this;
750   }
751
752   @Override /* ContextBuilder */
753   public WriterSerializerBuilder removeFrom(String name, Object value) {
754      super.removeFrom(name, value);
755      return this;
756   }
757
758   @Override /* ContextBuilder */
759   public WriterSerializerBuilder apply(PropertyStore copyFrom) {
760      super.apply(copyFrom);
761      return this;
762   }
763
764   @Override /* ContextBuilder */
765   public WriterSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs) {
766      super.applyAnnotations(al, vrs);
767      return this;
768   }
769
770   @Override /* ContextBuilder */
771   public WriterSerializerBuilder applyAnnotations(Class<?>...fromClasses) {
772      super.applyAnnotations(fromClasses);
773      return this;
774   }
775
776   @Override /* ContextBuilder */
777   public WriterSerializerBuilder applyAnnotations(Method...fromMethods) {
778      super.applyAnnotations(fromMethods);
779      return this;
780   }
781
782   @Override /* Context */
783   public WriterSerializer build() {
784      return null;
785   }
786}