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