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.internal.*;
024import org.apache.juneau.reflect.*;
025import org.apache.juneau.svl.*;
026
027/**
028 * Base builder class for building instances of stream-based parsers.
029 */
030public class InputStreamParserBuilder extends ParserBuilder {
031
032   /**
033    * Constructor, default settings.
034    */
035   public InputStreamParserBuilder() {
036      super();
037   }
038
039   /**
040    * Constructor.
041    *
042    * @param ps The initial configuration settings for this builder.
043    */
044   public InputStreamParserBuilder(PropertyStore ps) {
045      super(ps);
046   }
047
048   //-----------------------------------------------------------------------------------------------------------------
049   // Properties
050   //-----------------------------------------------------------------------------------------------------------------
051
052   /**
053    * <i><l>InputStreamParser</l> configuration property:&emsp;</i>  Binary input format.
054    *
055    * <p>
056    * When using the {@link InputStreamParser#parse(Object,Class)} method on stream-based parsers and the input is a string, this defines the format to use
057    * when converting the string into a byte array.
058    *
059    * <h5 class='section'>Example:</h5>
060    * <p class='bcode w800'>
061    *    <jc>// Create a parser that parses from BASE64.</jc>
062    *    InputStreamParser p = MsgPackParser
063    *       .<jsm>create</jsm>()
064    *       .binaryFormat(<jsf>BASE64</jsf>)
065    *       .build();
066    *
067    *    String input = <js>"base64-encoded-string"</js>;
068    *
069    *    MyBean myBean = p.parse(input, MyBean.<jk>class</jk>);
070    * </p>
071    *
072    * <ul class='seealso'>
073    *    <li class='jf'>{@link InputStreamParser#ISPARSER_binaryFormat}
074    * </ul>
075    *
076    * @param value
077    *    The new value for this property.
078    *    <br>The default value is {@link BinaryFormat#HEX}.
079    * @return This object (for method chaining).
080    */
081   @FluentSetter
082   public InputStreamParserBuilder binaryFormat(BinaryFormat value) {
083      return set(ISPARSER_binaryFormat, value);
084   }
085
086   /**
087    * <i><l>InputStreamParser</l> configuration property:&emsp;</i>  Binary input format.
088    *
089    * <div class='warn'>
090    *    <b>Deprecated</b> - Use {@link #binaryFormat(BinaryFormat)}
091    * </div>
092    */
093   @SuppressWarnings("javadoc")
094   @Deprecated
095   @FluentSetter
096   public InputStreamParserBuilder binaryFormat(String value) {
097      return set(ISPARSER_binaryFormat, BinaryFormat.valueOf(value));
098   }
099
100   // <FluentSetters>
101
102   @Override /* GENERATED - ContextBuilder */
103   public InputStreamParserBuilder add(Map<String,Object> properties) {
104      super.add(properties);
105      return this;
106   }
107
108   @Override /* GENERATED - ContextBuilder */
109   public InputStreamParserBuilder addTo(String name, Object value) {
110      super.addTo(name, value);
111      return this;
112   }
113
114   @Override /* GENERATED - ContextBuilder */
115   public InputStreamParserBuilder appendTo(String name, Object value) {
116      super.appendTo(name, value);
117      return this;
118   }
119
120   @Override /* GENERATED - ContextBuilder */
121   public InputStreamParserBuilder apply(PropertyStore copyFrom) {
122      super.apply(copyFrom);
123      return this;
124   }
125
126   @Override /* GENERATED - ContextBuilder */
127   public InputStreamParserBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
128      super.applyAnnotations(fromClasses);
129      return this;
130   }
131
132   @Override /* GENERATED - ContextBuilder */
133   public InputStreamParserBuilder applyAnnotations(Method...fromMethods) {
134      super.applyAnnotations(fromMethods);
135      return this;
136   }
137
138   @Override /* GENERATED - ContextBuilder */
139   public InputStreamParserBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
140      super.applyAnnotations(al, r);
141      return this;
142   }
143
144   @Override /* GENERATED - ContextBuilder */
145   public InputStreamParserBuilder debug() {
146      super.debug();
147      return this;
148   }
149
150   @Override /* GENERATED - ContextBuilder */
151   public InputStreamParserBuilder locale(Locale value) {
152      super.locale(value);
153      return this;
154   }
155
156   @Override /* GENERATED - ContextBuilder */
157   public InputStreamParserBuilder mediaType(MediaType value) {
158      super.mediaType(value);
159      return this;
160   }
161
162   @Override /* GENERATED - ContextBuilder */
163   public InputStreamParserBuilder prependTo(String name, Object value) {
164      super.prependTo(name, value);
165      return this;
166   }
167
168   @Override /* GENERATED - ContextBuilder */
169   public InputStreamParserBuilder putAllTo(String name, Object value) {
170      super.putAllTo(name, value);
171      return this;
172   }
173
174   @Override /* GENERATED - ContextBuilder */
175   public InputStreamParserBuilder putTo(String name, String key, Object value) {
176      super.putTo(name, key, value);
177      return this;
178   }
179
180   @Override /* GENERATED - ContextBuilder */
181   public InputStreamParserBuilder removeFrom(String name, Object value) {
182      super.removeFrom(name, value);
183      return this;
184   }
185
186   @Override /* GENERATED - ContextBuilder */
187   public InputStreamParserBuilder set(Map<String,Object> properties) {
188      super.set(properties);
189      return this;
190   }
191
192   @Override /* GENERATED - ContextBuilder */
193   public InputStreamParserBuilder set(String name, Object value) {
194      super.set(name, value);
195      return this;
196   }
197
198   @Override /* GENERATED - ContextBuilder */
199   public InputStreamParserBuilder timeZone(TimeZone value) {
200      super.timeZone(value);
201      return this;
202   }
203
204   @Override /* GENERATED - BeanContextBuilder */
205   public InputStreamParserBuilder annotations(Annotation...values) {
206      super.annotations(values);
207      return this;
208   }
209
210   @Override /* GENERATED - BeanContextBuilder */
211   public InputStreamParserBuilder beanClassVisibility(Visibility value) {
212      super.beanClassVisibility(value);
213      return this;
214   }
215
216   @Override /* GENERATED - BeanContextBuilder */
217   public InputStreamParserBuilder beanConstructorVisibility(Visibility value) {
218      super.beanConstructorVisibility(value);
219      return this;
220   }
221
222   @Override /* GENERATED - BeanContextBuilder */
223   public InputStreamParserBuilder beanFieldVisibility(Visibility value) {
224      super.beanFieldVisibility(value);
225      return this;
226   }
227
228   @Override /* GENERATED - BeanContextBuilder */
229   public InputStreamParserBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
230      super.beanInterceptor(on, value);
231      return this;
232   }
233
234   @Override /* GENERATED - BeanContextBuilder */
235   public InputStreamParserBuilder beanMapPutReturnsOldValue() {
236      super.beanMapPutReturnsOldValue();
237      return this;
238   }
239
240   @Override /* GENERATED - BeanContextBuilder */
241   public InputStreamParserBuilder beanMethodVisibility(Visibility value) {
242      super.beanMethodVisibility(value);
243      return this;
244   }
245
246   @Override /* GENERATED - BeanContextBuilder */
247   public InputStreamParserBuilder beansDontRequireSomeProperties() {
248      super.beansDontRequireSomeProperties();
249      return this;
250   }
251
252   @Override /* GENERATED - BeanContextBuilder */
253   public InputStreamParserBuilder beansRequireDefaultConstructor() {
254      super.beansRequireDefaultConstructor();
255      return this;
256   }
257
258   @Override /* GENERATED - BeanContextBuilder */
259   public InputStreamParserBuilder beansRequireSerializable() {
260      super.beansRequireSerializable();
261      return this;
262   }
263
264   @Override /* GENERATED - BeanContextBuilder */
265   public InputStreamParserBuilder beansRequireSettersForGetters() {
266      super.beansRequireSettersForGetters();
267      return this;
268   }
269
270   @Override /* GENERATED - BeanContextBuilder */
271   public InputStreamParserBuilder bpi(Map<String,Object> values) {
272      super.bpi(values);
273      return this;
274   }
275
276   @Override /* GENERATED - BeanContextBuilder */
277   public InputStreamParserBuilder bpi(Class<?> beanClass, String properties) {
278      super.bpi(beanClass, properties);
279      return this;
280   }
281
282   @Override /* GENERATED - BeanContextBuilder */
283   public InputStreamParserBuilder bpi(String beanClassName, String properties) {
284      super.bpi(beanClassName, properties);
285      return this;
286   }
287
288   @Override /* GENERATED - BeanContextBuilder */
289   public InputStreamParserBuilder bpro(Map<String,Object> values) {
290      super.bpro(values);
291      return this;
292   }
293
294   @Override /* GENERATED - BeanContextBuilder */
295   public InputStreamParserBuilder bpro(Class<?> beanClass, String properties) {
296      super.bpro(beanClass, properties);
297      return this;
298   }
299
300   @Override /* GENERATED - BeanContextBuilder */
301   public InputStreamParserBuilder bpro(String beanClassName, String properties) {
302      super.bpro(beanClassName, properties);
303      return this;
304   }
305
306   @Override /* GENERATED - BeanContextBuilder */
307   public InputStreamParserBuilder bpwo(Map<String,Object> values) {
308      super.bpwo(values);
309      return this;
310   }
311
312   @Override /* GENERATED - BeanContextBuilder */
313   public InputStreamParserBuilder bpwo(Class<?> beanClass, String properties) {
314      super.bpwo(beanClass, properties);
315      return this;
316   }
317
318   @Override /* GENERATED - BeanContextBuilder */
319   public InputStreamParserBuilder bpwo(String beanClassName, String properties) {
320      super.bpwo(beanClassName, properties);
321      return this;
322   }
323
324   @Override /* GENERATED - BeanContextBuilder */
325   public InputStreamParserBuilder bpx(Map<String,Object> values) {
326      super.bpx(values);
327      return this;
328   }
329
330   @Override /* GENERATED - BeanContextBuilder */
331   public InputStreamParserBuilder bpx(Class<?> beanClass, String properties) {
332      super.bpx(beanClass, properties);
333      return this;
334   }
335
336   @Override /* GENERATED - BeanContextBuilder */
337   public InputStreamParserBuilder bpx(String beanClassName, String properties) {
338      super.bpx(beanClassName, properties);
339      return this;
340   }
341
342   @Override /* GENERATED - BeanContextBuilder */
343   public InputStreamParserBuilder dictionary(Object...values) {
344      super.dictionary(values);
345      return this;
346   }
347
348   @Override /* GENERATED - BeanContextBuilder */
349   public InputStreamParserBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
350      super.dictionaryOn(on, values);
351      return this;
352   }
353
354   @Override /* GENERATED - BeanContextBuilder */
355   public InputStreamParserBuilder dontIgnorePropertiesWithoutSetters() {
356      super.dontIgnorePropertiesWithoutSetters();
357      return this;
358   }
359
360   @Override /* GENERATED - BeanContextBuilder */
361   public InputStreamParserBuilder dontIgnoreTransientFields() {
362      super.dontIgnoreTransientFields();
363      return this;
364   }
365
366   @Override /* GENERATED - BeanContextBuilder */
367   public InputStreamParserBuilder dontIgnoreUnknownNullBeanProperties() {
368      super.dontIgnoreUnknownNullBeanProperties();
369      return this;
370   }
371
372   @Override /* GENERATED - BeanContextBuilder */
373   public InputStreamParserBuilder dontUseInterfaceProxies() {
374      super.dontUseInterfaceProxies();
375      return this;
376   }
377
378   @Override /* GENERATED - BeanContextBuilder */
379   public <T> InputStreamParserBuilder example(Class<T> pojoClass, T o) {
380      super.example(pojoClass, o);
381      return this;
382   }
383
384   @Override /* GENERATED - BeanContextBuilder */
385   public <T> InputStreamParserBuilder exampleJson(Class<T> pojoClass, String json) {
386      super.exampleJson(pojoClass, json);
387      return this;
388   }
389
390   @Override /* GENERATED - BeanContextBuilder */
391   public InputStreamParserBuilder fluentSetters() {
392      super.fluentSetters();
393      return this;
394   }
395
396   @Override /* GENERATED - BeanContextBuilder */
397   public InputStreamParserBuilder fluentSetters(Class<?> on) {
398      super.fluentSetters(on);
399      return this;
400   }
401
402   @Override /* GENERATED - BeanContextBuilder */
403   public InputStreamParserBuilder ignoreInvocationExceptionsOnGetters() {
404      super.ignoreInvocationExceptionsOnGetters();
405      return this;
406   }
407
408   @Override /* GENERATED - BeanContextBuilder */
409   public InputStreamParserBuilder ignoreInvocationExceptionsOnSetters() {
410      super.ignoreInvocationExceptionsOnSetters();
411      return this;
412   }
413
414   @Override /* GENERATED - BeanContextBuilder */
415   public InputStreamParserBuilder ignoreUnknownBeanProperties() {
416      super.ignoreUnknownBeanProperties();
417      return this;
418   }
419
420   @Override /* GENERATED - BeanContextBuilder */
421   public InputStreamParserBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
422      super.implClass(interfaceClass, implClass);
423      return this;
424   }
425
426   @Override /* GENERATED - BeanContextBuilder */
427   public InputStreamParserBuilder implClasses(Map<Class<?>,Class<?>> values) {
428      super.implClasses(values);
429      return this;
430   }
431
432   @Override /* GENERATED - BeanContextBuilder */
433   public InputStreamParserBuilder interfaceClass(Class<?> on, Class<?> value) {
434      super.interfaceClass(on, value);
435      return this;
436   }
437
438   @Override /* GENERATED - BeanContextBuilder */
439   public InputStreamParserBuilder interfaces(java.lang.Class<?>...value) {
440      super.interfaces(value);
441      return this;
442   }
443
444   @Override /* GENERATED - BeanContextBuilder */
445   public InputStreamParserBuilder notBeanClasses(Object...values) {
446      super.notBeanClasses(values);
447      return this;
448   }
449
450   @Override /* GENERATED - BeanContextBuilder */
451   public InputStreamParserBuilder notBeanPackages(Object...values) {
452      super.notBeanPackages(values);
453      return this;
454   }
455
456   @Override /* GENERATED - BeanContextBuilder */
457   public InputStreamParserBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
458      super.propertyNamer(value);
459      return this;
460   }
461
462   @Override /* GENERATED - BeanContextBuilder */
463   public InputStreamParserBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
464      super.propertyNamer(on, value);
465      return this;
466   }
467
468   @Override /* GENERATED - BeanContextBuilder */
469   public InputStreamParserBuilder sortProperties() {
470      super.sortProperties();
471      return this;
472   }
473
474   @Override /* GENERATED - BeanContextBuilder */
475   public InputStreamParserBuilder sortProperties(java.lang.Class<?>...on) {
476      super.sortProperties(on);
477      return this;
478   }
479
480   @Override /* GENERATED - BeanContextBuilder */
481   public InputStreamParserBuilder stopClass(Class<?> on, Class<?> value) {
482      super.stopClass(on, value);
483      return this;
484   }
485
486   @Override /* GENERATED - BeanContextBuilder */
487   public InputStreamParserBuilder swaps(Object...values) {
488      super.swaps(values);
489      return this;
490   }
491
492   @Override /* GENERATED - BeanContextBuilder */
493   public InputStreamParserBuilder typeName(Class<?> on, String value) {
494      super.typeName(on, value);
495      return this;
496   }
497
498   @Override /* GENERATED - BeanContextBuilder */
499   public InputStreamParserBuilder typePropertyName(String value) {
500      super.typePropertyName(value);
501      return this;
502   }
503
504   @Override /* GENERATED - BeanContextBuilder */
505   public InputStreamParserBuilder typePropertyName(Class<?> on, String value) {
506      super.typePropertyName(on, value);
507      return this;
508   }
509
510   @Override /* GENERATED - BeanContextBuilder */
511   public InputStreamParserBuilder useEnumNames() {
512      super.useEnumNames();
513      return this;
514   }
515
516   @Override /* GENERATED - BeanContextBuilder */
517   public InputStreamParserBuilder useJavaBeanIntrospector() {
518      super.useJavaBeanIntrospector();
519      return this;
520   }
521
522   @Override /* GENERATED - ParserBuilder */
523   public InputStreamParserBuilder autoCloseStreams() {
524      super.autoCloseStreams();
525      return this;
526   }
527
528   @Override /* GENERATED - ParserBuilder */
529   public InputStreamParserBuilder debugOutputLines(int value) {
530      super.debugOutputLines(value);
531      return this;
532   }
533
534   @Override /* GENERATED - ParserBuilder */
535   public InputStreamParserBuilder listener(Class<? extends org.apache.juneau.parser.ParserListener> value) {
536      super.listener(value);
537      return this;
538   }
539
540   @Override /* GENERATED - ParserBuilder */
541   public InputStreamParserBuilder strict() {
542      super.strict();
543      return this;
544   }
545
546   @Override /* GENERATED - ParserBuilder */
547   public InputStreamParserBuilder trimStrings() {
548      super.trimStrings();
549      return this;
550   }
551
552   @Override /* GENERATED - ParserBuilder */
553   public InputStreamParserBuilder unbuffered() {
554      super.unbuffered();
555      return this;
556   }
557
558   // </FluentSetters>
559
560   @Override /* Context */
561   public InputStreamParser build() {
562      return null;
563   }
564}