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