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