org.apache.juneau

Class BeanSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

Direct Known Subclasses:

BeanTraverseSession, ParserSession, RestCall

public class BeanSession
extends Session

Session object that lives for the duration of a single use of Serializer or Parser.

This class is NOT thread safe. It is meant to be discarded after one-time use.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanSession(BeanContext ctx, BeanSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
ClassMeta<Class>	_class() Returns a reusable ClassMeta representation for the class Class.
void	checkForWarnings() Throws a BeanRuntimeException if any warnings occurred in this session.
<T> T	convertToMemberType(Object outer, Object value, Class<T> type) Same as convertToType(Object, Class), except used for instantiating inner member classes that must be instantiated within another class instance.
protected <T> T	convertToMemberType(Object outer, Object value, ClassMeta<T> to) Same as convertToType(Object, ClassMeta), except used for instantiating inner member classes that must be instantiated within another class instance.
<T> T	convertToType(Object value, Class<T> type) Converts the specified value to the specified class type.
<T> T	convertToType(Object value, ClassMeta<T> type) Casts the specified value into the specified type.
<T> T	convertToType(Object value, Type type, Type... args) Same as convertToType(Object, Class), but allows for complex data types consisting of collections or maps.
protected ClassMeta<Object[]>	getArgsClassMeta(Type[] classes) Given an array of Type objects, returns a ClassMeta representing those arguments.
protected Visibility	getBeanClassVisibility() Configuration property: Minimum bean class visibility.
protected Visibility	getBeanConstructorVisibility() Configuration property: Minimum bean constructor visibility.
protected List<Class<?>>	getBeanDictionaryClasses() Configuration property: Bean dictionary.
protected Visibility	getBeanFieldVisibility() Configuration property: Minimum bean field visibility.
protected BeanFilter[]	getBeanFilters() Configuration property: Bean filters.
<T> BeanMeta<T>	getBeanMeta(Class<T> c) Returns the BeanMeta class for the specified class.
protected Visibility	getBeanMethodVisibility() Configuration property: Minimum bean method visibility.
protected BeanRegistry	getBeanRegistry() Returns the bean registry defined in this bean context defined by BeanContext.BEAN_beanDictionary.
protected String	getBeanTypePropertyName() Configuration property: Bean type property name.
String	getBeanTypePropertyName(ClassMeta cm) Returns the type property name as defined by BeanContext.BEAN_beanTypePropertyName.
protected Map<String,Set<String>>	getBpi() Configuration property: Bean property includes.
protected Map<String,Set<String>>	getBpro() Configuration property: Read-only bean properties.
protected Map<String,Set<String>>	getBpwo() Configuration property: Write-only bean properties.
protected Map<String,Set<String>>	getBpx() Configuration property: Bean property excludes.
<T> ClassMeta<T>	getClassMeta(Class<T> c) Returns a ClassMeta wrapper around a Class object.
<T> ClassMeta<T>	getClassMeta(Type type, Type... args) Used to resolve ClassMetas of type Collection and Map that have ClassMeta values that themselves could be collections or maps.
protected ClassMeta<?>	getClassMetaForObject(Object o, ClassMeta<?> def) Shortcut for calling getClassMeta(o.getClass()) but returns a default value if object is null.
<T> ClassMeta<T>	getClassMetaForObject(T o) Shortcut for calling getClassMeta(o.getClass()).
protected Map<String,?>	getExamples() Configuration property: POJO examples.
protected Map<String,ClassInfo>	getImplClasses() Configuration property: Implementation classes.
Locale	getLocale() Configuration property: Locale.
MediaType	getMediaType() Configuration property: Media type.
protected Class<?>[]	getNotBeanClasses() Configuration property: Bean class exclusions.
protected String[]	getNotBeanPackagesNames() Configuration property: Bean package exclusions.
protected String[]	getNotBeanPackagesPrefixes() Configuration property: Bean package exclusions.
protected PojoSwap<?,?>[]	getPojoSwaps() Configuration property: POJO swaps.
protected PropertyNamer	getPropertyNamer() Configuration property: Bean property namer.
HttpPartSchema	getSchema() HTTP part schema of object being serialized or parsed.
protected StringBuilder	getStringBuilder() Creates a reusable StringBuilder object from an internal pool.
TimeZone	getTimeZone() Configuration property: Time zone.
ZoneId	getTimeZoneId() Configuration property: Time zone.
boolean	isBean(Class<?> c) Determines whether the specified class matches the requirements on this context of being a bean.
boolean	isBean(Object o) Determines whether the specified object matches the requirements on this context of being a bean.
protected boolean	isBeanMapPutReturnsOldValue() Configuration property: BeanMap.put() returns old property value.
protected boolean	isBeansRequireDefaultConstructor() Configuration property: Beans require no-arg constructors.
protected boolean	isBeansRequireSerializable() Configuration property: Beans require Serializable interface.
protected boolean	isBeansRequireSettersForGetters() Configuration property: Beans require setters for getters.
protected boolean	isBeansRequireSomeProperties() Configuration property: Beans require at least one property.
protected boolean	isDebug() Configuration property: Debug mode.
protected boolean	isFluentSetters() Configuration property: Find fluent setters.
protected boolean	isIgnoreInvocationExceptionsOnGetters() Configuration property: Ignore invocation errors on getters.
protected boolean	isIgnoreInvocationExceptionsOnSetters() Configuration property: Ignore invocation errors on setters.
protected boolean	isIgnorePropertiesWithoutSetters() Configuration property: Ignore properties without setters.
protected boolean	isIgnoreUnknownBeanProperties() Configuration property: Ignore unknown properties.
protected boolean	isIgnoreUnknownNullBeanProperties() Configuration property: Ignore unknown properties with null values.
protected boolean	isSortProperties() Configuration property: Sort bean properties.
protected boolean	isUseEnumNames() Configuration property: Use enum names.
protected boolean	isUseInterfaceProxies() Configuration property: Use interface proxies.
protected boolean	isUseJavaBeanIntrospector() Configuration property: Use Java Introspector.
<T> T	newBean(Class<T> c) Creates a new empty bean of the specified type, except used for instantiating inner member classes that must be instantiated within another class instance.
<T> T	newBean(Object outer, Class<T> c) Same as newBean(Class), except used for instantiating inner member classes that must be instantiated within another class instance.
<T> BeanMap<T>	newBeanMap(Class<T> c) Creates a new BeanMap object (a modifiable Map) of the given class with uninitialized property values.
<T> BeanMap<T>	newBeanMap(Object outer, Class<T> c) Same as newBeanMap(Class), except used for instantiating inner member classes that must be instantiated within another class instance.
ClassMeta<Object>	object() Returns a reusable ClassMeta representation for the class Object.
protected void	returnStringBuilder(StringBuilder sb) Returns a StringBuilder object back into the internal reuse pool.
ClassMeta<String>	string() Returns a reusable ClassMeta representation for the class String.
protected Object	toArray(ClassMeta<?> type, Collection<?> list) Converts the contents of the specified list into an array.
<T> BeanMap<T>	toBeanMap(T o) Wraps an object inside a BeanMap object (a modifiable Map).
<T> BeanMap<T>	toBeanMap(T o, Class<? super T> c) Wraps an object inside a BeanMap object (i.e.: a modifiable Map) defined as a bean for one of its class, a super class, or an implemented interface.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BeanSession

protected BeanSession(BeanContext ctx,
                      BeanSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime session arguments.

Method Detail

convertToType

public final <T> T convertToType(Object value,
                                 Class<T> type)
                          throws InvalidDataConversionException

Converts the specified value to the specified class type.

See convertToType(Object, ClassMeta) for the list of valid conversions.

Type Parameters:

T - The class type to convert the value to.

Parameters:

value - The value to convert.

type - The class type to convert the value to.

Returns:

The converted value.

Throws:

InvalidDataConversionException - If the specified value cannot be converted to the specified type.

convertToMemberType

public final <T> T convertToMemberType(Object outer,
                                       Object value,
                                       Class<T> type)
                                throws InvalidDataConversionException

Same as convertToType(Object, Class), except used for instantiating inner member classes that must be instantiated within another class instance.

Type Parameters:

T - The class type to convert the value to.

Parameters:

outer - If class is a member class, this is the instance of the containing class. Should be null if not a member class.

value - The value to convert.

type - The class type to convert the value to.

Returns:

The converted value.

Throws:

InvalidDataConversionException - If the specified value cannot be converted to the specified type.

convertToType

public final <T> T convertToType(Object value,
                                 ClassMeta<T> type)
                          throws InvalidDataConversionException

Casts the specified value into the specified type.

If the value isn't an instance of the specified type, then converts the value if possible.

The following conversions are valid:

Convert to type	Valid input value types	Notes
A class that is the normal type of a registered PojoSwap.	A value whose class matches the transformed type of that registered PojoSwap.
A class that is the transformed type of a registered PojoSwap.	A value whose class matches the normal type of that registered PojoSwap.
Number (e.g. Integer, Short, Float,...) Number.TYPE (e.g. Integer.TYPE, Short.TYPE, Float.TYPE,...)	Number, String, null	For primitive TYPES, null returns the JVM default value for that type.
Map (e.g. Map, HashMap, TreeMap, ObjectMap)	Map	If Map is not constructible, a ObjectMap is created.
Collection (e.g. List, LinkedList, HashSet, ObjectList)	Collection<Object> Object[]	If Collection is not constructible, a ObjectList is created.
X[] (array of any type X)	List<X>
X[][] (multi-dimensional arrays)	List<List<X>> List<X[]> List[]<X>
Enum	String
Bean	Map
String	Anything	Arrays are converted to JSON arrays
Anything with one of the following methods: public static T fromString(String) public static T valueOf(String) public T(String)	String

Type Parameters:

T - The class type to convert the value to.

Parameters:

value - The value to be converted.

type - The target object type.

Returns:

The converted type.

Throws:

InvalidDataConversionException - If the specified value cannot be converted to the specified type.

convertToType

public final <T> T convertToType(Object value,
                                 Type type,
                                 Type... args)
                          throws InvalidDataConversionException

Same as convertToType(Object, Class), but allows for complex data types consisting of collections or maps.

Type Parameters:

T - The class type to convert the value to.

Parameters:

value - The value to be converted.

type - The target object type.

args - The target object parameter types.

Returns:

The converted type.

Throws:

InvalidDataConversionException - If the specified value cannot be converted to the specified type.

convertToMemberType

protected final <T> T convertToMemberType(Object outer,
                                          Object value,
                                          ClassMeta<T> to)
                                   throws InvalidDataConversionException

Same as convertToType(Object, ClassMeta), except used for instantiating inner member classes that must be instantiated within another class instance.

Type Parameters:

T - The class type to convert the value to.

Parameters:

outer - If class is a member class, this is the instance of the containing class. Should be null if not a member class.

value - The value to convert.

to - The class type to convert the value to.

Returns:

The converted value.

Throws:

InvalidDataConversionException - If the specified value cannot be converted to the specified type.

toArray

protected final Object toArray(ClassMeta<?> type,
                               Collection<?> list)

Converts the contents of the specified list into an array.

Works on both object and primitive arrays.

In the case of multi-dimensional arrays, the incoming list must contain elements of type n-1 dimension. i.e. if type is int[][] then list must have entries of type int[].

Parameters:

type - The type to convert to. Must be an array type.

list - The contents to populate the array with.

Returns:

A new object or primitive array.

toBeanMap

public final <T> BeanMap<T> toBeanMap(T o)

Wraps an object inside a BeanMap object (a modifiable Map).

If object is not a true bean, then throws a BeanRuntimeException with an explanation of why it's not a bean.

Example:

// Construct a bean map around a bean instance BeanMap<Person> bm = BeanContext.DEFAULT.forBean(new Person());

Type Parameters:

T - The class of the object being wrapped.

Parameters:

o - The object to wrap in a map interface. Must not be null.

Returns:

The wrapped object.

isBean

public final boolean isBean(Object o)

Determines whether the specified object matches the requirements on this context of being a bean.

Parameters:

o - The object being tested.

Returns:

true if the specified object is considered a bean.

isBean

public final boolean isBean(Class<?> c)

Determines whether the specified class matches the requirements on this context of being a bean.

Parameters:

c - The class being tested.

Returns:

true if the specified class is considered a bean.

toBeanMap

public final <T> BeanMap<T> toBeanMap(T o,
                                      Class<? super T> c)
                               throws BeanRuntimeException

Wraps an object inside a BeanMap object (i.e.: a modifiable Map) defined as a bean for one of its class, a super class, or an implemented interface.

If object is not a true bean, throws a BeanRuntimeException with an explanation of why it's not a bean.

Example:

// Construct a bean map for new bean using only properties defined in a superclass BeanMap<MySubBean> bm = BeanContext.DEFAULT.forBean(new MySubBean(), MySuperBean.class); // Construct a bean map for new bean using only properties defined in an interface BeanMap<MySubBean> bm = BeanContext.DEFAULT.forBean(new MySubBean(), MySuperInterface.class);

Type Parameters:

T - The class of the object being wrapped.

Parameters:

o - The object to wrap in a bean interface. Must not be null.

c - The superclass to narrow the bean properties to. Must not be null.

Returns:

The bean representation, or null if the object is not a true bean.

Throws:

NullPointerException - If either parameter is null.

IllegalArgumentException - If the specified object is not an an instance of the specified class.

BeanRuntimeException - If specified object is not a bean according to the bean rules specified in this context class.

newBeanMap

public final <T> BeanMap<T> newBeanMap(Class<T> c)

Creates a new BeanMap object (a modifiable Map) of the given class with uninitialized property values.

If object is not a true bean, then throws a BeanRuntimeException with an explanation of why it's not a bean.

Example:

// Construct a new bean map wrapped around a new Person object BeanMap<Person> bm = BeanContext.DEFAULT.newBeanMap(Person.class);

Type Parameters:

T - The class of the object being wrapped.

Parameters:

c - The name of the class to create a new instance of.

Returns:

A new instance of the class.

newBeanMap

public final <T> BeanMap<T> newBeanMap(Object outer,
                                       Class<T> c)

Same as newBeanMap(Class), except used for instantiating inner member classes that must be instantiated within another class instance.

Type Parameters:

T - The class of the object being wrapped.

Parameters:

c - The name of the class to create a new instance of.

outer - If class is a member class, this is the instance of the containing class. Should be null if not a member class.

Returns:

A new instance of the class.

newBean

public final <T> T newBean(Class<T> c)
                    throws BeanRuntimeException

Creates a new empty bean of the specified type, except used for instantiating inner member classes that must be instantiated within another class instance.

Example:

// Construct a new instance of the specified bean class Person p = BeanContext.DEFAULT.newBean(Person.class);

Type Parameters:

T - The class type of the bean being created.

Parameters:

c - The class type of the bean being created.

Returns:

A new bean object.

Throws:

BeanRuntimeException - If the specified class is not a valid bean.

newBean

public final <T> T newBean(Object outer,
                           Class<T> c)
                    throws BeanRuntimeException

Same as newBean(Class), except used for instantiating inner member classes that must be instantiated within another class instance.

Type Parameters:

T - The class type of the bean being created.

Parameters:

c - The class type of the bean being created.

outer - If class is a member class, this is the instance of the containing class. Should be null if not a member class.

Returns:

A new bean object.

Throws:

BeanRuntimeException - If the specified class is not a valid bean.

getBeanMeta

public final <T> BeanMeta<T> getBeanMeta(Class<T> c)

Returns the BeanMeta class for the specified class.

Type Parameters:

T - The class type to get the meta-data on.

Parameters:

c - The class to get the meta-data on.

Returns:

The BeanMeta for the specified class, or null if the class is not a bean per the settings on this context.

getClassMeta

public final <T> ClassMeta<T> getClassMeta(Class<T> c)

Returns a ClassMeta wrapper around a Class object.

Type Parameters:

T - The class type being wrapped.

Parameters:

c - The class being wrapped.

Returns:

The class meta object containing information about the class.

getClassMeta

public final <T> ClassMeta<T> getClassMeta(Type type,
                                           Type... args)

Used to resolve ClassMetas of type Collection and Map that have ClassMeta values that themselves could be collections or maps.

Collection meta objects are assumed to be followed by zero or one meta objects indicating the element type.

Map meta objects are assumed to be followed by zero or two meta objects indicating the key and value types.

The array can be arbitrarily long to indicate arbitrarily complex data structures.

Examples:

• getClassMeta(String.class); - A normal type.
• getClassMeta(List.class); - A list containing objects.
• getClassMeta(List.class, String.class); - A list containing strings.
• getClassMeta(LinkedList.class, String.class); - A linked-list containing strings.
• getClassMeta(LinkedList.class, LinkedList.class, String.class); - A linked-list containing linked-lists of strings.
• getClassMeta(Map.class); - A map containing object keys/values.
• getClassMeta(Map.class, String.class, String.class); - A map containing string keys/values.
• getClassMeta(Map.class, String.class, List.class, MyBean.class); - A map containing string keys and values of lists containing beans.

Parameters:

type - The class to resolve.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType

args - The type arguments of the class if it's a collection or map.
Can be any of the following: ClassMeta, Class, ParameterizedType, GenericArrayType
Ignored if the main type is not a map or collection.

Returns:

The class meta.

getArgsClassMeta

protected final ClassMeta<Object[]> getArgsClassMeta(Type[] classes)

Given an array of Type objects, returns a ClassMeta representing those arguments.

Constructs a new meta on each call.

Parameters:

classes - The array of classes to get class metas for.

Returns:

The args ClassMeta object corresponding to the classes. Never null.

getClassMetaForObject

public final <T> ClassMeta<T> getClassMetaForObject(T o)

Shortcut for calling getClassMeta(o.getClass()).

Type Parameters:

T - The class of the object being passed in.

Parameters:

o - The class to find the class type for.

Returns:

The ClassMeta object, or null if o is null.

getClassMetaForObject

protected final ClassMeta<?> getClassMetaForObject(Object o,
                                                   ClassMeta<?> def)

Shortcut for calling getClassMeta(o.getClass()) but returns a default value if object is null.

Parameters:

o - The class to find the class type for.

def - The default ClassMeta if the object is null.

Returns:

The ClassMeta object, or the default value if o is null.

getBeanTypePropertyName

public final String getBeanTypePropertyName(ClassMeta cm)

Returns the type property name as defined by BeanContext.BEAN_beanTypePropertyName.

Parameters:

cm - The class meta of the type we're trying to resolve the type name for. Can be null.

Returns:

The type property name. Never null.

getBeanRegistry

protected final BeanRegistry getBeanRegistry()

Returns the bean registry defined in this bean context defined by BeanContext.BEAN_beanDictionary.

Returns:

The bean registry defined in this bean context. Never null.

getStringBuilder

protected final StringBuilder getStringBuilder()

Creates a reusable StringBuilder object from an internal pool.

String builders are returned to the pool by calling returnStringBuilder(StringBuilder).

Returns:

A new or previously returned string builder.

returnStringBuilder

protected final void returnStringBuilder(StringBuilder sb)

Returns a StringBuilder object back into the internal reuse pool.

Parameters:

sb - The string builder to return to the pool. No-op if null.

object

public final ClassMeta<Object> object()

Returns a reusable ClassMeta representation for the class Object.

This ClassMeta is often used to represent "any object type" when an object type is not known.

This method is identical to calling getClassMeta(Object.class) but uses a cached copy to avoid a hashmap lookup.

Returns:

The ClassMeta object associated with the Object class.

string

public final ClassMeta<String> string()

Returns a reusable ClassMeta representation for the class String.

This ClassMeta is often used to represent key types in maps.

This method is identical to calling getClassMeta(String.class) but uses a cached copy to avoid a hashmap lookup.

Returns:

The ClassMeta object associated with the String class.

_class

public final ClassMeta<Class> _class()

Returns a reusable ClassMeta representation for the class Class.

This ClassMeta is often used to represent key types in maps.

This method is identical to calling getClassMeta(Class.class) but uses a cached copy to avoid a hashmap lookup.

Returns:

The ClassMeta object associated with the String class.

getBeanClassVisibility

protected final Visibility getBeanClassVisibility()

Configuration property: Minimum bean class visibility.

Returns:

Classes are not considered beans unless they meet the minimum visibility requirements.

See Also:

BeanContext.BEAN_beanClassVisibility

getBeanConstructorVisibility

protected final Visibility getBeanConstructorVisibility()

Configuration property: Minimum bean constructor visibility.

Returns:

Only look for constructors with this specified minimum visibility.

See Also:

BeanContext.BEAN_beanConstructorVisibility

getBeanDictionaryClasses

protected final List<Class<?>> getBeanDictionaryClasses()

Configuration property: Bean dictionary.

Returns:

The list of classes that make up the bean dictionary in this bean context.

See Also:

BeanContext.BEAN_beanDictionary

getBeanFieldVisibility

protected final Visibility getBeanFieldVisibility()

Configuration property: Minimum bean field visibility.

Returns:

Only look for bean fields with this specified minimum visibility.

See Also:

BeanContext.BEAN_beanFieldVisibility

getBeanFilters

protected BeanFilter[] getBeanFilters()

Configuration property: Bean filters.

Returns:

Only look for bean fields with this specified minimum visibility.

See Also:

BeanContext.BEAN_beanFilters

isBeanMapPutReturnsOldValue

protected final boolean isBeanMapPutReturnsOldValue()

Configuration property: BeanMap.put() returns old property value.

Returns:

true if the BeanMap.put() method will return old property values.
Otherwise, it returns null.

See Also:

BeanContext.BEAN_beanMapPutReturnsOldValue

getBeanMethodVisibility

protected final Visibility getBeanMethodVisibility()

Configuration property: Minimum bean method visibility.

Returns:

Only look for bean methods with this specified minimum visibility.

See Also:

BeanContext.BEAN_beanMethodVisibility

isBeansRequireDefaultConstructor

protected final boolean isBeansRequireDefaultConstructor()

Configuration property: Beans require no-arg constructors.

Returns:

true if 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

isBeansRequireSerializable

protected final boolean isBeansRequireSerializable()

Configuration property: Beans require Serializable interface.

Returns:

true if 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

isBeansRequireSettersForGetters

protected final boolean isBeansRequireSettersForGetters()

Configuration property: Beans require setters for getters.

Returns:

true if only getters that have equivalent setters will be considered as properties on a bean.
Otherwise, they are ignored.

See Also:

BeanContext.BEAN_beansRequireSettersForGetters

isBeansRequireSomeProperties

protected final boolean isBeansRequireSomeProperties()

Configuration property: Beans require at least one property.

Returns:

true if a Java class must contain at least 1 property to be considered a bean.
Otherwise, the bean is serialized as a string using the Object.toString() method.

See Also:

BeanContext.BEAN_beansRequireSomeProperties

getBeanTypePropertyName

protected final String getBeanTypePropertyName()

Configuration property: Bean type property name.

Returns:

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

getBpi

protected final Map<String,Set<String>> getBpi()

Configuration property: Bean property includes.

Returns:

Include properties keyed by class name.

See Also:

BeanContext.BEAN_bpi

getBpx

protected final Map<String,Set<String>> getBpx()

Configuration property: Bean property excludes.

Returns:

The list of property names to exclude keyed by class name.

See Also:

BeanContext.BEAN_bpx

getBpro

protected final Map<String,Set<String>> getBpro()

Configuration property: Read-only bean properties.

Returns:

The list of read-only property names keyed by class name.

See Also:

BeanContext.BEAN_bpro

getBpwo

protected final Map<String,Set<String>> getBpwo()

Configuration property: Write-only bean properties.

Returns:

The list of write-only property names keyed by class name.

See Also:

BeanContext.BEAN_bpwo

isDebug

protected final boolean isDebug()

Configuration property: Debug mode.

Returns:

true if debug mode is enabled.

See Also:

BeanContext.BEAN_debug

getExamples

protected final Map<String,?> getExamples()

Configuration property: POJO examples.

Returns:

A map of POJO examples keyed by class name.

See Also:

BeanContext.BEAN_examples

isFluentSetters

protected final boolean isFluentSetters()

Configuration property: Find fluent setters.

Description:

Returns:

true if fluent setters are detected on beans.

See Also:

BeanContext.BEAN_fluentSetters

isIgnoreInvocationExceptionsOnGetters

protected final boolean isIgnoreInvocationExceptionsOnGetters()

Configuration property: Ignore invocation errors on getters.

Returns:

true if errors thrown when calling bean getter methods are silently ignored.

See Also:

BeanContext.BEAN_ignoreInvocationExceptionsOnGetters

isIgnoreInvocationExceptionsOnSetters

protected final boolean isIgnoreInvocationExceptionsOnSetters()

Configuration property: Ignore invocation errors on setters.

Returns:

true if errors thrown when calling bean setter methods are silently ignored.

See Also:

BeanContext.BEAN_ignoreInvocationExceptionsOnSetters

isIgnorePropertiesWithoutSetters

protected final boolean isIgnorePropertiesWithoutSetters()

Configuration property: Ignore properties without setters.
Otherwise, a RuntimeException is thrown.

Returns:

true if trying to set a value on a bean property without a setter is silently ignored.

See Also:

BeanContext.BEAN_ignorePropertiesWithoutSetters

isIgnoreUnknownBeanProperties

protected final boolean isIgnoreUnknownBeanProperties()

Configuration property: Ignore unknown properties.

Returns:

true if trying to set a value on a non-existent bean property is silently ignored.
Otherwise, a RuntimeException is thrown.

See Also:

BeanContext.BEAN_ignoreUnknownBeanProperties

isIgnoreUnknownNullBeanProperties

protected final boolean isIgnoreUnknownNullBeanProperties()

Configuration property: Ignore unknown properties with null values.

Returns:

true if trying to set a null value on a non-existent bean property is silently ignored.

See Also:

BeanContext.BEAN_ignoreUnknownNullBeanProperties

getImplClasses

protected final Map<String,ClassInfo> getImplClasses()

Configuration property: Implementation classes.

Returns:

Implementation classes keyed by interface class names.

See Also:

BeanContext.BEAN_implClasses

getLocale

public final Locale getLocale()

Configuration property: Locale.

The locale is determined in the following order:

1. locale parameter passed in through constructor.
2. BeanContext.BEAN_locale entry in parameter passed in through constructor.
3. BeanContext.BEAN_locale setting on bean context.
4. Locale returned by Locale.getDefault().

Returns:

The session locale.

See Also:

BeanContext.BEAN_locale

getMediaType

public final MediaType getMediaType()

Configuration property: Media type.

For example, "application/json".

Returns:

The media type for this session, or null if not specified.

See Also:

BeanContext.BEAN_mediaType

getNotBeanClasses

protected final Class<?>[] getNotBeanClasses()

Configuration property: Bean class exclusions.

Returns:

The list of classes that are explicitly not beans.

See Also:

BeanContext.BEAN_notBeanClasses

getNotBeanPackagesNames

protected final String[] getNotBeanPackagesNames()

Configuration property: Bean package exclusions.

Returns:

The list of fully-qualified package names to exclude from being classified as beans.

See Also:

BeanContext.BEAN_notBeanPackages

getNotBeanPackagesPrefixes

protected final String[] getNotBeanPackagesPrefixes()

Configuration property: Bean package exclusions.

Returns:

The list of package name prefixes to exclude from being classified as beans.

See Also:

BeanContext.BEAN_notBeanPackages

getPojoSwaps

protected final PojoSwap<?,?>[] getPojoSwaps()

Configuration property: POJO swaps.

Returns:

The list POJO swaps defined.

See Also:

BeanContext.BEAN_pojoSwaps

getPropertyNamer

protected final PropertyNamer getPropertyNamer()

Configuration property: Bean property namer.

Returns:

The interface used to calculate bean property names.

See Also:

BeanContext.BEAN_propertyNamer

isSortProperties

protected final boolean isSortProperties()

Configuration property: Sort bean properties.

Returns:

true if all bean properties will be serialized and access in alphabetical order.

See Also:

BeanContext.BEAN_sortProperties

getTimeZone

public final TimeZone getTimeZone()

Configuration property: Time zone.

The timezone is determined in the following order:

1. timeZone parameter passed in through constructor.
2. BeanContext.BEAN_timeZone entry in parameter passed in through constructor.
3. BeanContext.BEAN_timeZone setting on bean context.

Returns:

The session timezone, or null if timezone not specified.

See Also:

BeanContext.BEAN_timeZone

getTimeZoneId

public final ZoneId getTimeZoneId()

Configuration property: Time zone.

The timezone is determined in the following order:

1. timeZone parameter passed in through constructor.
2. BeanContext.BEAN_timeZone entry in parameter passed in through constructor.
3. BeanContext.BEAN_timeZone setting on bean context.

Returns:

The session timezone, or the system timezone if not specified. Never null.

See Also:

BeanContext.BEAN_timeZone

isUseEnumNames

protected final boolean isUseEnumNames()

Configuration property: Use enum names.

Returns:

true if enums are always serialized by name, not using Object.toString().

See Also:

BeanContext.BEAN_useEnumNames

isUseInterfaceProxies

protected final boolean isUseInterfaceProxies()

Configuration property: Use interface proxies.

Returns:

true if 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

isUseJavaBeanIntrospector

protected final boolean isUseJavaBeanIntrospector()

Configuration property: Use Java Introspector.

Returns:

true if the built-in Java bean introspector should be used for bean introspection.

See Also:

BeanContext.BEAN_useJavaBeanIntrospector

getSchema

public final HttpPartSchema getSchema()

HTTP part schema of object being serialized or parsed.

Returns:

HTTP part schema of object being serialized or parsed, or null if not specified.

checkForWarnings

public void checkForWarnings()

Description copied from class: Session

Throws a BeanRuntimeException if any warnings occurred in this session.

Overrides:

checkForWarnings in class Session

toMap

public ObjectMap toMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class Session

Returns:

A new map containing the properties defined on this context.