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