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