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