Source code

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