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