BeanContextBuilder (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.ContextBuilder
- - org.apache.juneau.BeanContextBuilder

Direct Known Subclasses:

ParserBuilder, ParserGroupBuilder, RestClientBuilder, RestContextBuilder, SerializerBuilder, SerializerGroupBuilder
```
public class BeanContextBuilder
extends ContextBuilder
```
Builder class for building instances of serializers, parsers, and bean contexts.
All serializers and parsers extend from this class.
Provides a base set of common config property setters that allow you to build up serializers and parsers.
WriterSerializer s = JsonSerializer .create() .set(JSON_simpleMode, true) .set(SERIALIZER_useWhitespace, true) .set(SERIALIZER_quoteChar, "'") .build();

Additional convenience methods are provided for setting properties using reduced syntax.
WriterSerializer s = JsonSerializer .create() // Create a JsonSerializerBuilder .simple() // Simple mode .ws() // Use whitespace .sq() // Use single quotes .build(); // Create a JsonSerializer

See Also:
- Overview > juneau-marshall > Configurable Properties

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

Constructor Summary

Constructors
Constructor and Description

BeanContextBuilder()
Constructor.

BeanContextBuilder(PropertyStore ps)
Constructor.

Constructors
Constructor and Description
`BeanContextBuilder()` Constructor.
`BeanContextBuilder(PropertyStore ps)` Constructor.

Method Summary

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

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
  - BeanContextBuilder
```
public BeanContextBuilder()
```
    Constructor. All default settings.
  - BeanContextBuilder
```
public BeanContextBuilder(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The initial configuration settings for this builder.
- Method Detail
  - build
```
public BeanContext build()
```
    Description copied from class: ContextBuilder
    
    Build the object.
    
    Specified by:
    
    build in class ContextBuilder
    
    Returns:
    
    The built object. Subsequent calls to this method will create new instances.
  - beanClassVisibility
```
public BeanContextBuilder beanClassVisibility(Visibility value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanConstructorVisibility
```
public BeanContextBuilder beanConstructorVisibility(Visibility value)
```
    Configuration property: Minimum bean constructor visibility.
    Only look for constructors with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanConstructorVisibility
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public BeanContextBuilder beanDictionary(Object... values)
```
    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
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public BeanContextBuilder beanDictionary(Class<?>... values)
```
    Configuration property: Bean dictionary.
    Same as beanDictionary(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public BeanContextBuilder beanDictionary(boolean append,
                                         Object... values)
```
    Configuration property: Bean dictionary.
    Same as beanDictionary(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanDictionary
    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).
  - beanDictionaryRemove
```
public BeanContextBuilder beanDictionaryRemove(Object... values)
```
    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
    Parameters:
    
    values - The values to remove from this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFieldVisibility
```
public BeanContextBuilder beanFieldVisibility(Visibility value)
```
    Configuration property: Minimum bean field visibility.
    Only look for bean fields with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanFieldVisibility
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public BeanContextBuilder beanFilters(Object... values)
```
    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
    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).
  - beanFilters
```
public BeanContextBuilder beanFilters(Class<?>... values)
```
    Configuration property: Bean filters.
    Same as beanFilters(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanFilters
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public BeanContextBuilder beanFilters(boolean append,
                                      Object... values)
```
    Configuration property: Bean filters.
    Same as beanFilters(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanFilters
    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).
  - beanFiltersRemove
```
public BeanContextBuilder beanFiltersRemove(Object... values)
```
    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
    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 BeanContextBuilder beanMapPutReturnsOldValue(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beanMapPutReturnsOldValue
```
public BeanContextBuilder beanMapPutReturnsOldValue()
```
    Configuration property: BeanMap.put() returns old property value.
    Shortcut for calling beanMapPutReturnsOldValue(true).
    See Also:
    - BeanContext.BEAN_beanMapPutReturnsOldValue
    Returns:
    
    This object (for method chaining).
  - beanMethodVisibility
```
public BeanContextBuilder beanMethodVisibility(Visibility value)
```
    Configuration property: Minimum bean method visibility.
    Only look for bean methods with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanMethodVisibility
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public BeanContextBuilder beansRequireDefaultConstructor(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public BeanContextBuilder beansRequireDefaultConstructor()
```
    Configuration property: Beans require no-arg constructors.
    Shortcut for calling beansRequireDefaultConstructor(true).
    See Also:
    - BeanContext.BEAN_beansRequireDefaultConstructor
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public BeanContextBuilder beansRequireSerializable(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public BeanContextBuilder beansRequireSerializable()
```
    Configuration property: Beans require Serializable interface.
    Shortcut for calling beansRequireSerializable(true).
    See Also:
    - BeanContext.BEAN_beansRequireSerializable
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public BeanContextBuilder beansRequireSettersForGetters(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public BeanContextBuilder beansRequireSettersForGetters()
```
    Configuration property: Beans require setters for getters.
    Shortcut for calling beansRequireSettersForGetters(true).
    See Also:
    - BeanContext.BEAN_beansRequireSettersForGetters
    Returns:
    
    This object (for method chaining).
  - beansRequireSomeProperties
```
public BeanContextBuilder beansRequireSomeProperties(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - beanTypePropertyName
```
public BeanContextBuilder beanTypePropertyName(String value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is "_type".
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public BeanContextBuilder debug(boolean value)
```
    Configuration property: Debug mode.
    Enables the following additional information during serialization:
    - When bean getters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.
    - Enables Serializer.SERIALIZER_detectRecursions.
    See Also:
    - BeanContext.BEAN_debug
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public BeanContextBuilder debug()
```
    Configuration property: Debug mode.
    Shortcut for calling debug(true).
    See Also:
    - BeanContext.BEAN_debug
    Returns:
    
    This object (for method chaining).
  - excludeProperties
```
public BeanContextBuilder excludeProperties(Class<?> beanClass,
                                            String properties)
```
    Configuration property: Bean property excludes.
    Specifies to exclude the specified list of properties for the specified bean class.
    See Also:
    - BeanContext.BEAN_excludeProperties
    Parameters:
    
    beanClass - The bean class.
    
    properties - Comma-delimited list of property names.
    
    Returns:
    
    This object (for method chaining).
  - excludeProperties
```
public BeanContextBuilder excludeProperties(Map<String,String> values)
```
    Configuration property: Bean property excludes.
    Specifies to exclude the specified list of properties for the specified bean classes.
    See Also:
    - BeanContext.BEAN_excludeProperties
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - excludeProperties
```
public BeanContextBuilder excludeProperties(String beanClassName,
                                            String value)
```
    Configuration property: Bean property excludes.
    See Also:
    - BeanContext.BEAN_excludeProperties
    Parameters:
    
    beanClassName - The bean class name.
    Can be a simple name, fully-qualified name, or "*" for all bean classes.
    
    value - Comma-delimited list of property names.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public BeanContextBuilder ignoreInvocationExceptionsOnGetters(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public BeanContextBuilder ignoreInvocationExceptionsOnGetters()
```
    Configuration property: Ignore invocation errors on getters.
    Shortcut for calling ignoreInvocationExceptionsOnGetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnGetters
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public BeanContextBuilder ignoreInvocationExceptionsOnSetters(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public BeanContextBuilder ignoreInvocationExceptionsOnSetters()
```
    Configuration property: Ignore invocation errors on setters.
    Shortcut for calling ignoreInvocationExceptionsOnSetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnSetters
    Returns:
    
    This object (for method chaining).
  - ignorePropertiesWithoutSetters
```
public BeanContextBuilder ignorePropertiesWithoutSetters(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public BeanContextBuilder ignoreUnknownBeanProperties(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public BeanContextBuilder ignoreUnknownBeanProperties()
```
    Configuration property: Ignore unknown properties.
    Shortcut for calling ignoreUnknownBeanProperties(true).
    See Also:
    - BeanContext.BEAN_ignoreUnknownBeanProperties
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownNullBeanProperties
```
public BeanContextBuilder ignoreUnknownNullBeanProperties(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - implClass
```
public <I> BeanContextBuilder implClass(Class<I> interfaceClass,
                                        Class<? extends I> implClass)
```
    Configuration property: Implementation classes.
    See Also:
    - BeanContext.BEAN_implClasses
    Type Parameters:
    
    I - The class type of the interface.
    
    Parameters:
    
    interfaceClass - The interface class.
    
    implClass - The implementation class.
    
    Returns:
    
    This object (for method chaining).
  - implClasses
```
public BeanContextBuilder implClasses(Map<String,Class<?>> values)
```
    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
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - includeProperties
```
public BeanContextBuilder includeProperties(Class<?> beanClass,
                                            String value)
```
    Configuration property: Bean property includes.
    Specifies the set and order of names of properties associated with the bean class.
    See Also:
    - BeanContext.BEAN_includeProperties
    Parameters:
    
    beanClass - The bean class.
    
    value - Comma-delimited list of property names.
    
    Returns:
    
    This object (for method chaining).
  - includeProperties
```
public BeanContextBuilder includeProperties(Map<String,String> values)
```
    Configuration property: Bean property includes.
    Specifies the set and order of names of properties associated with the bean class.
    See Also:
    - BeanContext.BEAN_includeProperties
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - includeProperties
```
public BeanContextBuilder includeProperties(String beanClassName,
                                            String value)
```
    Configuration property: Bean property includes.
    Specifies the set and order of names of properties associated with the bean class.
    See Also:
    - BeanContext.BEAN_includeProperties
    Parameters:
    
    beanClassName - The bean class name.
    Can be a simple name, fully-qualified name, or "*" for all beans.
    
    value - Comma-delimited list of property names.
    
    Returns:
    
    This object (for method chaining).
  - locale
```
public BeanContextBuilder locale(Locale value)
```
    Configuration property: Locale.
    Specifies a default locale for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_locale
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - mediaType
```
public BeanContextBuilder mediaType(MediaType value)
```
    Configuration property: Media type.
    Specifies a default media type value for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_mediaType
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public BeanContextBuilder notBeanClasses(boolean append,
                                         Object... values)
```
    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
    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 BeanContextBuilder notBeanClasses(Class<?>... values)
```
    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
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public BeanContextBuilder notBeanClasses(Object... values)
```
    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
    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 BeanContextBuilder notBeanClassesRemove(Object... values)
```
    Configuration property: Bean class exclusions.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    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 BeanContextBuilder notBeanPackages(boolean append,
                                          Object... values)
```
    Configuration property: Bean package exclusions.
    When specified, the current list of ignore packages are appended to.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    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 BeanContextBuilder notBeanPackages(Object... values)
```
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    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 BeanContextBuilder notBeanPackages(String... values)
```
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanPackagesRemove
```
public BeanContextBuilder notBeanPackagesRemove(Object... values)
```
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    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 BeanContextBuilder pojoSwaps(boolean append,
                                    Object... values)
```
    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
    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 BeanContextBuilder pojoSwaps(Class<?>... values)
```
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public BeanContextBuilder pojoSwaps(Object... values)
```
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    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 BeanContextBuilder pojoSwapsRemove(Object... values)
```
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    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).
  - propertyNamer
```
public BeanContextBuilder propertyNamer(Class<? extends PropertyNamer> value)
```
    Configuration property: Bean property namer
    The class to use for calculating bean property names.
    See Also:
    - BeanContext.BEAN_propertyNamer
    Parameters:
    
    value - The new value for this setting.
    The default is PropertyNamerDefault.
    
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public BeanContextBuilder sortProperties(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public BeanContextBuilder sortProperties()
```
    Configuration property: Sort bean properties.
    Shortcut for calling sortProperties(true).
    See Also:
    - BeanContext.BEAN_sortProperties
    Returns:
    
    This object (for method chaining).
  - timeZone
```
public BeanContextBuilder timeZone(TimeZone value)
```
    Configuration property: TimeZone.
    See Also:
    - BeanContext.BEAN_timeZone
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - useInterfaceProxies
```
public BeanContextBuilder useInterfaceProxies(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public BeanContextBuilder useJavaBeanIntrospector(boolean value)
```
    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
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public BeanContextBuilder useJavaBeanIntrospector()
```
    Configuration property: Use Java Introspector.
    Shortcut for calling useJavaBeanIntrospector(true).
    See Also:
    - BeanContext.BEAN_useJavaBeanIntrospector
    Returns:
    
    This object (for method chaining).
  - set
```
public BeanContextBuilder set(String name,
                              Object value)
```
    Description copied from class: ContextBuilder
    
    Sets a configuration property on this object.
    
    Overrides:
    
    set in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public BeanContextBuilder 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 ContextBuilder
    
    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 BeanContextBuilder set(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Sets multiple configuration properties on this object.
    
    Overrides:
    
    set in class ContextBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(java.util.Map)
  - add
```
public BeanContextBuilder add(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Adds multiple configuration properties on this object.
    
    Overrides:
    
    add in class ContextBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.add(java.util.Map)
  - addTo
```
public BeanContextBuilder addTo(String name,
                                Object value)
```
    Description copied from class: ContextBuilder
    
    Adds a value to a SET or LIST property.
    
    Overrides:
    
    addTo in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The new value to add to the SET property.
    
    Returns:
    
    This object (for method chaining).
  - addTo
```
public BeanContextBuilder 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 ContextBuilder
    
    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 BeanContextBuilder removeFrom(String name,
                                     Object value)
```
    Description copied from class: ContextBuilder
    
    Removes a value from a SET, LIST, or MAP property.
    
    Overrides:
    
    removeFrom in class ContextBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value in the SET property.
    
    Returns:
    
    This object (for method chaining).
  - apply
```
public BeanContextBuilder apply(PropertyStore copyFrom)
```
    Description copied from class: ContextBuilder
    
    Copies the settings from the specified property store into this builder.
    
    Overrides:
    
    apply in class ContextBuilder
    
    Parameters:
    
    copyFrom - The factory whose settings are being copied.
    
    Returns:
    
    This object (for method chaining).

Class BeanContextBuilder

See Also:

Field Summary

Fields inherited from class org.apache.juneau.ContextBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.ContextBuilder

Methods inherited from class java.lang.Object

Constructor Detail

BeanContextBuilder

BeanContextBuilder

Method Detail

build

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:

debug

See Also:

excludeProperties

See Also:

excludeProperties

See Also:

excludeProperties

See Also:

ignoreInvocationExceptionsOnGetters

See Also:

ignoreInvocationExceptionsOnGetters

See Also:

ignoreInvocationExceptionsOnSetters

See Also:

ignoreInvocationExceptionsOnSetters

See Also:

ignorePropertiesWithoutSetters

See Also:

ignoreUnknownBeanProperties

See Also:

ignoreUnknownBeanProperties