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