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