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