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