OutputStreamSerializerBuilder (Apache Juneau 7.2.2)

java.lang.Object
- org.apache.juneau.ContextBuilder
- - org.apache.juneau.BeanContextBuilder
  - - org.apache.juneau.BeanTraverseBuilder
    - - org.apache.juneau.serializer.SerializerBuilder
      - org.apache.juneau.serializer.OutputStreamSerializerBuilder

Direct Known Subclasses:

JsoSerializerBuilder, MsgPackSerializerBuilder
```
public class OutputStreamSerializerBuilder
extends SerializerBuilder
```
Base class for all stream-based serializer builders.

Field Summary
- Fields inherited from class org.apache.juneau.ContextBuilder
  psb

Constructor Summary

Constructors
Constructor and Description

OutputStreamSerializerBuilder()
Constructor, default settings.

OutputStreamSerializerBuilder(PropertyStore ps)
Constructor.

Constructors
Constructor and Description
`OutputStreamSerializerBuilder()` Constructor, default settings.
`OutputStreamSerializerBuilder(PropertyStore ps)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OutputStreamSerializerBuilder`	`add(Map<String,Object> properties)` Adds multiple configuration properties on this object.
`OutputStreamSerializerBuilder`	`addTo(String name, Object value)` Adds a value to a SET or LIST property.
`OutputStreamSerializerBuilder`	`addTo(String name, String key, Object value)` Adds or overwrites a value to a SET, LIST, or MAP property.
`OutputStreamSerializerBuilder`	`apply(PropertyStore copyFrom)` Copies the settings from the specified property store into this builder.
`OutputStreamSerializerBuilder`	`beanClassVisibility(Visibility value)` Configuration property: Minimum bean class visibility.
`OutputStreamSerializerBuilder`	`beanConstructorVisibility(Visibility value)` Configuration property: Minimum bean constructor visibility.
`OutputStreamSerializerBuilder`	`beanDictionary(boolean append, Object... values)` Configuration property: Bean dictionary.
`OutputStreamSerializerBuilder`	`beanDictionary(Class<?>... values)` Configuration property: Bean dictionary.
`OutputStreamSerializerBuilder`	`beanDictionary(Object... values)` Configuration property: Bean dictionary.
`OutputStreamSerializerBuilder`	`beanDictionaryRemove(Object... values)` Configuration property: Bean dictionary.
`OutputStreamSerializerBuilder`	`beanFieldVisibility(Visibility value)` Configuration property: Minimum bean field visibility.
`OutputStreamSerializerBuilder`	`beanFilters(boolean append, Object... values)` Configuration property: Bean filters.
`OutputStreamSerializerBuilder`	`beanFilters(Class<?>... values)` Configuration property: Bean filters.
`OutputStreamSerializerBuilder`	`beanFilters(Object... values)` Configuration property: Bean filters.
`OutputStreamSerializerBuilder`	`beanFiltersRemove(Object... values)` Configuration property: Bean filters.
`OutputStreamSerializerBuilder`	`beanMapPutReturnsOldValue()` Configuration property: BeanMap.put() returns old property value.
`OutputStreamSerializerBuilder`	`beanMapPutReturnsOldValue(boolean value)` Configuration property: BeanMap.put() returns old property value.
`OutputStreamSerializerBuilder`	`beanMethodVisibility(Visibility value)` Configuration property: Minimum bean method visibility.
`OutputStreamSerializerBuilder`	`beansRequireDefaultConstructor()` Configuration property: Beans require no-arg constructors.
`OutputStreamSerializerBuilder`	`beansRequireDefaultConstructor(boolean value)` Configuration property: Beans require no-arg constructors.
`OutputStreamSerializerBuilder`	`beansRequireSerializable()` Configuration property: Beans require Serializable interface.
`OutputStreamSerializerBuilder`	`beansRequireSerializable(boolean value)` Configuration property: Beans require Serializable interface.
`OutputStreamSerializerBuilder`	`beansRequireSettersForGetters()` Configuration property: Beans require setters for getters.
`OutputStreamSerializerBuilder`	`beansRequireSettersForGetters(boolean value)` Configuration property: Beans require setters for getters.
`OutputStreamSerializerBuilder`	`beansRequireSomeProperties(boolean value)` Configuration property: Beans require at least one property.
`OutputStreamSerializerBuilder`	`beanTypePropertyName(String value)` Configuration property: Bean type property name.
`OutputStreamSerializerBuilder`	`binaryFormat(BinaryFormat value)` Configuration property: Binary output format.
`OutputStreamSerializer`	`build()` Build the object.
`OutputStreamSerializerBuilder`	`debug()` Configuration property: Debug mode.
`<T> OutputStreamSerializerBuilder`	`example(Class<T> c, T o)` Configuration property: POJO example.
`OutputStreamSerializerBuilder`	`ignoreInvocationExceptionsOnGetters()` Configuration property: Ignore invocation errors on getters.
`OutputStreamSerializerBuilder`	`ignoreInvocationExceptionsOnGetters(boolean value)` Configuration property: Ignore invocation errors on getters.
`OutputStreamSerializerBuilder`	`ignoreInvocationExceptionsOnSetters()` Configuration property: Ignore invocation errors on setters.
`OutputStreamSerializerBuilder`	`ignoreInvocationExceptionsOnSetters(boolean value)` Configuration property: Ignore invocation errors on setters.
`OutputStreamSerializerBuilder`	`ignorePropertiesWithoutSetters(boolean value)` Configuration property: Ignore properties without setters.
`OutputStreamSerializerBuilder`	`ignoreUnknownBeanProperties()` Configuration property: Ignore unknown properties.
`OutputStreamSerializerBuilder`	`ignoreUnknownBeanProperties(boolean value)` Configuration property: Ignore unknown properties.
`OutputStreamSerializerBuilder`	`ignoreUnknownNullBeanProperties(boolean value)` Configuration property: Ignore unknown properties with null values.
`<T> OutputStreamSerializerBuilder`	`implClass(Class<T> interfaceClass, Class<? extends T> implClass)` Configuration property: Implementation classes.
`OutputStreamSerializerBuilder`	`implClasses(Map<String,Class<?>> values)` Configuration property: Implementation classes.
`OutputStreamSerializerBuilder`	`locale(Locale value)` Configuration property: Locale.
`OutputStreamSerializerBuilder`	`mediaType(MediaType value)` Configuration property: Media type.
`OutputStreamSerializerBuilder`	`notBeanClasses(boolean append, Object... values)` Configuration property: Bean class exclusions.
`OutputStreamSerializerBuilder`	`notBeanClasses(Class<?>... values)` Configuration property: Bean class exclusions.
`OutputStreamSerializerBuilder`	`notBeanClasses(Object... values)` Configuration property: Bean class exclusions.
`OutputStreamSerializerBuilder`	`notBeanClassesRemove(Object... values)` Configuration property: Bean class exclusions.
`OutputStreamSerializerBuilder`	`notBeanPackages(boolean append, Object... values)` Configuration property: Bean package exclusions.
`OutputStreamSerializerBuilder`	`notBeanPackages(Object... values)` Configuration property: Bean package exclusions.
`OutputStreamSerializerBuilder`	`notBeanPackages(String... values)` Configuration property: Bean package exclusions.
`OutputStreamSerializerBuilder`	`notBeanPackagesRemove(Object... values)` Configuration property: Bean package exclusions.
`OutputStreamSerializerBuilder`	`pojoSwaps(boolean append, Object... values)` Configuration property: POJO swaps.
`OutputStreamSerializerBuilder`	`pojoSwaps(Class<?>... values)` Configuration property: POJO swaps.
`OutputStreamSerializerBuilder`	`pojoSwaps(Object... values)` Configuration property: POJO swaps.
`OutputStreamSerializerBuilder`	`pojoSwapsRemove(Object... values)` Configuration property: POJO swaps.
`OutputStreamSerializerBuilder`	`removeFrom(String name, Object value)` Removes a value from a SET, LIST, or MAP property.
`OutputStreamSerializerBuilder`	`set(boolean append, String name, Object value)` Sets or adds to a SET or LIST property.
`OutputStreamSerializerBuilder`	`set(Map<String,Object> properties)` Sets multiple configuration properties on this object.
`OutputStreamSerializerBuilder`	`set(String name, Object value)` Sets a configuration property on this object.
`OutputStreamSerializerBuilder`	`sortProperties()` Configuration property: Sort bean properties.
`OutputStreamSerializerBuilder`	`sortProperties(boolean value)` Configuration property: Sort bean properties.
`OutputStreamSerializerBuilder`	`timeZone(TimeZone value)` Configuration property: TimeZone.
`OutputStreamSerializerBuilder`	`useEnumNames()` Configuration property: Use enum names.
`OutputStreamSerializerBuilder`	`useInterfaceProxies(boolean value)` Configuration property: Use interface proxies.
`OutputStreamSerializerBuilder`	`useJavaBeanIntrospector()` Configuration property: Use Java Introspector.
`OutputStreamSerializerBuilder`	`useJavaBeanIntrospector(boolean value)` Configuration property: Use Java Introspector.

Methods inherited from class org.apache.juneau.serializer.SerializerBuilder
abridged, abridged, addBeanTypeProperties, addBeanTypes, addBeanTypes, addRootType, addRootType, detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, listener, maxDepth, maxIndent, quoteChar, sortCollections, sortCollections, sortMaps, sortMaps, sq, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimNullProperties, trimStrings, trimStrings, uriContext, uriContext, uriRelativity, uriRelativity, uriResolution, uriResolution, useWhitespace, useWhitespace, ws

Methods inherited from class org.apache.juneau.BeanContextBuilder
debug, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer

Methods inherited from class org.apache.juneau.ContextBuilder
build, getPropertyStore, getPropertyStoreBuilder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OutputStreamSerializerBuilder
```
public OutputStreamSerializerBuilder()
```
    Constructor, default settings.
  - OutputStreamSerializerBuilder
```
public OutputStreamSerializerBuilder(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The initial configuration settings for this builder.
- Method Detail
  - binaryFormat
```
public OutputStreamSerializerBuilder binaryFormat(BinaryFormat value)
```
    Configuration property: Binary output format.
    When using the Serializer.serializeToString(Object) method on stream-based serializers, this defines the format to use when converting the resulting byte array to a string.
    - OutputStreamSerializer.OSSERIALIZER_binaryFormat
    Parameters:
    
    value - The new value for this property.
    The default is BinaryFormat.HEX.
    
    Returns:
    
    This object (for method chaining).
  - beanClassVisibility
```
public OutputStreamSerializerBuilder beanClassVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean class visibility.
    Classes are not considered beans unless they meet the minimum visibility requirements.
    For example, if the visibility is PUBLIC and the bean class is protected, then the class will not be interpreted as a bean class and will be treated as a string.
    See Also:
    - BeanContext.BEAN_beanClassVisibility
    Overrides:
    
    beanClassVisibility in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanConstructorVisibility
```
public OutputStreamSerializerBuilder beanConstructorVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean constructor visibility.
    Only look for constructors with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanConstructorVisibility
    Overrides:
    
    beanConstructorVisibility in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public OutputStreamSerializerBuilder beanDictionary(boolean append,
                                                    Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Same as BeanContextBuilder.beanDictionary(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    
    values - The new values for this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public OutputStreamSerializerBuilder beanDictionary(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public OutputStreamSerializerBuilder beanDictionary(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Adds to the list of classes that make up the bean dictionary in this bean context.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionaryRemove
```
public OutputStreamSerializerBuilder beanDictionaryRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Removes from the list of classes that make up the bean dictionary in this bean context.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionaryRemove in class SerializerBuilder
    
    Parameters:
    
    values - The values to remove from this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFieldVisibility
```
public OutputStreamSerializerBuilder beanFieldVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean field visibility.
    Only look for bean fields with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanFieldVisibility
    Overrides:
    
    beanFieldVisibility in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public OutputStreamSerializerBuilder beanFilters(boolean append,
                                                 Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Same as BeanContextBuilder.beanFilters(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    values - The new values for this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public OutputStreamSerializerBuilder beanFilters(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public OutputStreamSerializerBuilder beanFilters(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    This is a programmatic equivalent to the @Bean annotation.
    It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter the bean classes.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class SerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanFiltersRemove
```
public OutputStreamSerializerBuilder beanFiltersRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Removes from the list of classes that make up the bean filters in this bean context.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFiltersRemove in class SerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanMapPutReturnsOldValue
```
public OutputStreamSerializerBuilder beanMapPutReturnsOldValue(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: BeanMap.put() returns old property value.
    If true, then the BeanMap.put() method will return old property values.
    Otherwise, it returns null.
    See Also:
    - BeanContext.BEAN_beanMapPutReturnsOldValue
    Overrides:
    
    beanMapPutReturnsOldValue in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beanMapPutReturnsOldValue
```
public OutputStreamSerializerBuilder beanMapPutReturnsOldValue()
```
    Description copied from class: BeanContextBuilder
    Configuration property: BeanMap.put() returns old property value.
    Shortcut for calling beanMapPutReturnsOldValue(true).
    See Also:
    - BeanContext.BEAN_beanMapPutReturnsOldValue
    Overrides:
    
    beanMapPutReturnsOldValue in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beanMethodVisibility
```
public OutputStreamSerializerBuilder beanMethodVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean method visibility.
    Only look for bean methods with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanMethodVisibility
    Overrides:
    
    beanMethodVisibility in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public OutputStreamSerializerBuilder beansRequireDefaultConstructor(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require no-arg constructors.
    If true, a Java class must implement a default no-arg constructor to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireDefaultConstructor
    Overrides:
    
    beansRequireDefaultConstructor in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public OutputStreamSerializerBuilder beansRequireDefaultConstructor()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require no-arg constructors.
    Shortcut for calling beansRequireDefaultConstructor(true).
    See Also:
    - BeanContext.BEAN_beansRequireDefaultConstructor
    Overrides:
    
    beansRequireDefaultConstructor in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public OutputStreamSerializerBuilder beansRequireSerializable(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require Serializable interface.
    If true, a Java class must implement the Serializable interface to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireSerializable
    Overrides:
    
    beansRequireSerializable in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public OutputStreamSerializerBuilder beansRequireSerializable()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require Serializable interface.
    Shortcut for calling beansRequireSerializable(true).
    See Also:
    - BeanContext.BEAN_beansRequireSerializable
    Overrides:
    
    beansRequireSerializable in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public OutputStreamSerializerBuilder beansRequireSettersForGetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require setters for getters.
    If true, only getters that have equivalent setters will be considered as properties on a bean.
    Otherwise, they will be ignored.
    See Also:
    - BeanContext.BEAN_beansRequireSettersForGetters
    Overrides:
    
    beansRequireSettersForGetters in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public OutputStreamSerializerBuilder beansRequireSettersForGetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require setters for getters.
    Shortcut for calling beansRequireSettersForGetters(true).
    See Also:
    - BeanContext.BEAN_beansRequireSettersForGetters
    Overrides:
    
    beansRequireSettersForGetters in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSomeProperties
```
public OutputStreamSerializerBuilder beansRequireSomeProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require at least one property.
    If true, then a Java class must contain at least 1 property to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireSomeProperties
    Overrides:
    
    beansRequireSomeProperties in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - beanTypePropertyName
```
public OutputStreamSerializerBuilder beanTypePropertyName(String value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean type property name.
    This specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.
    See Also:
    - BeanContext.BEAN_beanTypePropertyName
    Overrides:
    
    beanTypePropertyName in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is "_type".
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public OutputStreamSerializerBuilder debug()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Debug mode.
    Shortcut for calling debug(true).
    See Also:
    - BeanContext.BEAN_debug
    Overrides:
    
    debug in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - example
```
public <T> OutputStreamSerializerBuilder example(Class<T> c,
                                                 T o)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO example.
    Specifies an example of the specified class.
    See Also:
    - BeanContext.BEAN_examples
    Overrides:
    
    example in class SerializerBuilder
    
    Parameters:
    
    c - The POJO class.
    
    o - An instance of the POJO class used for examples.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on getters.
    If true, errors thrown when calling bean getter methods will silently be ignored. Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnGetters
    Overrides:
    
    ignoreInvocationExceptionsOnGetters in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnGetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on getters.
    Shortcut for calling ignoreInvocationExceptionsOnGetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnGetters
    Overrides:
    
    ignoreInvocationExceptionsOnGetters in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on setters.
    If true, errors thrown when calling bean setter methods will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnSetters
    Overrides:
    
    ignoreInvocationExceptionsOnSetters in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public OutputStreamSerializerBuilder ignoreInvocationExceptionsOnSetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on setters.
    Shortcut for calling ignoreInvocationExceptionsOnSetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnSetters
    Overrides:
    
    ignoreInvocationExceptionsOnSetters in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignorePropertiesWithoutSetters
```
public OutputStreamSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore properties without setters.
    If true, trying to set a value on a bean property without a setter will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignorePropertiesWithoutSetters
    Overrides:
    
    ignorePropertiesWithoutSetters in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public OutputStreamSerializerBuilder ignoreUnknownBeanProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties.
    If true, trying to set a value on a non-existent bean property will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreUnknownBeanProperties
    Overrides:
    
    ignoreUnknownBeanProperties in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public OutputStreamSerializerBuilder ignoreUnknownBeanProperties()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties.
    Shortcut for calling ignoreUnknownBeanProperties(true).
    See Also:
    - BeanContext.BEAN_ignoreUnknownBeanProperties
    Overrides:
    
    ignoreUnknownBeanProperties in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownNullBeanProperties
```
public OutputStreamSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties with null values.
    If true, trying to set a null value on a non-existent bean property will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreUnknownNullBeanProperties
    Overrides:
    
    ignoreUnknownNullBeanProperties in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - implClass
```
public <T> OutputStreamSerializerBuilder implClass(Class<T> interfaceClass,
                                                   Class<? extends T> implClass)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Implementation classes.
    See Also:
    - BeanContext.BEAN_implClasses
    Overrides:
    
    implClass in class SerializerBuilder
    
    Type Parameters:
    
    T - The class type of the interface.
    
    Parameters:
    
    interfaceClass - The interface class.
    
    implClass - The implementation class.
    
    Returns:
    
    This object (for method chaining).
  - implClasses
```
public OutputStreamSerializerBuilder implClasses(Map<String,Class<?>> values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Implementation classes.
    For interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).
    See Also:
    - BeanContext.BEAN_implClasses
    Overrides:
    
    implClasses in class SerializerBuilder
    
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - locale
```
public OutputStreamSerializerBuilder locale(Locale value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Locale.
    Specifies a default locale for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_locale
    Overrides:
    
    locale in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - mediaType
```
public OutputStreamSerializerBuilder mediaType(MediaType value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Media type.
    Specifies a default media type value for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_mediaType
    Overrides:
    
    mediaType in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public OutputStreamSerializerBuilder notBeanClasses(boolean append,
                                                    Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    Not-bean classes are converted to Strings during serialization even if they appear to be bean-like.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new value for this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public OutputStreamSerializerBuilder notBeanClasses(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    List of classes that should not be treated as beans even if they appear to be bean-like.
    Not-bean classes are converted to Strings during serialization.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public OutputStreamSerializerBuilder notBeanClasses(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    List of classes that should not be treated as beans even if they appear to be bean-like.
    Not-bean classes are converted to Strings during serialization.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class SerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanClassesRemove
```
public OutputStreamSerializerBuilder notBeanClassesRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClassesRemove in class SerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public OutputStreamSerializerBuilder notBeanPackages(boolean append,
                                                     Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    When specified, the current list of ignore packages are appended to.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new values for this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public OutputStreamSerializerBuilder notBeanPackages(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class SerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public OutputStreamSerializerBuilder notBeanPackages(String... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanPackagesRemove
```
public OutputStreamSerializerBuilder notBeanPackagesRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackagesRemove in class SerializerBuilder
    
    Parameters:
    values -
    Values can consist of any of the following types:
    Possible values are:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public OutputStreamSerializerBuilder pojoSwaps(boolean append,
                                               Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.
    An example of a POJO swap would be a Calendar object that gets swapped out for an ISO8601 string.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new value for this property.
    Values can consist of any of the following types:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public OutputStreamSerializerBuilder pojoSwaps(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class SerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public OutputStreamSerializerBuilder pojoSwaps(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class SerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Any subclass of PojoSwap.
    Any surrogate class. A shortcut for defining a SurrogateSwap.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - pojoSwapsRemove
```
public OutputStreamSerializerBuilder pojoSwapsRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwapsRemove in class SerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Any subclass of PojoSwap.
    Any surrogate class. A shortcut for defining a SurrogateSwap.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public OutputStreamSerializerBuilder sortProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Sort bean properties.
    When true, all bean properties will be serialized and access in alphabetical order. Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
    See Also:
    - BeanContext.BEAN_sortProperties
    Overrides:
    
    sortProperties in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public OutputStreamSerializerBuilder sortProperties()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Sort bean properties.
    Shortcut for calling sortProperties(true).
    See Also:
    - BeanContext.BEAN_sortProperties
    Overrides:
    
    sortProperties in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - timeZone
```
public OutputStreamSerializerBuilder timeZone(TimeZone value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: TimeZone.
    See Also:
    - BeanContext.BEAN_timeZone
    Overrides:
    
    timeZone in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - useEnumNames
```
public OutputStreamSerializerBuilder useEnumNames()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use enum names.
    When enabled, enums are always serialized by name instead of using Object.toString().
    See Also:
    - BeanContext.BEAN_useEnumNames
    Overrides:
    
    useEnumNames in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - useInterfaceProxies
```
public OutputStreamSerializerBuilder useInterfaceProxies(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use interface proxies.
    If true, then interfaces will be instantiated as proxy classes through the use of an InvocationHandler if there is no other way of instantiating them.
    See Also:
    - BeanContext.BEAN_useInterfaceProxies
    Overrides:
    
    useInterfaceProxies in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public OutputStreamSerializerBuilder useJavaBeanIntrospector(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use Java Introspector.
    Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
    Notes:
    - Most @Bean annotations will be ignored if you enable this setting.
    See Also:
    - BeanContext.BEAN_useJavaBeanIntrospector
    Overrides:
    
    useJavaBeanIntrospector in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public OutputStreamSerializerBuilder useJavaBeanIntrospector()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use Java Introspector.
    Shortcut for calling useJavaBeanIntrospector(true).
    See Also:
    - BeanContext.BEAN_useJavaBeanIntrospector
    Overrides:
    
    useJavaBeanIntrospector in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - set
```
public OutputStreamSerializerBuilder set(String name,
                                         Object value)
```
    Description copied from class: ContextBuilder
    
    Sets a configuration property on this object.
    
    Overrides:
    
    set in class SerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public OutputStreamSerializerBuilder set(boolean append,
                                         String name,
                                         Object value)
```
    Description copied from class: ContextBuilder
    
    Sets or adds to a SET or LIST property.
    
    Overrides:
    
    set in class SerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public OutputStreamSerializerBuilder set(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Sets multiple configuration properties on this object.
    
    Overrides:
    
    set in class SerializerBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(java.util.Map)
  - add
```
public OutputStreamSerializerBuilder add(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Adds multiple configuration properties on this object.
    
    Overrides:
    
    add in class SerializerBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.add(java.util.Map)
  - addTo
```
public OutputStreamSerializerBuilder addTo(String name,
                                           Object value)
```
    Description copied from class: ContextBuilder
    
    Adds a value to a SET or LIST property.
    
    Overrides:
    
    addTo in class SerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The new value to add to the SET property.
    
    Returns:
    
    This object (for method chaining).
  - addTo
```
public OutputStreamSerializerBuilder addTo(String name,
                                           String key,
                                           Object value)
```
    Description copied from class: ContextBuilder
    
    Adds or overwrites a value to a SET, LIST, or MAP property.
    
    Overrides:
    
    addTo in class SerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    key - The property value map key.
    
    value - The property value map value.
    
    Returns:
    
    This object (for method chaining).
  - removeFrom
```
public OutputStreamSerializerBuilder removeFrom(String name,
                                                Object value)
```
    Description copied from class: ContextBuilder
    
    Removes a value from a SET, LIST, or MAP property.
    
    Overrides:
    
    removeFrom in class SerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value in the SET property.
    
    Returns:
    
    This object (for method chaining).
  - apply
```
public OutputStreamSerializerBuilder apply(PropertyStore copyFrom)
```
    Description copied from class: ContextBuilder
    
    Copies the settings from the specified property store into this builder.
    
    Overrides:
    
    apply in class SerializerBuilder
    
    Parameters:
    
    copyFrom - The factory whose settings are being copied.
    
    Returns:
    
    This object (for method chaining).
  - build
```
public OutputStreamSerializer build()
```
    Description copied from class: ContextBuilder
    
    Build the object.
    
    Overrides:
    
    build in class SerializerBuilder
    
    Returns:
    
    The built object. Subsequent calls to this method will create new instances.

Class OutputStreamSerializerBuilder

Field Summary

Fields inherited from class org.apache.juneau.ContextBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.serializer.SerializerBuilder

Methods inherited from class org.apache.juneau.BeanContextBuilder

Methods inherited from class org.apache.juneau.ContextBuilder

Methods inherited from class java.lang.Object

Constructor Detail

OutputStreamSerializerBuilder

OutputStreamSerializerBuilder

Method Detail

binaryFormat

beanClassVisibility

See Also:

beanConstructorVisibility

See Also:

beanDictionary

See Also:

beanDictionary

See Also:

beanDictionary

See Also:

beanDictionaryRemove

See Also:

beanFieldVisibility

See Also:

beanFilters

See Also:

beanFilters

See Also:

beanFilters

See Also:

beanFiltersRemove

See Also:

beanMapPutReturnsOldValue

See Also:

beanMapPutReturnsOldValue

See Also:

beanMethodVisibility

See Also:

beansRequireDefaultConstructor

See Also:

beansRequireDefaultConstructor

See Also:

beansRequireSerializable

See Also:

beansRequireSerializable

See Also:

beansRequireSettersForGetters

See Also:

beansRequireSettersForGetters

See Also:

beansRequireSomeProperties

See Also:

beanTypePropertyName

See Also:

debug

See Also:

example

See Also:

ignoreInvocationExceptionsOnGetters

See Also:

ignoreInvocationExceptionsOnGetters

See Also:

ignoreInvocationExceptionsOnSetters

See Also:

ignoreInvocationExceptionsOnSetters

See Also:

ignorePropertiesWithoutSetters

See Also:

ignoreUnknownBeanProperties

See Also:

ignoreUnknownBeanProperties

See Also:

ignoreUnknownNullBeanProperties

See Also:

implClass

See Also: