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.xml;
014
015import static org.apache.juneau.xml.XmlParser.*;
016
017import java.util.*;
018
019import javax.xml.stream.*;
020import javax.xml.stream.util.*;
021
022import org.apache.juneau.*;
023import org.apache.juneau.http.*;
024import org.apache.juneau.parser.*;
025
026/**
027 * Builder class for building XML parsers.
028 */
029public class XmlParserBuilder extends ParserBuilder {
030
031   /**
032    * Constructor, default settings.
033    */
034   public XmlParserBuilder() {
035      super();
036   }
037
038   /**
039    * Constructor.
040    * 
041    * @param ps The initial configuration settings for this builder.
042    */
043   public XmlParserBuilder(PropertyStore ps) {
044      super(ps);
045   }
046
047   @Override /* ContextBuilder */
048   public XmlParser build() {
049      return build(XmlParser.class);
050   }
051
052
053   //--------------------------------------------------------------------------------
054   // Properties
055   //--------------------------------------------------------------------------------
056
057   /**
058    * Configuration property:  XML event allocator.
059    * 
060    * <p>
061    * Associates an {@link XMLEventAllocator} with this parser.
062    * 
063    * <h5 class='section'>See Also:</h5>
064    * <ul>
065    *    <li class='jf'>{@link XmlParser#XML_eventAllocator}
066    * </ul>
067    * 
068    * @param value The new value for this property.
069    * @return This object (for method chaining).
070    */
071   public XmlParserBuilder eventAllocator(XMLEventAllocator value) {
072      return set(XML_eventAllocator, value);
073   }
074
075   /**
076    * Configuration property:  Preserve root element during generalized parsing.
077    * 
078    * <p>
079    * If <jk>true</jk>, when parsing into a generic {@link ObjectMap}, the map will contain a single entry whose key is
080    * the root element name.
081    * 
082    * <h5 class='section'>See Also:</h5>
083    * <ul>
084    *    <li class='jf'>{@link XmlParser#XML_preserveRootElement}
085    * </ul>
086    * 
087    * @param value 
088    *    The new value for this property.
089    *    <br>The default is <jk>false</jk>.
090    * @return This object (for method chaining).
091    */
092   public XmlParserBuilder preserveRootElement(boolean value) {
093      return set(XML_preserveRootElement, value);
094   }
095
096   /**
097    * Configuration property:  Preserve root element during generalized parsing.
098    * 
099    * <p>
100    * Shortcut for calling <code>preserveRootElement(<jk>true</jk>)</code>.
101    * 
102    * <h5 class='section'>See Also:</h5>
103    * <ul>
104    *    <li class='jf'>{@link XmlParser#XML_preserveRootElement}
105    * </ul>
106    * 
107    * @return This object (for method chaining).
108    */
109   public XmlParserBuilder preserveRootElement() {
110      return set(XML_preserveRootElement, true);
111   }
112
113   /**
114    * Configuration property:  XML reporter.
115    * 
116    * <p>
117    * Associates an {@link XMLReporter} with this parser.
118    * 
119    * <h5 class='section'>See Also:</h5>
120    * <ul>
121    *    <li class='jf'>{@link XmlParser#XML_reporter}
122    * </ul>
123    * 
124    * @param value The new value for this property.
125    * @return This object (for method chaining).
126    */
127   public XmlParserBuilder reporter(XMLReporter value) {
128      return set(XML_reporter, value);
129   }
130
131   /**
132    * Configuration property:  XML resolver.
133    * 
134    * <p>
135    * Associates an {@link XMLResolver} with this parser.
136    * 
137    * <h5 class='section'>See Also:</h5>
138    * <ul>
139    *    <li class='jf'>{@link XmlParser#XML_resolver}
140    * </ul>
141    * 
142    * @param value The new value for this property.
143    * @return This object (for method chaining).
144    */
145   public XmlParserBuilder resolver(XMLResolver value) {
146      return set(XML_resolver, value);
147   }
148
149   /**
150    * Configuration property:  Enable validation.
151    * 
152    * <p>
153    * If <jk>true</jk>, XML document will be validated.
154    * 
155    * <h5 class='section'>See Also:</h5>
156    * <ul>
157    *    <li class='jf'>{@link XmlParser#XML_validating}
158    * </ul>
159    * 
160    * @param value 
161    *    The new value for this property.
162    *    <br>The default is <jk>false</jk>.
163    * @return This object (for method chaining).
164    */
165   public XmlParserBuilder validating(boolean value) {
166      return set(XML_validating, value);
167   }
168
169   /**
170    * Configuration property:  Enable validation.
171    * 
172    * <p>
173    * Shortcut for calling <code>validating(<jk>true</jk>)</code>.
174    * 
175    * <h5 class='section'>See Also:</h5>
176    * <ul>
177    *    <li class='jf'>{@link XmlParser#XML_validating}
178    * </ul>
179    * 
180    * @return This object (for method chaining).
181    */
182   public XmlParserBuilder validating() {
183      return set(XML_validating, true);
184   }
185
186   @Override /* ParserBuilder */
187   public XmlParserBuilder autoCloseStreams(boolean value) {
188      super.autoCloseStreams(value);
189      return this;
190   }
191
192   @Override /* ParserBuilder */
193   public XmlParserBuilder autoCloseStreams() {
194      super.autoCloseStreams();
195      return this;
196   }
197
198   @Override /* ParserBuilder */
199   public XmlParserBuilder fileCharset(String value) {
200      super.fileCharset(value);
201      return this;
202   }
203
204   @Override /* ParserBuilder */
205   public XmlParserBuilder inputStreamCharset(String value) {
206      super.inputStreamCharset(value);
207      return this;
208   }
209
210   @Override /* ParserBuilder */
211   public XmlParserBuilder listener(Class<? extends ParserListener> value) {
212      super.listener(value);
213      return this;
214   }
215
216   @Override /* ParserBuilder */
217   public XmlParserBuilder strict(boolean value) {
218      super.strict(value);
219      return this;
220   }
221
222   @Override /* ParserBuilder */
223   public XmlParserBuilder strict() {
224      super.strict();
225      return this;
226   }
227
228   @Override /* ParserBuilder */
229   public XmlParserBuilder trimStrings(boolean value) {
230      super.trimStrings(value);
231      return this;
232   }
233
234   @Override /* ParserBuilder */
235   public XmlParserBuilder trimStrings() {
236      super.trimStrings();
237      return this;
238   }
239
240   @Override /* ParserBuilder */
241   public XmlParserBuilder unbuffered(boolean value) {
242      super.unbuffered(value);
243      return this;
244   }
245
246   @Override /* ParserBuilder */
247   public XmlParserBuilder unbuffered() {
248      super.unbuffered();
249      return this;
250   }
251
252   @Override /* BeanContextBuilder */
253   public XmlParserBuilder beansRequireDefaultConstructor(boolean value) {
254      super.beansRequireDefaultConstructor(value);
255      return this;
256   }
257
258   @Override /* BeanContextBuilder */
259   public XmlParserBuilder beansRequireDefaultConstructor() {
260      super.beansRequireDefaultConstructor();
261      return this;
262   }
263
264   @Override /* BeanContextBuilder */
265   public XmlParserBuilder beansRequireSerializable(boolean value) {
266      super.beansRequireSerializable(value);
267      return this;
268   }
269
270   @Override /* BeanContextBuilder */
271   public XmlParserBuilder beansRequireSerializable() {
272      super.beansRequireSerializable();
273      return this;
274   }
275
276   @Override /* BeanContextBuilder */
277   public XmlParserBuilder beansRequireSettersForGetters(boolean value) {
278      super.beansRequireSettersForGetters(value);
279      return this;
280   }
281
282   @Override /* BeanContextBuilder */
283   public XmlParserBuilder beansRequireSettersForGetters() {
284      super.beansRequireSettersForGetters();
285      return this;
286   }
287
288   @Override /* BeanContextBuilder */
289   public XmlParserBuilder beansRequireSomeProperties(boolean value) {
290      super.beansRequireSomeProperties(value);
291      return this;
292   }
293
294   @Override /* BeanContextBuilder */
295   public XmlParserBuilder beanMapPutReturnsOldValue(boolean value) {
296      super.beanMapPutReturnsOldValue(value);
297      return this;
298   }
299
300   @Override /* BeanContextBuilder */
301   public XmlParserBuilder beanMapPutReturnsOldValue() {
302      super.beanMapPutReturnsOldValue();
303      return this;
304   }
305
306   @Override /* BeanContextBuilder */
307   public XmlParserBuilder beanConstructorVisibility(Visibility value) {
308      super.beanConstructorVisibility(value);
309      return this;
310   }
311
312   @Override /* BeanContextBuilder */
313   public XmlParserBuilder beanClassVisibility(Visibility value) {
314      super.beanClassVisibility(value);
315      return this;
316   }
317
318   @Override /* BeanContextBuilder */
319   public XmlParserBuilder beanFieldVisibility(Visibility value) {
320      super.beanFieldVisibility(value);
321      return this;
322   }
323
324   @Override /* BeanContextBuilder */
325   public XmlParserBuilder beanMethodVisibility(Visibility value) {
326      super.beanMethodVisibility(value);
327      return this;
328   }
329
330   @Override /* BeanContextBuilder */
331   public XmlParserBuilder useJavaBeanIntrospector(boolean value) {
332      super.useJavaBeanIntrospector(value);
333      return this;
334   }
335
336   @Override /* BeanContextBuilder */
337   public XmlParserBuilder useJavaBeanIntrospector() {
338      super.useJavaBeanIntrospector();
339      return this;
340   }
341
342   @Override /* BeanContextBuilder */
343   public XmlParserBuilder useInterfaceProxies(boolean value) {
344      super.useInterfaceProxies(value);
345      return this;
346   }
347
348   @Override /* BeanContextBuilder */
349   public XmlParserBuilder ignoreUnknownBeanProperties(boolean value) {
350      super.ignoreUnknownBeanProperties(value);
351      return this;
352   }
353
354   @Override /* BeanContextBuilder */
355   public XmlParserBuilder ignoreUnknownBeanProperties() {
356      super.ignoreUnknownBeanProperties();
357      return this;
358   }
359
360   @Override /* BeanContextBuilder */
361   public XmlParserBuilder ignoreUnknownNullBeanProperties(boolean value) {
362      super.ignoreUnknownNullBeanProperties(value);
363      return this;
364   }
365
366   @Override /* BeanContextBuilder */
367   public XmlParserBuilder ignorePropertiesWithoutSetters(boolean value) {
368      super.ignorePropertiesWithoutSetters(value);
369      return this;
370   }
371
372   @Override /* BeanContextBuilder */
373   public XmlParserBuilder ignoreInvocationExceptionsOnGetters(boolean value) {
374      super.ignoreInvocationExceptionsOnGetters(value);
375      return this;
376   }
377
378   @Override /* BeanContextBuilder */
379   public XmlParserBuilder ignoreInvocationExceptionsOnGetters() {
380      super.ignoreInvocationExceptionsOnGetters();
381      return this;
382   }
383
384   @Override /* BeanContextBuilder */
385   public XmlParserBuilder ignoreInvocationExceptionsOnSetters(boolean value) {
386      super.ignoreInvocationExceptionsOnSetters(value);
387      return this;
388   }
389
390   @Override /* BeanContextBuilder */
391   public XmlParserBuilder ignoreInvocationExceptionsOnSetters() {
392      super.ignoreInvocationExceptionsOnSetters();
393      return this;
394   }
395
396   @Override /* BeanContextBuilder */
397   public XmlParserBuilder sortProperties(boolean value) {
398      super.sortProperties(value);
399      return this;
400   }
401
402   @Override /* BeanContextBuilder */
403   public XmlParserBuilder sortProperties() {
404      super.sortProperties();
405      return this;
406   }
407
408   @Override /* BeanContextBuilder */
409   public XmlParserBuilder notBeanPackages(Object...values) {
410      super.notBeanPackages(values);
411      return this;
412   }
413
414   @Override /* BeanContextBuilder */
415   public XmlParserBuilder notBeanPackages(String...values) {
416      super.notBeanPackages(values);
417      return this;
418   }
419
420   @Override /* BeanContextBuilder */
421   public XmlParserBuilder notBeanPackages(boolean append, Object...values) {
422      super.notBeanPackages(append, values);
423      return this;
424   }
425
426   @Override /* BeanContextBuilder */
427   public XmlParserBuilder notBeanPackagesRemove(Object...values) {
428      super.notBeanPackagesRemove(values);
429      return this;
430   }
431
432   @Override /* BeanContextBuilder */
433   public XmlParserBuilder notBeanClasses(Object...values) {
434      super.notBeanClasses(values);
435      return this;
436   }
437
438   @Override /* BeanContextBuilder */
439   public XmlParserBuilder notBeanClasses(Class<?>...values) {
440      super.notBeanClasses(values);
441      return this;
442   }
443
444   @Override /* BeanContextBuilder */
445   public XmlParserBuilder notBeanClasses(boolean append, Object...values) {
446      super.notBeanClasses(append, values);
447      return this;
448   }
449
450   @Override /* BeanContextBuilder */
451   public XmlParserBuilder notBeanClassesRemove(Object...values) {
452      super.notBeanClassesRemove(values);
453      return this;
454   }
455
456   @Override /* BeanContextBuilder */
457   public XmlParserBuilder beanFilters(Object...values) {
458      super.beanFilters(values);
459      return this;
460   }
461
462   @Override /* BeanContextBuilder */
463   public XmlParserBuilder beanFilters(Class<?>...values) {
464      super.beanFilters(values);
465      return this;
466   }
467
468   @Override /* BeanContextBuilder */
469   public XmlParserBuilder beanFilters(boolean append, Object...values) {
470      super.beanFilters(append, values);
471      return this;
472   }
473
474   @Override /* BeanContextBuilder */
475   public XmlParserBuilder beanFiltersRemove(Object...values) {
476      super.beanFiltersRemove(values);
477      return this;
478   }
479
480   @Override /* BeanContextBuilder */
481   public XmlParserBuilder pojoSwaps(Object...values) {
482      super.pojoSwaps(values);
483      return this;
484   }
485
486   @Override /* BeanContextBuilder */
487   public XmlParserBuilder pojoSwaps(Class<?>...values) {
488      super.pojoSwaps(values);
489      return this;
490   }
491
492   @Override /* BeanContextBuilder */
493   public XmlParserBuilder pojoSwaps(boolean append, Object...values) {
494      super.pojoSwaps(append, values);
495      return this;
496   }
497
498   @Override /* BeanContextBuilder */
499   public XmlParserBuilder pojoSwapsRemove(Object...values) {
500      super.pojoSwapsRemove(values);
501      return this;
502   }
503
504   @Override /* BeanContextBuilder */
505   public XmlParserBuilder implClasses(Map<String,Class<?>> values) {
506      super.implClasses(values);
507      return this;
508   }
509
510   @Override /* BeanContextBuilder */
511   public <T> XmlParserBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass) {
512      super.implClass(interfaceClass, implClass);
513      return this;
514   }
515
516   @Override /* BeanContextBuilder */
517   public XmlParserBuilder beanDictionary(Object...values) {
518      super.beanDictionary(values);
519      return this;
520   }
521
522   @Override /* BeanContextBuilder */
523   public XmlParserBuilder beanDictionary(Class<?>...values) {
524      super.beanDictionary(values);
525      return this;
526   }
527
528   @Override /* BeanContextBuilder */
529   public XmlParserBuilder beanDictionary(boolean append, Object...values) {
530      super.beanDictionary(append, values);
531      return this;
532   }
533
534   @Override /* BeanContextBuilder */
535   public XmlParserBuilder beanDictionaryRemove(Object...values) {
536      super.beanDictionaryRemove(values);
537      return this;
538   }
539
540   @Override /* BeanContextBuilder */
541   public XmlParserBuilder beanTypePropertyName(String value) {
542      super.beanTypePropertyName(value);
543      return this;
544   }
545
546   @Override /* BeanContextBuilder */
547   public XmlParserBuilder locale(Locale value) {
548      super.locale(value);
549      return this;
550   }
551
552   @Override /* BeanContextBuilder */
553   public XmlParserBuilder timeZone(TimeZone value) {
554      super.timeZone(value);
555      return this;
556   }
557
558   @Override /* BeanContextBuilder */
559   public XmlParserBuilder mediaType(MediaType value) {
560      super.mediaType(value);
561      return this;
562   }
563
564   @Override /* BeanContextBuilder */
565   public XmlParserBuilder debug() {
566      super.debug();
567      return this;
568   }
569
570   @Override /* ContextBuilder */
571   public XmlParserBuilder set(String name, Object value) {
572      super.set(name, value);
573      return this;
574   }
575
576   @Override /* ContextBuilder */
577   public XmlParserBuilder set(boolean append, String name, Object value) {
578      super.set(append, name, value);
579      return this;
580   }
581
582   @Override /* ContextBuilder */
583   public XmlParserBuilder set(Map<String,Object> properties) {
584      super.set(properties);
585      return this;
586   }
587
588   @Override /* ContextBuilder */
589   public XmlParserBuilder add(Map<String,Object> properties) {
590      super.add(properties);
591      return this;
592   }
593
594   @Override /* ContextBuilder */
595   public XmlParserBuilder addTo(String name, Object value) {
596      super.addTo(name, value);
597      return this;
598   }
599
600   @Override /* ContextBuilder */
601   public XmlParserBuilder addTo(String name, String key, Object value) {
602      super.addTo(name, key, value);
603      return this;
604   }
605
606   @Override /* ContextBuilder */
607   public XmlParserBuilder removeFrom(String name, Object value) {
608      super.removeFrom(name, value);
609      return this;
610   }
611
612   @Override /* ContextBuilder */
613   public XmlParserBuilder apply(PropertyStore copyFrom) {
614      super.apply(copyFrom);
615      return this;
616   }
617}