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.util.*; 018 019import org.apache.juneau.*; 020import org.apache.juneau.http.*; 021 022/** 023 * Base class for all writer-based serializer builders. 024 */ 025public class WriterSerializerBuilder extends SerializerBuilder { 026 027 /** 028 * Constructor, default settings. 029 */ 030 public WriterSerializerBuilder() { 031 super(); 032 } 033 034 /** 035 * Constructor. 036 * 037 * @param ps The initial configuration settings for this builder. 038 */ 039 public WriterSerializerBuilder(PropertyStore ps) { 040 super(ps); 041 } 042 043 044 //----------------------------------------------------------------------------------------------------------------- 045 // Properties 046 //----------------------------------------------------------------------------------------------------------------- 047 048 /** 049 * Configuration property: Maximum indentation. 050 * 051 * <p> 052 * Specifies the maximum indentation level in the serialized document. 053 * 054 * <h5 class='section'>See Also:</h5> 055 * <ul> 056 * <li class='jf'>{@link WriterSerializer#WSERIALIZER_maxIndent} 057 * </ul> 058 * 059 * @param value 060 * The new value for this property. 061 * <br>The default is <code>100</code>. 062 * @return This object (for method chaining). 063 */ 064 @Override 065 public WriterSerializerBuilder maxIndent(int value) { 066 return set(WSERIALIZER_maxIndent, value); 067 } 068 069 /** 070 * Configuration property: Quote character. 071 * 072 * <p> 073 * This is the character used for quoting attributes and values. 074 * 075 * <h5 class='section'>See Also:</h5> 076 * <ul> 077 * <li class='jf'>{@link WriterSerializer#WSERIALIZER_quoteChar} 078 * </ul> 079 * 080 * @param value 081 * The new value for this property. 082 * <br>The default is <js>'"'</js>. 083 * @return This object (for method chaining). 084 */ 085 @Override 086 public WriterSerializerBuilder quoteChar(char value) { 087 return set(WSERIALIZER_quoteChar, value); 088 } 089 090 /** 091 * Configuration property: Quote character. 092 * 093 * <p> 094 * Shortcut for calling <code>quoteChar(<js>'\''</js>)</code>. 095 * 096 * <h5 class='section'>See Also:</h5> 097 * <ul> 098 * <li class='jf'>{@link WriterSerializer#WSERIALIZER_quoteChar} 099 * </ul> 100 * 101 * @return This object (for method chaining). 102 */ 103 @Override 104 public WriterSerializerBuilder sq() { 105 return quoteChar('\''); 106 } 107 108 @Override /* BeanContextBuilder */ 109 public WriterSerializerBuilder beanClassVisibility(Visibility value) { 110 super.beanClassVisibility(value); 111 return this; 112 } 113 114 @Override /* BeanContextBuilder */ 115 public WriterSerializerBuilder beanConstructorVisibility(Visibility value) { 116 super.beanConstructorVisibility(value); 117 return this; 118 } 119 120 @Override /* BeanContextBuilder */ 121 public WriterSerializerBuilder beanDictionary(boolean append, Object...values) { 122 super.beanDictionary(append, values); 123 return this; 124 } 125 126 @Override /* BeanContextBuilder */ 127 public WriterSerializerBuilder beanDictionary(Class<?>...values) { 128 super.beanDictionary(values); 129 return this; 130 } 131 132 @Override /* BeanContextBuilder */ 133 public WriterSerializerBuilder beanDictionary(Object...values) { 134 super.beanDictionary(values); 135 return this; 136 } 137 138 @Override /* BeanContextBuilder */ 139 public WriterSerializerBuilder beanDictionaryRemove(Object...values) { 140 super.beanDictionaryRemove(values); 141 return this; 142 } 143 144 @Override /* BeanContextBuilder */ 145 public WriterSerializerBuilder beanFieldVisibility(Visibility value) { 146 super.beanFieldVisibility(value); 147 return this; 148 } 149 150 @Override /* BeanContextBuilder */ 151 public WriterSerializerBuilder beanFilters(boolean append, Object...values) { 152 super.beanFilters(append, values); 153 return this; 154 } 155 156 @Override /* BeanContextBuilder */ 157 public WriterSerializerBuilder beanFilters(Class<?>...values) { 158 super.beanFilters(values); 159 return this; 160 } 161 162 @Override /* BeanContextBuilder */ 163 public WriterSerializerBuilder beanFilters(Object...values) { 164 super.beanFilters(values); 165 return this; 166 } 167 168 @Override /* BeanContextBuilder */ 169 public WriterSerializerBuilder beanFiltersRemove(Object...values) { 170 super.beanFiltersRemove(values); 171 return this; 172 } 173 174 @Override /* BeanContextBuilder */ 175 public WriterSerializerBuilder beanMapPutReturnsOldValue(boolean value) { 176 super.beanMapPutReturnsOldValue(value); 177 return this; 178 } 179 180 @Override /* BeanContextBuilder */ 181 public WriterSerializerBuilder beanMapPutReturnsOldValue() { 182 super.beanMapPutReturnsOldValue(); 183 return this; 184 } 185 186 @Override /* BeanContextBuilder */ 187 public WriterSerializerBuilder beanMethodVisibility(Visibility value) { 188 super.beanMethodVisibility(value); 189 return this; 190 } 191 192 @Override /* BeanContextBuilder */ 193 public WriterSerializerBuilder beansRequireDefaultConstructor(boolean value) { 194 super.beansRequireDefaultConstructor(value); 195 return this; 196 } 197 198 @Override /* BeanContextBuilder */ 199 public WriterSerializerBuilder beansRequireDefaultConstructor() { 200 super.beansRequireDefaultConstructor(); 201 return this; 202 } 203 204 @Override /* BeanContextBuilder */ 205 public WriterSerializerBuilder beansRequireSerializable(boolean value) { 206 super.beansRequireSerializable(value); 207 return this; 208 } 209 210 @Override /* BeanContextBuilder */ 211 public WriterSerializerBuilder beansRequireSerializable() { 212 super.beansRequireSerializable(); 213 return this; 214 } 215 216 @Override /* BeanContextBuilder */ 217 public WriterSerializerBuilder beansRequireSettersForGetters(boolean value) { 218 super.beansRequireSettersForGetters(value); 219 return this; 220 } 221 222 @Override /* BeanContextBuilder */ 223 public WriterSerializerBuilder beansRequireSettersForGetters() { 224 super.beansRequireSettersForGetters(); 225 return this; 226 } 227 228 @Override /* BeanContextBuilder */ 229 public WriterSerializerBuilder beansRequireSomeProperties(boolean value) { 230 super.beansRequireSomeProperties(value); 231 return this; 232 } 233 234 @Override /* BeanContextBuilder */ 235 public WriterSerializerBuilder beanTypePropertyName(String value) { 236 super.beanTypePropertyName(value); 237 return this; 238 } 239 240 @Override /* BeanContextBuilder */ 241 public WriterSerializerBuilder debug() { 242 super.debug(); 243 return this; 244 } 245 246 @Override /* BeanContextBuilder */ 247 public <T> WriterSerializerBuilder example(Class<T> c, T o) { 248 super.example(c, o); 249 return this; 250 } 251 252 @Override /* BeanContextBuilder */ 253 public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value) { 254 super.ignoreInvocationExceptionsOnGetters(value); 255 return this; 256 } 257 258 @Override /* BeanContextBuilder */ 259 public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters() { 260 super.ignoreInvocationExceptionsOnGetters(); 261 return this; 262 } 263 264 @Override /* BeanContextBuilder */ 265 public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value) { 266 super.ignoreInvocationExceptionsOnSetters(value); 267 return this; 268 } 269 270 @Override /* BeanContextBuilder */ 271 public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters() { 272 super.ignoreInvocationExceptionsOnSetters(); 273 return this; 274 } 275 276 @Override /* BeanContextBuilder */ 277 public WriterSerializerBuilder ignorePropertiesWithoutSetters(boolean value) { 278 super.ignorePropertiesWithoutSetters(value); 279 return this; 280 } 281 282 @Override /* BeanContextBuilder */ 283 public WriterSerializerBuilder ignoreUnknownBeanProperties(boolean value) { 284 super.ignoreUnknownBeanProperties(value); 285 return this; 286 } 287 288 @Override /* BeanContextBuilder */ 289 public WriterSerializerBuilder ignoreUnknownBeanProperties() { 290 super.ignoreUnknownBeanProperties(); 291 return this; 292 } 293 294 @Override /* BeanContextBuilder */ 295 public WriterSerializerBuilder ignoreUnknownNullBeanProperties(boolean value) { 296 super.ignoreUnknownNullBeanProperties(value); 297 return this; 298 } 299 300 @Override /* BeanContextBuilder */ 301 public <T> WriterSerializerBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass) { 302 super.implClass(interfaceClass, implClass); 303 return this; 304 } 305 306 @Override /* BeanContextBuilder */ 307 public WriterSerializerBuilder implClasses(Map<String,Class<?>> values) { 308 super.implClasses(values); 309 return this; 310 } 311 312 @Override /* BeanContextBuilder */ 313 public WriterSerializerBuilder locale(Locale value) { 314 super.locale(value); 315 return this; 316 } 317 318 @Override /* BeanContextBuilder */ 319 public WriterSerializerBuilder mediaType(MediaType value) { 320 super.mediaType(value); 321 return this; 322 } 323 324 @Override /* BeanContextBuilder */ 325 public WriterSerializerBuilder notBeanClasses(boolean append, Object...values) { 326 super.notBeanClasses(append, values); 327 return this; 328 } 329 330 @Override /* BeanContextBuilder */ 331 public WriterSerializerBuilder notBeanClasses(Class<?>...values) { 332 super.notBeanClasses(values); 333 return this; 334 } 335 336 @Override /* BeanContextBuilder */ 337 public WriterSerializerBuilder notBeanClasses(Object...values) { 338 super.notBeanClasses(values); 339 return this; 340 } 341 342 @Override /* BeanContextBuilder */ 343 public WriterSerializerBuilder notBeanClassesRemove(Object...values) { 344 super.notBeanClassesRemove(values); 345 return this; 346 } 347 348 @Override /* BeanContextBuilder */ 349 public WriterSerializerBuilder notBeanPackages(boolean append, Object...values) { 350 super.notBeanPackages(append, values); 351 return this; 352 } 353 354 @Override /* BeanContextBuilder */ 355 public WriterSerializerBuilder notBeanPackages(Object...values) { 356 super.notBeanPackages(values); 357 return this; 358 } 359 360 @Override /* BeanContextBuilder */ 361 public WriterSerializerBuilder notBeanPackages(String...values) { 362 super.notBeanPackages(values); 363 return this; 364 } 365 366 @Override /* BeanContextBuilder */ 367 public WriterSerializerBuilder notBeanPackagesRemove(Object...values) { 368 super.notBeanPackagesRemove(values); 369 return this; 370 } 371 372 @Override /* BeanContextBuilder */ 373 public WriterSerializerBuilder pojoSwaps(boolean append, Object...values) { 374 super.pojoSwaps(append, values); 375 return this; 376 } 377 378 @Override /* BeanContextBuilder */ 379 public WriterSerializerBuilder pojoSwaps(Class<?>...values) { 380 super.pojoSwaps(values); 381 return this; 382 } 383 384 @Override /* BeanContextBuilder */ 385 public WriterSerializerBuilder pojoSwaps(Object...values) { 386 super.pojoSwaps(values); 387 return this; 388 } 389 390 @Override /* BeanContextBuilder */ 391 public WriterSerializerBuilder pojoSwapsRemove(Object...values) { 392 super.pojoSwapsRemove(values); 393 return this; 394 } 395 396 @Override /* BeanContextBuilder */ 397 public WriterSerializerBuilder sortProperties(boolean value) { 398 super.sortProperties(value); 399 return this; 400 } 401 402 @Override /* BeanContextBuilder */ 403 public WriterSerializerBuilder sortProperties() { 404 super.sortProperties(); 405 return this; 406 } 407 408 @Override /* BeanContextBuilder */ 409 public WriterSerializerBuilder timeZone(TimeZone value) { 410 super.timeZone(value); 411 return this; 412 } 413 414 @Override /* BeanContextBuilder */ 415 public WriterSerializerBuilder useEnumNames() { 416 super.useEnumNames(); 417 return this; 418 } 419 420 @Override /* BeanContextBuilder */ 421 public WriterSerializerBuilder useInterfaceProxies(boolean value) { 422 super.useInterfaceProxies(value); 423 return this; 424 } 425 426 @Override /* BeanContextBuilder */ 427 public WriterSerializerBuilder useJavaBeanIntrospector(boolean value) { 428 super.useJavaBeanIntrospector(value); 429 return this; 430 } 431 432 @Override /* BeanContextBuilder */ 433 public WriterSerializerBuilder useJavaBeanIntrospector() { 434 super.useJavaBeanIntrospector(); 435 return this; 436 } 437 438 @Override /* ContextBuilder */ 439 public WriterSerializerBuilder set(String name, Object value) { 440 super.set(name, value); 441 return this; 442 } 443 444 @Override /* ContextBuilder */ 445 public WriterSerializerBuilder set(boolean append, String name, Object value) { 446 super.set(append, name, value); 447 return this; 448 } 449 450 @Override /* ContextBuilder */ 451 public WriterSerializerBuilder set(Map<String,Object> properties) { 452 super.set(properties); 453 return this; 454 } 455 456 @Override /* ContextBuilder */ 457 public WriterSerializerBuilder add(Map<String,Object> properties) { 458 super.add(properties); 459 return this; 460 } 461 462 @Override /* ContextBuilder */ 463 public WriterSerializerBuilder addTo(String name, Object value) { 464 super.addTo(name, value); 465 return this; 466 } 467 468 @Override /* ContextBuilder */ 469 public WriterSerializerBuilder addTo(String name, String key, Object value) { 470 super.addTo(name, key, value); 471 return this; 472 } 473 474 @Override /* ContextBuilder */ 475 public WriterSerializerBuilder removeFrom(String name, Object value) { 476 super.removeFrom(name, value); 477 return this; 478 } 479 480 @Override /* ContextBuilder */ 481 public WriterSerializerBuilder apply(PropertyStore copyFrom) { 482 super.apply(copyFrom); 483 return this; 484 } 485 486 @Override /* Context */ 487 public WriterSerializer build() { 488 return null; 489 } 490}