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