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