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