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