// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.serializer;

import static org.apache.juneau.serializer.OutputStreamSerializer.*;

import java.lang.annotation.*;
import java.lang.reflect.*;
import java.util.*;

import org.apache.juneau.*;
import org.apache.juneau.http.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.reflect.*;
import org.apache.juneau.svl.*;

/**
 * Base class for all stream-based serializer builders.
 */
public class OutputStreamSerializerBuilder extends SerializerBuilder {

   /**
    * Constructor, default settings.
    */
   public OutputStreamSerializerBuilder() {
      super();
   }

   /**
    * Constructor.
    *
    * @param ps The initial configuration settings for this builder.
    */
   public OutputStreamSerializerBuilder(PropertyStore ps) {
      super(ps);
   }

   //-----------------------------------------------------------------------------------------------------------------
   // Properties
   //-----------------------------------------------------------------------------------------------------------------

   /**
    * <i><l>OutputStreamSerializer</l> configuration property:&emsp;</i>  Binary output format.
    *
    * <p>
    * When using the {@link OutputStreamSerializer#serializeToString(Object)} method on stream-based serializers, this defines the format to use
    * when converting the resulting byte array to a string.
    *
    *
    * <h5 class='section'>Example:</h5>
    * <p class='bcode w800'>
    *    <jc>// Create a serializer that serializes to BASE64.</jc>
    *    OutputStreamSerializer s = MsgPackSerializer
    *       .<jsm>create</jsm>()
    *       .binaryFormat(<jsf>BASE64</jsf>)
    *       .build();
    *
    *    <jc>// The bean we want to serialize.</jc>
    *    <jk>public class</jk> MyBean {...}
    *
    *    <jc>// MessagePack will generate BASE64-encoded string.</jc>
    *    String msgPack = s.serializeToString(<jk>new</jk> MyBean());
    * </p>
    *
    * <ul class='seealso'>
    *    <li class='jf'>{@link OutputStreamSerializer#OSSERIALIZER_binaryFormat}
    * </ul>
    *
    * @param value
    *    The new value for this property.
    *    <br>The default is {@link BinaryFormat#HEX}.
    * @return This object (for method chaining).
    */
   @FluentSetter
   public OutputStreamSerializerBuilder binaryFormat(BinaryFormat value) {
      return set(OSSERIALIZER_binaryFormat, value);
   }

   /**
    * <i><l>OutputStreamSerializer</l> configuration property:&emsp;</i>  Binary output format.
    *
    * <div class='warn'>
    *    <b>Deprecated</b> - Use {@link #binaryFormat(BinaryFormat)}
    * </div>
    */
   @SuppressWarnings("javadoc")
   @FluentSetter
   @Deprecated
   public OutputStreamSerializerBuilder binaryFormat(String value) {
      return set(OSSERIALIZER_binaryFormat, BinaryFormat.valueOf(value));
   }

   // <FluentSetters>

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder add(Map<String,Object> properties) {
      super.add(properties);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder addTo(String name, Object value) {
      super.addTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder appendTo(String name, Object value) {
      super.appendTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder apply(PropertyStore copyFrom) {
      super.apply(copyFrom);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
      super.applyAnnotations(fromClasses);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder applyAnnotations(Method...fromMethods) {
      super.applyAnnotations(fromMethods);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
      super.applyAnnotations(al, r);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder debug() {
      super.debug();
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder locale(Locale value) {
      super.locale(value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder mediaType(MediaType value) {
      super.mediaType(value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder prependTo(String name, Object value) {
      super.prependTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder putAllTo(String name, Object value) {
      super.putAllTo(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder putTo(String name, String key, Object value) {
      super.putTo(name, key, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder removeFrom(String name, Object value) {
      super.removeFrom(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder set(Map<String,Object> properties) {
      super.set(properties);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder set(String name, Object value) {
      super.set(name, value);
      return this;
   }

   @Override /* GENERATED - ContextBuilder */
   public OutputStreamSerializerBuilder timeZone(TimeZone value) {
      super.timeZone(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder annotations(Annotation...values) {
      super.annotations(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanClassVisibility(Visibility value) {
      super.beanClassVisibility(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanConstructorVisibility(Visibility value) {
      super.beanConstructorVisibility(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanFieldVisibility(Visibility value) {
      super.beanFieldVisibility(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
      super.beanInterceptor(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanMapPutReturnsOldValue() {
      super.beanMapPutReturnsOldValue();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beanMethodVisibility(Visibility value) {
      super.beanMethodVisibility(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beansDontRequireSomeProperties() {
      super.beansDontRequireSomeProperties();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beansRequireDefaultConstructor() {
      super.beansRequireDefaultConstructor();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beansRequireSerializable() {
      super.beansRequireSerializable();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder beansRequireSettersForGetters() {
      super.beansRequireSettersForGetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpi(Map<String,Object> values) {
      super.bpi(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpi(Class<?> beanClass, String properties) {
      super.bpi(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpi(String beanClassName, String properties) {
      super.bpi(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpro(Map<String,Object> values) {
      super.bpro(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpro(Class<?> beanClass, String properties) {
      super.bpro(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpro(String beanClassName, String properties) {
      super.bpro(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpwo(Map<String,Object> values) {
      super.bpwo(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpwo(Class<?> beanClass, String properties) {
      super.bpwo(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpwo(String beanClassName, String properties) {
      super.bpwo(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpx(Map<String,Object> values) {
      super.bpx(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpx(Class<?> beanClass, String properties) {
      super.bpx(beanClass, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder bpx(String beanClassName, String properties) {
      super.bpx(beanClassName, properties);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dictionary(Object...values) {
      super.dictionary(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
      super.dictionaryOn(on, values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dontIgnorePropertiesWithoutSetters() {
      super.dontIgnorePropertiesWithoutSetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dontIgnoreTransientFields() {
      super.dontIgnoreTransientFields();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dontIgnoreUnknownNullBeanProperties() {
      super.dontIgnoreUnknownNullBeanProperties();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder dontUseInterfaceProxies() {
      super.dontUseInterfaceProxies();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public <T> OutputStreamSerializerBuilder example(Class<T> pojoClass, T o) {
      super.example(pojoClass, o);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public <T> OutputStreamSerializerBuilder exampleJson(Class<T> pojoClass, String json) {
      super.exampleJson(pojoClass, json);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder fluentSetters() {
      super.fluentSetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder fluentSetters(Class<?> on) {
      super.fluentSetters(on);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnGetters() {
      super.ignoreInvocationExceptionsOnGetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnSetters() {
      super.ignoreInvocationExceptionsOnSetters();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder ignoreUnknownBeanProperties() {
      super.ignoreUnknownBeanProperties();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
      super.implClass(interfaceClass, implClass);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder implClasses(Map<Class<?>,Class<?>> values) {
      super.implClasses(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder interfaceClass(Class<?> on, Class<?> value) {
      super.interfaceClass(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder interfaces(java.lang.Class<?>...value) {
      super.interfaces(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder notBeanClasses(Object...values) {
      super.notBeanClasses(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder notBeanPackages(Object...values) {
      super.notBeanPackages(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
      super.propertyNamer(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
      super.propertyNamer(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder sortProperties() {
      super.sortProperties();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder sortProperties(java.lang.Class<?>...on) {
      super.sortProperties(on);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder stopClass(Class<?> on, Class<?> value) {
      super.stopClass(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder swaps(Object...values) {
      super.swaps(values);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder typeName(Class<?> on, String value) {
      super.typeName(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder typePropertyName(String value) {
      super.typePropertyName(value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder typePropertyName(Class<?> on, String value) {
      super.typePropertyName(on, value);
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder useEnumNames() {
      super.useEnumNames();
      return this;
   }

   @Override /* GENERATED - BeanContextBuilder */
   public OutputStreamSerializerBuilder useJavaBeanIntrospector() {
      super.useJavaBeanIntrospector();
      return this;
   }

   @Override /* GENERATED - BeanTraverseBuilder */
   public OutputStreamSerializerBuilder detectRecursions() {
      super.detectRecursions();
      return this;
   }

   @Override /* GENERATED - BeanTraverseBuilder */
   public OutputStreamSerializerBuilder ignoreRecursions() {
      super.ignoreRecursions();
      return this;
   }

   @Override /* GENERATED - BeanTraverseBuilder */
   public OutputStreamSerializerBuilder initialDepth(int value) {
      super.initialDepth(value);
      return this;
   }

   @Override /* GENERATED - BeanTraverseBuilder */
   public OutputStreamSerializerBuilder maxDepth(int value) {
      super.maxDepth(value);
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder addBeanTypes() {
      super.addBeanTypes();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder addRootType() {
      super.addRootType();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder keepNullProperties() {
      super.keepNullProperties();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder listener(Class<? extends org.apache.juneau.serializer.SerializerListener> value) {
      super.listener(value);
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder sortCollections() {
      super.sortCollections();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder sortMaps() {
      super.sortMaps();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder trimEmptyCollections() {
      super.trimEmptyCollections();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder trimEmptyMaps() {
      super.trimEmptyMaps();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder trimStrings() {
      super.trimStrings();
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder uriContext(UriContext value) {
      super.uriContext(value);
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder uriRelativity(UriRelativity value) {
      super.uriRelativity(value);
      return this;
   }

   @Override /* GENERATED - SerializerBuilder */
   public OutputStreamSerializerBuilder uriResolution(UriResolution value) {
      super.uriResolution(value);
      return this;
   }

   // </FluentSetters>

   @Override /* Context */
   public OutputStreamSerializer build() {
      return null;
   }
}