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