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