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