BeanSession (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.Session
- - org.apache.juneau.BeanSession

Direct Known Subclasses:

ParserSession, RestCall, SerializerSession
```
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.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClassMeta<Class>`	`_class()` Returns a reusable `ClassMeta` representation for the class `Class`.
`ObjectMap`	`asMap()` Returns the properties defined on this bean context as a simple map for debugging purposes.
`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.
`<T> T`	`convertToMemberType(Object outer, Object value, ClassMeta<T> type)` 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.
`ClassMeta<Object[]>`	`getArgsClassMeta(Type[] classes)` Given an array of `Type` objects, returns a `ClassMeta` representing those arguments.
`<T> BeanMeta<T>`	`getBeanMeta(Class<T> c)` Returns the `BeanMeta` class for the specified class.
`BeanRegistry`	`getBeanRegistry()` Returns the bean registry defined in this bean context defined by `BeanContext.BEAN_beanDictionary`.
`String`	`getBeanTypePropertyName(ClassMeta cm)` Returns the type property name as defined by `BeanContext.BEAN_beanTypePropertyName`.
`<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.
`<T> ClassMeta<T>`	`getClassMetaForObject(T o)` Shortcut for calling `getClassMeta(o.getClass())`.
`Locale`	`getLocale()` Returns the locale defined on this session.
`MediaType`	`getMediaType()` Returns the media type specified for this session.
`StringBuilder`	`getStringBuilder()` Creates a reusable `StringBuilder` object from an internal pool.
`TimeZone`	`getTimeZone()` Returns the timezone defined on this session.
`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.
`boolean`	`isDebug()` Returns the `BeanContext.BEAN_debug` setting value for this session.
`boolean`	`isIgnoreUnknownBeanProperties()` Bean property getter: ignoreUnknownBeanProperties.
`<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 (i.e.
`<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.
`<T> T`	`newInstance(Class<T> c, Object c2)` Creates an instance of the specified class.
`<T> T`	`newInstance(Class<T> c, Object c2, boolean fuzzyArgs, Object... args)` Creates an instance of the specified class.
`<T> T`	`newInstanceFromOuter(Object outer, Class<T> c, Object c2, boolean fuzzyArgs, Object... args)` Creates an instance of the specified class from within the context of another object.
`ClassMeta<Object>`	`object()` Returns a reusable `ClassMeta` representation for the class `Object`.
`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`.
`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 (i.e.
`<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.

Methods inherited from class org.apache.juneau.Session
addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, 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

asMap
```
public ObjectMap asMap()
```
Description copied from class: Session

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

Overrides:

asMap in class Session

Returns:

A new map containing the properties defined on this context.

getLocale
```
public final Locale getLocale()
```
Returns the locale defined on this session.
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.

getTimeZone
```
public final TimeZone getTimeZone()
```
Returns the timezone defined on this session.
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.

isDebug
```
public final boolean isDebug()
```
Returns the BeanContext.BEAN_debug setting value for this session.

Returns:

The BeanContext.BEAN_debug setting value for this session.

isIgnoreUnknownBeanProperties
```
public final boolean isIgnoreUnknownBeanProperties()
```
Bean property getter: ignoreUnknownBeanProperties.
See BeanContext.BEAN_ignoreUnknownBeanProperties.

Returns:

The value of the ignoreUnknownBeanProperties property on this bean.

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
```
public final <T> T convertToMemberType(Object outer,
                                       Object value,
                                       ClassMeta<T> type)
                                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.

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.

toArray
```
public 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 (i.e. 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 (i.e. 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
```
public 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.

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
```
public 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.

newInstance
```
public <T> T newInstance(Class<T> c,
                         Object c2)
```
Creates an instance of the specified class.

Parameters:

c - The class to cast to.

c2 - The class to instantiate. Can also be an instance of the class.

Returns:

The new class instance, or null if the class was null or is abstract or an interface.

Throws:

RuntimeException - if constructor could not be found or called.

newInstance
```
public <T> T newInstance(Class<T> c,
                         Object c2,
                         boolean fuzzyArgs,
                         Object... args)
```
Creates an instance of the specified class.

Parameters:

c - The class to cast to.

c2 - The class to instantiate. Can also be an instance of the class.

fuzzyArgs - Use fuzzy constructor arg matching.
When true, constructor args can be in any order and extra args are ignored.
No-arg constructors are also used if no other constructors are found.

args - The arguments to pass to the constructor.

Returns:

The new class instance, or null if the class was null or is abstract or an interface.

Throws:

RuntimeException - if constructor could not be found or called.

newInstanceFromOuter
```
public <T> T newInstanceFromOuter(Object outer,
                                  Class<T> c,
                                  Object c2,
                                  boolean fuzzyArgs,
                                  Object... args)
```
Creates an instance of the specified class from within the context of another object.

Parameters:

outer - The outer object. Can be null.

c - The class to cast to.

c2 - The class to instantiate. Can also be an instance of the class.

fuzzyArgs - Use fuzzy constructor arg matching.
When true, constructor args can be in any order and extra args are ignored.
No-arg constructors are also used if no other constructors are found.

args - The arguments to pass to the constructor.

Returns:

The new class instance, or null if the class was null or is abstract or an interface.

Throws:

RuntimeException - if constructor could not be found or called.

getStringBuilder
```
public 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
```
public 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.

getMediaType
```
public final MediaType getMediaType()
```
Returns the media type specified for this session.
For example, "application/json".

Returns:

The media type for this session, 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

Class BeanSession

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.Session

Methods inherited from class java.lang.Object

Constructor Detail

BeanSession

Method Detail

asMap

getLocale

getTimeZone

isDebug

isIgnoreUnknownBeanProperties

convertToType

convertToMemberType

convertToType

convertToType

convertToMemberType

toArray

toBeanMap

Example:

isBean

isBean

toBeanMap

Example:

newBeanMap

Example:

newBeanMap

newBean

Example:

newBean

getBeanMeta

getClassMeta

getClassMeta

Examples:

getArgsClassMeta

getClassMetaForObject

getBeanTypePropertyName

getBeanRegistry

newInstance

newInstance

newInstanceFromOuter

getStringBuilder

returnStringBuilder

object

string

_class

getMediaType

checkForWarnings