org.apache.juneau

Class BeanContext

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

Direct Known Subclasses:

Parser, ParserGroup, RestClient, RestContext, Serializer, SerializerGroup

public class BeanContext
extends Context

Core class of the Juneau architecture.

This class servers multiple purposes:

• Provides the ability to wrap beans inside Map interfaces.
• Serves as a repository for metadata on POJOs, such as associated BeanFilters, PropertyNamers, etc... which are used to tailor how POJOs are serialized and parsed.

All serializers and parsers extend from this context so that they can handle POJOs using a common framework.

Bean Contexts

Bean contexts are created through the BeanContext.create() and BeanContextBuilder.build() methods.
These context objects are read-only, reusable, and thread-safe.

Each bean context maintains a cache of ClassMeta objects that describe information about classes encountered. These ClassMeta objects are time-consuming to construct. Therefore, instances of BeanContext that share the same "BeanContext.*" property values share the same cache. This allows for efficient reuse of ClassMeta objects so that the information about classes only needs to be calculated once. Because of this, many of the properties defined on the BeanContext class cannot be overridden on the session.

Bean Sessions

Whereas BeanContext objects are permanent, unchangeable, cached, and thread-safe, BeanSession objects are ephemeral and not thread-safe. They are meant to be used as quickly-constructed scratchpads for creating bean maps. BeanMap objects can only be created through the session.

BeanContext configuration properties

BeanContexts have several configuration properties that can be used to tweak behavior on how beans are handled. These are denoted as the static BEAN_* fields on this class.

Some settings (e.g. BEAN_beansRequireDefaultConstructor) are used to differentiate between bean and non-bean classes. Attempting to create a bean map around one of these objects will throw a BeanRuntimeException. The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to plain strings using the Object.toString() method.

Some settings (e.g. BEAN_beanFieldVisibility) are used to determine what kinds of properties are detected on beans.

Some settings (e.g. BEAN_beanMapPutReturnsOldValue) change the runtime behavior of bean maps.

Settings are specified using the BeanContextBuilder.set(String, Object) method and related convenience methods.

Example:

// Construct a context from scratch. BeanContext beanContext = BeanContext .create() .set(BeanContext.BEAN_beansRequireDefaultConstructor, true) .notBeanClasses(Foo.class) .build();

Bean Maps

BeanMaps are wrappers around Java beans that allow properties to be retrieved and set using the common Map.put(Object,Object) and Map.get(Object) methods.

Bean maps are created in two ways...

1. BeanSession.toBeanMap() - Wraps an existing bean inside a Map wrapper.
2. BeanSession.newBeanMap() - Create a new bean instance wrapped in a Map wrapper.

Example:

// A sample bean class public class Person { public String getName(); public void setName(String name); public int getAge(); public void setAge(int age); } // Create a new bean session BeanSession session = BeanContext.DEFAULT.createSession(); // Wrap an existing bean in a new bean map BeanMap<Person> m1 = session.toBeanMap(new Person()); m1.put("name", "John Smith"); m1.put("age", 45); // Create a new bean instance wrapped in a new bean map BeanMap<Person> m2 = session.newBeanMap(Person.class); m2.put("name", "John Smith"); m2.put("age", 45); Person p = m2.getBean(); // Get the bean instance that was created.

See Also:

• Overview > juneau-marshall > Contexts, Builders, Sessions, and PropertyStores

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_beanClassVisibility Configuration property: Minimum bean class visibility.
static String	BEAN_beanConstructorVisibility Configuration property: Minimum bean constructor visibility.
static String	BEAN_beanDictionary Configuration property: Bean dictionary.
static String	BEAN_beanDictionary_add Configuration property: Add to bean dictionary.
static String	BEAN_beanDictionary_remove Configuration property: Remove from bean dictionary.
static String	BEAN_beanFieldVisibility Configuration property: Minimum bean field visibility.
static String	BEAN_beanFilters Configuration property: Bean filters.
static String	BEAN_beanFilters_add Configuration property: Add to bean filters.
static String	BEAN_beanFilters_remove Configuration property: Remove from bean filters.
static String	BEAN_beanMapPutReturnsOldValue Configuration property: BeanMap.put() returns old property value.
static String	BEAN_beanMethodVisibility Configuration property: Minimum bean method visibility.
static String	BEAN_beansRequireDefaultConstructor Configuration property: Beans require no-arg constructors.
static String	BEAN_beansRequireSerializable Configuration property: Beans require Serializable interface.
static String	BEAN_beansRequireSettersForGetters Configuration property: Beans require setters for getters.
static String	BEAN_beansRequireSomeProperties Configuration property: Beans require at least one property.
static String	BEAN_beanTypePropertyName Configuration property: Bean type property name.
static String	BEAN_debug Configuration property: Debug mode.
static String	BEAN_excludeProperties Configuration property: Bean property excludes.
static String	BEAN_ignoreInvocationExceptionsOnGetters Configuration property: Ignore invocation errors on getters.
static String	BEAN_ignoreInvocationExceptionsOnSetters Configuration property: Ignore invocation errors on setters.
static String	BEAN_ignorePropertiesWithoutSetters Configuration property: Ignore properties without setters.
static String	BEAN_ignoreUnknownBeanProperties Configuration property: Ignore unknown properties.
static String	BEAN_ignoreUnknownNullBeanProperties Configuration property: Ignore unknown properties with null values.
static String	BEAN_implClasses Configuration property: Implementation classes.
static String	BEAN_includeProperties Configuration property: Bean property includes.
static String	BEAN_locale Configuration property: Locale.
static String	BEAN_mediaType Configuration property: Media type.
static String	BEAN_notBeanClasses Configuration property: Bean class exclusions.
static String	BEAN_notBeanClasses_add Configuration property: Add to classes that should not be considered beans.
static String	BEAN_notBeanClasses_remove Configuration property: Remove from classes that should not be considered beans.
static String	BEAN_notBeanPackages Configuration property: Bean package exclusions.
static String	BEAN_notBeanPackages_add Configuration property: Add to packages whose classes should not be considered beans.
static String	BEAN_notBeanPackages_remove Configuration property: Remove from packages whose classes should not be considered beans.
static String	BEAN_pojoSwaps Configuration property: POJO swaps.
static String	BEAN_pojoSwaps_add Configuration property: Add to POJO swap classes.
static String	BEAN_pojoSwaps_remove Configuration property: Remove from POJO swap classes.
static String	BEAN_propertyNamer Configuration property: Bean property namer.
static String	BEAN_sortProperties Configuration property: Sort bean properties.
static String	BEAN_timeZone Configuration property: TimeZone.
static String	BEAN_useInterfaceProxies Configuration property: Use interface proxies.
static String	BEAN_useJavaBeanIntrospector Configuration property: Use Java Introspector.
static BeanContext	DEFAULT Default config.
static BeanContext	DEFAULT_SORTED Default config.

Constructor Summary

Constructors

Constructor and Description
BeanContext(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
protected 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.
BeanContextBuilder	builder() Creates a builder from this context object.
static BeanContextBuilder	create() Instantiates a new clean-slate BeanContextBuilder object.
BeanSession	createBeanSession() Same as createSession() except always returns a BeanSession object unlike createSession() which is meant to be overridden by subclasses.
BeanSession	createBeanSession(BeanSessionArgs args) Same as createSession(BeanSessionArgs) except always returns a BeanSession object unlike createSession(BeanSessionArgs) which is meant to be overridden by subclasses.
BeanSessionArgs	createDefaultBeanSessionArgs() Same as createDefaultSessionArgs() except always returns a BeanSessionArgs unlike createDefaultBeanSessionArgs() which is meant to be overridden by subclasses.
BeanSessionArgs	createDefaultSessionArgs() Defines default session arguments used when calling the Context.createSession() method.
BeanSession	createSession() Create a new bean session based on the properties defined on this context.
BeanSession	createSession(BeanSessionArgs args) Create a new bean session based on the properties defined on this context combined with the specified runtime args.
Session	createSession(SessionArgs args) Create a new session based on the properties defined on this context combined with the specified runtime args.
protected static void	dumpCacheStats() Prints meta cache statistics to System.out.
<T> BeanMeta<T>	getBeanMeta(Class<T> c) Returns the BeanMeta class for the specified class.
protected BeanRegistry	getBeanRegistry() Returns the bean registry defined in this bean context defined by BEAN_beanDictionary.
protected String	getBeanTypePropertyName() Returns the type property name as defined by BEAN_beanTypePropertyName.
<T> ClassMeta<T>	getClassMeta(Class<T> type) Construct 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()).
String[]	getExcludeProperties(Class<?> c) Returns the BEAN_excludeProperties setting for the specified class.
protected <T> Constructor<? extends T>	getImplClassConstructor(Class<T> c, Visibility v) Gets the no-arg constructor for the specified class.
String[]	getIncludeProperties(Class<?> c) Returns the BEAN_includeProperties setting for the specified class.
boolean	hasSameCache(BeanContext bc) Returns true if the specified bean context shares the same cache as this bean context.
boolean	isBean(Object o) Returns true if the specified object is a bean.
protected boolean	isNotABean(Class<?> c) Determines whether the specified class is ignored as a bean class based on the various exclusion parameters specified on this context class.
<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.
protected ClassMeta<Object>	object() Returns a reusable ClassMeta representation for the class Object.
protected <T> ClassMeta<T>	resolveClassMeta(BeanProperty p, Type t, Map<Class<?>,Class<?>[]> typeVarImpls) Used for determining the class type on a method or field where a @BeanProperty annotation may be present.
protected ClassMeta<String>	string() Returns a reusable ClassMeta representation for the class String.

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BEAN_beanClassVisibility

public static final String BEAN_beanClassVisibility

Configuration property: Minimum bean class visibility.

Property:

• Name: "BeanContext.beanClassVisibility.s"
• Data type: String (Visibility)
• Default: "PUBLIC"
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanClassVisibility(Visibility)

Description:

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 be serialized as a string.
Use this setting to reduce the visibility requirement.

Example:

// Create a serializer that serializes protected classes. WriterSerializer s = JsonSerializer .create() .beanClassVisibility(PROTECTED) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanClassVisibility, "PROTECTED") .build();

See Also:

Constant Field Values

BEAN_beanConstructorVisibility

public static final String BEAN_beanConstructorVisibility

Configuration property: Minimum bean constructor visibility.

Property:

• Name: "BeanContext.beanConstructorVisibility.s"
• Data type: String (Visibility)
• Default: "PUBLIC"
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanConstructorVisibility(Visibility)

Description:

Only look for constructors with the specified minimum visibility.

This setting affects the logic for finding no-arg constructors for bean.
Normally, only public no-arg constructors are used.
Use this setting if you want to reduce the visibility requirement.

Example:

// Create a serializer that looks for protected no-arg constructors. WriterSerializer s = JsonSerializer .create() .beanConstructorVisibility(PROTECTED) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanConstructorVisibility, "PROTECTED") .build();

See Also:

Constant Field Values

BEAN_beanDictionary

public static final String BEAN_beanDictionary

Configuration property: Bean dictionary.

Property:

• Name: "BeanContext.beanDictionary.lc"
• Data type: List<Class>
• Default: empty list
• Session-overridable: false
• Annotations:
  • Bean.beanDictionary()
  • BeanProperty.beanDictionary()
• Methods:
  • BeanContextBuilder.beanDictionary(Object...)
  • BeanContextBuilder.beanDictionary(Class...)
  • BeanContextBuilder.beanDictionary(boolean,Object...)
  • BeanContextBuilder.beanDictionaryRemove(Object...)
  • BeanFilterBuilder.beanDictionary(Class...)

Description:

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

A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection.
The names are defined through the @Bean.typeName() annotation defined on the bean class.
For example, if a class Foo has a type-name of "myfoo", then it would end up serialized as "{_type:'myfoo',...}".

This setting tells the parsers which classes to look for when resolving "_type" attributes.

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.

Example:

// Create a parser and tell it which classes to try to resolve. ReaderParser p = JsonParser .create() .beanDictionary(Foo.class, Bar.class) .build(); // Same, but use property. ReaderParser p = JsonParser .create() .addTo(BEAN_beanDictionary, Foo.class) .addTo(BEAN_beanDictionary, Bar.class) .build(); // Instead of by parser, define a bean dictionary on a class through an annotation. // This applies to all properties on this class and all subclasses. @Bean(beanDictionary={Foo.class,Bar.class}) public class MyBean {...} // Use the predefined HTML5 bean dictionary which is a BeanDictionaryList. ReaderParser p = HtmlParser .create() .beanDictionary(HtmlBeanDictionary.class) .build();

See Also:

• Overview > juneau-marshall > Bean Names and Dictionaries

See Also:

Constant Field Values

BEAN_beanDictionary_add

public static final String BEAN_beanDictionary_add

Configuration property: Add to bean dictionary.

See Also:

Constant Field Values

BEAN_beanDictionary_remove

public static final String BEAN_beanDictionary_remove

Configuration property: Remove from bean dictionary.

See Also:

Constant Field Values

BEAN_beanFieldVisibility

public static final String BEAN_beanFieldVisibility

Configuration property: Minimum bean field visibility.

Property:

• Name: "BeanContext.beanFieldVisibility.s"
• Data type: String (Visibility)
• Default: "PUBLIC"
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanFieldVisibility(Visibility)

Description:

Only look for bean fields with the specified minimum visibility.

This affects which fields on a bean class are considered bean properties.
Normally only public fields are considered.
Use this setting if you want to reduce the visibility requirement.

Example:

// Create a serializer that looks for protected fields. WriterSerializer s = JsonSerializer .create() .beanFieldVisibility(PROTECTED) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanFieldVisibility, "PROTECTED") .build(); // Disable using fields as properties entirely. WriterSerializer s = JsonSerializer .create() .beanFieldVisibility(NONE) .build();

See Also:

Constant Field Values

BEAN_beanFilters

public static final String BEAN_beanFilters

Configuration property: Bean filters.

Property:

• Name: "BeanContext.beanFilters.lc"
• Data type: List<Class>
• Default: empty list
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanFilters(Object...)
  • BeanContextBuilder.beanFilters(Class...)
  • BeanContextBuilder.beanFilters(boolean,Object...)
  • BeanContextBuilder.beanFiltersRemove(Object...)

Description:

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.

Values can consist of any of the following types:

• Any subclass of BeanFilterBuilder.
  These must have a public no-arg constructor.
• Any bean interfaces.
  A shortcut for defining a InterfaceBeanFilterBuilder.
  Any subclasses of an interface class will only have properties defined on the interface. All other bean properties will be ignored.
• Any array or collection of the objects above.

Example:

// Create a bean filter for the MyBean class. public class MyBeanFilter extends BeanFilterBuilder<MyBean> { // Must provide a no-arg constructor! public MyBeanFilter() { includeProperties("foo,bar,baz"); // The properties we want exposed. } } // Associate our bean filter with a serializer. WriterSerializer s = JsonSerializer .create() .beanFilters(MyBeanFilter.class) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_beanFilters, MyBeanFilter.class) .build();

See Also:

• Overview > juneau-marshall > BeanFilters
• Overview > juneau-marshall > Interface Filters

See Also:

Constant Field Values

BEAN_beanFilters_add

public static final String BEAN_beanFilters_add

Configuration property: Add to bean filters.

See Also:

Constant Field Values

BEAN_beanFilters_remove

public static final String BEAN_beanFilters_remove

Configuration property: Remove from bean filters.

See Also:

Constant Field Values

BEAN_beanMapPutReturnsOldValue

public static final String BEAN_beanMapPutReturnsOldValue

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

Property:

• Name: "BeanContext.beanMapPutReturnsOldValue.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanMapPutReturnsOldValue(boolean)
  • BeanContextBuilder.beanMapPutReturnsOldValue()

Description:

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

Disabled by default because it introduces a slight performance penalty during serialization.

Example:

// Create a serializer that creates BeanMaps with normal put() behavior. WriterSerializer s = JsonSerializer .create() .beanMapPutReturnsOldValue() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanMapPutReturnsOldValue, true) .build(); BeanMap<MyBean> bm = s.createSession().toBeanMap(new MyBean()); bm.put("foo", "bar"); Object oldValue = bm.put("foo", "baz"); // oldValue == "bar"

See Also:

Constant Field Values

BEAN_beanMethodVisibility

public static final String BEAN_beanMethodVisibility

Configuration property: Minimum bean method visibility.

Property:

• Name: "BeanContext.beanMethodVisibility.s"
• Data type: String (Visibility)
• Default: "PUBLIC"
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beanMethodVisibility(Visibility)

Description:

Only look for bean methods with the specified minimum visibility.

This affects which methods are detected as getters and setters on a bean class.
Normally only public getters and setters are considered.
Use this setting if you want to reduce the visibility requirement.

Example:

// Create a serializer that looks for protected getters and setters. WriterSerializer s = JsonSerializer .create() .beanMethodVisibility(PROTECTED) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanMethodVisibility, "PROTECTED") .build();

See Also:

Constant Field Values

BEAN_beansRequireDefaultConstructor

public static final String BEAN_beansRequireDefaultConstructor

Configuration property: Beans require no-arg constructors.

Property:

• Name: "BeanContext.beansRequireDefaultConstructor.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beansRequireDefaultConstructor(boolean)
  • BeanContextBuilder.beansRequireDefaultConstructor()

Description:

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.

The @Bean annotation can be used on a class to override this setting when true.

Example:

// Create a serializer that ignores beans without default constructors. WriterSerializer s = JsonSerializer .create() .beansRequireDefaultConstructor() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beansRequireDefaultConstructor, true) .build();

See Also:

Constant Field Values

BEAN_beansRequireSerializable

public static final String BEAN_beansRequireSerializable

Configuration property: Beans require Serializable interface.

Property:

• Name: "BeanContext.beansRequireSerializable.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beansRequireSerializable(boolean)
  • BeanContextBuilder.beansRequireSerializable()

Description:

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.

The @Bean annotation can be used on a class to override this setting when true.

Example:

// Create a serializer that ignores beans not implementing Serializable. WriterSerializer s = JsonSerializer .create() .beansRequireSerializable() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beansRequireSerializable, true) .build();

See Also:

Constant Field Values

BEAN_beansRequireSettersForGetters

public static final String BEAN_beansRequireSettersForGetters

Configuration property: Beans require setters for getters.

Property:

• Name: "BeanContext.beansRequireSettersForGetters.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beansRequireSettersForGetters(boolean)
  • BeanContextBuilder.beansRequireSettersForGetters()

Description:

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

Example:

// Create a serializer that ignores bean properties without setters. WriterSerializer s = JsonSerializer .create() .beansRequireSettersForGetter() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beansRequireSettersForGetters, true) .build();

See Also:

Constant Field Values

BEAN_beansRequireSomeProperties

public static final String BEAN_beansRequireSomeProperties

Configuration property: Beans require at least one property.

Property:

• Name: "BeanContext.beansRequireSomeProperties.b"
• Data type: Boolean
• Default: true
• Session-overridable: false
• Methods:
  • BeanContextBuilder.beansRequireSomeProperties(boolean)

Description:

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.

The @Bean annotation can be used on a class to override this setting when true.

Example:

// Create a serializer that serializes beans even if they have zero properties. WriterSerializer s = JsonSerializer .create() .beansRequireSomeProperties(false) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beansRequireSomeProperties, false) .build();

See Also:

Constant Field Values

BEAN_beanTypePropertyName

public static final String BEAN_beanTypePropertyName

Configuration property: Bean type property name.

Property:

• Name: "BeanContext.beanTypePropertyName.s"
• Data type: String
• Default: "_type"
• Session-overridable: false
• Annotations:
  • Bean.typePropertyName()
• Methods:
  • BeanContextBuilder.beanTypePropertyName(String)

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.

Example:

// Create a serializer that uses 'type' instead of '_type' for dictionary names. WriterSerializer s = JsonSerializer .create() .beanTypePropertyName("type") .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_beanTypePropertyName, "type") .build();

See Also:

• Overview > juneau-marshall > Bean Names and Dictionaries

See Also:

Constant Field Values

BEAN_debug

public static final String BEAN_debug

Configuration property: Debug mode.

Property:

• Name: "BeanContext.debug.b"
• Data type: Boolean
• Default: false
• Session-overridable: true
• Methods:
  • BeanContextBuilder.debug(boolean)
  • BeanContextBuilder.debug()

Description:

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.

Enables the following additional information during parsing:

• When bean setters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.

Example:

// Create a serializer with debug enabled. WriterSerializer s = JsonSerializer .create() .debug() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_debug, true) .build();

See Also:

Constant Field Values

BEAN_excludeProperties

public static final String BEAN_excludeProperties

Configuration property: Bean property excludes.

Property:

• Name: "BeanContext.excludeProperties.sms"
• Data type: Map<String,String>
• Default: {}
• Session-overridable: false
• Annotations:
  • Bean.excludeProperties()
• Methods:
  • BeanContextBuilder.excludeProperties(Class, String)
  • BeanContextBuilder.excludeProperties(String, String)
  • BeanContextBuilder.excludeProperties(Map)
  • BeanFilterBuilder.excludeProperties(String...)

Description:

Specifies to exclude the specified list of properties for the specified bean class.

The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property names. The key "*" means all bean classes.

For example, {Bean1:'foo,bar'} means don't serialize the foo and bar properties on any beans whose simple class name is Bean1.

Setting applies to specified class and all subclasses.

Example:

// Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class. WriterSerializer s = JsonSerializer .create() .excludeProperties(MyBean.class, "foo,bar") .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_excludeProperties, MyBean.class.getName(), "foo,bar") .build(); // Alternate using JSON object. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_excludeProperties, "{'org.apache.MyBean':'foo,bar'}") .build();

See Also:

Constant Field Values

BEAN_ignoreInvocationExceptionsOnGetters

public static final String BEAN_ignoreInvocationExceptionsOnGetters

Configuration property: Ignore invocation errors on getters.

Property:

• Name: "BeanContext.ignoreInvocationExceptionsOnGetters.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.ignoreInvocationExceptionsOnGetters(boolean)
  • BeanContextBuilder.ignoreInvocationExceptionsOnGetters()

Description:

If true, errors thrown when calling bean getter methods will silently be ignored.
Otherwise, a BeanRuntimeException is thrown.

Example:

// Create a serializer that ignores bean getter exceptions. WriterSerializer s = JsonSerializer .create() .ingoreInvocationExceptionsOnGetters() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_ignoreInvocationExceptionsOnGetters, true) .build();

See Also:

Constant Field Values

BEAN_ignoreInvocationExceptionsOnSetters

public static final String BEAN_ignoreInvocationExceptionsOnSetters

Configuration property: Ignore invocation errors on setters.

Property:

• Name: "BeanContext.ignoreInvocationExceptionsOnSetters.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.ignoreInvocationExceptionsOnSetters(boolean)
  • BeanContextBuilder.ignoreInvocationExceptionsOnSetters()

Description:

If true, errors thrown when calling bean setter methods will silently be ignored.
Otherwise, a BeanRuntimeException is thrown.

Example:

// Create a parser that ignores bean setter exceptions. ReaderParser p = JsonParser .create() .ignoreInvocationExceptionsOnSetters() .build(); // Same, but use property. ReaderParser p = JsonParser .create() .set(BEAN_ignoreInvocationExceptionsOnSetters, true) .build();

See Also:

Constant Field Values

BEAN_ignorePropertiesWithoutSetters

public static final String BEAN_ignorePropertiesWithoutSetters

Configuration property: Ignore properties without setters.

Property:

• Name: "BeanContext.ignorePropertiesWithoutSetters.b"
• Data type: Boolean
• Default: true
• Session-overridable: false
• Methods:
  • BeanContextBuilder.ignorePropertiesWithoutSetters(boolean)

Description:

If true, trying to set a value on a bean property without a setter will silently be ignored.
Otherwise, a RuntimeException is thrown.

Example:

// Create a parser that throws an exception if a setter is not found but a getter is. ReaderParser p = JsonParser .create() .ignorePropertiesWithoutSetters(false) .build(); // Same, but use property. ReaderParser p = JsonParser .create() .set(BEAN_ignorePropertiesWithoutSetters, false) .build();

See Also:

Constant Field Values

BEAN_ignoreUnknownBeanProperties

public static final String BEAN_ignoreUnknownBeanProperties

Configuration property: Ignore unknown properties.

Property:

• Name: "BeanContext.ignoreUnknownBeanProperties.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.ignoreUnknownBeanProperties(boolean)
  • BeanContextBuilder.ignoreUnknownBeanProperties()

Description:

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

Example:

// Create a parser that ignores missing bean properties. ReaderParser p = JsonParser .create() .ignoreUnknownBeanProperties() .build(); // Same, but use property. ReaderParser p = JsonParser .create() .set(BEAN_ignoreUnknownBeanProperties, true) .build();

See Also:

Constant Field Values

BEAN_ignoreUnknownNullBeanProperties

public static final String BEAN_ignoreUnknownNullBeanProperties

Configuration property: Ignore unknown properties with null values.

Property:

• Name: "BeanContext.ignoreUnknownNullBeanProperties.b"
• Data type: Boolean
• Default: true
• Session-overridable: false
• Methods:
  • BeanContextBuilder.ignoreUnknownNullBeanProperties(boolean)

Description:

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

Example:

// Create a parser that throws an exception on an unknown property even if the value being set is null. ReaderParser p = JsonParser .create() .ignoreUnknownNullBeanProperties(false) .build(); // Same, but use property. ReaderParser p = JsonParser .create() .set(BEAN_ignoreUnknownNullBeanProperties, false) .build();

See Also:

Constant Field Values

BEAN_implClasses

public static final String BEAN_implClasses

Configuration property: Implementation classes.

Property:

• Name: "BeanContext.implClasses.smc"
• Data type: Map<String,Class>
• Default: empty map
• Session-overridable: false
• Methods:
  • BeanContextBuilder.implClasses(Map)
  • BeanContextBuilder.implClass(Class, Class)

Description:

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).

Example:

// Create a parser that instantiates MyBeanImpls when parsing MyBeanInterfaces. ReaderParser p = JsonParser .create() .implClass(MyBeanInterface.class, MyBeanImpl.class) .build(); // Same, but use property. ReaderParser p = JsonParser .create() .addTo(BEAN_implClasses, MyBeanInterface.class.getName(), MyBeanImpl.class) .build();

See Also:

Constant Field Values

BEAN_includeProperties

public static final String BEAN_includeProperties

Configuration property: Bean property includes.

Property:

• Name: "BeanContext.properties.sms"
• Data type: Map<String,String>
• Default: {}
• Session-overridable: false
• Annotations:
  • Bean.properties()
  • BeanProperty.properties()
• Methods:
  • BeanContextBuilder.includeProperties(Class, String)
  • BeanContextBuilder.includeProperties(String, String)
  • BeanContextBuilder.includeProperties(Map)
  • BeanFilterBuilder.properties(String...)

Description:

Specifies the set and order of names of properties associated with the bean class.

The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property names. The key "*" means all bean classes.

For example, {Bean1:'foo,bar'} means only serialize the foo and bar properties on the specified bean.

Setting applies to specified class and all subclasses.

Example:

// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class. WriterSerializer s = JsonSerializer .create() .includeProperties(MyBean.class, "foo,bar") .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_includeProperties, MyBean.class.getName(), "foo,bar") .build(); // Alternate using JSON object. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_includeProperties, "{'org.apache.MyBean':'foo,bar'}") .build();

See Also:

Constant Field Values

BEAN_locale

public static final String BEAN_locale

Configuration property: Locale.

Property:

• Name: "BeanContext.locale.s"
• Data type: String (Locale)
• Default: null (defaults to Locale.getDefault())
• Session-overridable: true
• Methods:
  • BeanContextBuilder.locale(Locale)
  • BeanSessionArgs.locale(Locale)

Example:

// Create a serializer that uses the specified locale if it's not passed in through session args. WriterSerializer s = JsonSerializer .create() .locale(Locale.UK) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_locale, Locale.UK) .build(); // Define on session-args instead. SerializerSessionArgs sessionArgs = new SerializerSessionArgs().locale(Locale.UK); try (WriterSerializerSession session = s.createSession(sessionArgs)) { ... }

See Also:

Constant Field Values

BEAN_mediaType

public static final String BEAN_mediaType

Configuration property: Media type.

Property:

• Name: "BeanContext.mediaType.s"
• Data type: String (MediaType)
• Default: null
• Session-overridable: true
• Methods:
  • BeanContextBuilder.mediaType(MediaType)
  • BeanSessionArgs.mediaType(MediaType)

Description:

Specifies a default media type value for serializer and parser sessions.

Example:

// Create a serializer that uses the specified media type if it's not passed in through session args. WriterSerializer s = JsonSerializer .create() .mediaType(MediaType.JSON) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_mediaType, MediaType.JSON) .build(); // Define on session-args instead. SerializerSessionArgs sessionArgs = new SerializerSessionArgs().mediaType(MediaType.JSON); try (WriterSerializerSession session = s.createSession(sessionArgs)) { ... }

See Also:

Constant Field Values

BEAN_notBeanClasses

public static final String BEAN_notBeanClasses

Configuration property: Bean class exclusions.

Property:

• Name: "BeanContext.notBeanClasses.sc"
• Data type: Set<Class>
• Default: empty set
• Session-overridable: false
• Annotations:
  • BeanIgnore
• Methods:
  • BeanContextBuilder.notBeanClasses(Class...)
  • BeanContextBuilder.notBeanClasses(Object...)
  • BeanContextBuilder.notBeanClasses(boolean, Object...)
  • BeanContextBuilder.notBeanClassesRemove(Object...)

Description:

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.

Values can consist of any of the following types:

• Classes.
• Arrays and collections of classes.

Example:

// Create a serializer that doesn't treat MyBean as a bean class. WriterSerializer s = JsonSerializer .create() .notBeanClasses(MyBean.class) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_notBeanClasses, MyBean.class) .build();

See Also:

Constant Field Values

BEAN_notBeanClasses_add

public static final String BEAN_notBeanClasses_add

Configuration property: Add to classes that should not be considered beans.

See Also:

Constant Field Values

BEAN_notBeanClasses_remove

public static final String BEAN_notBeanClasses_remove

Configuration property: Remove from classes that should not be considered beans.

See Also:

Constant Field Values

BEAN_notBeanPackages

public static final String BEAN_notBeanPackages

Configuration property: Bean package exclusions.

Property:

• Name: "BeanContext.notBeanPackages.ss"
• Data type: Set<String>
• Default:
  • java.lang
  • java.lang.annotation
  • java.lang.ref
  • java.lang.reflect
  • java.io
  • java.net
  • java.nio.*
  • java.util.*
• Session-overridable: false
• Methods:
  • BeanContextBuilder.notBeanPackages(Object...)
  • BeanContextBuilder.notBeanPackages(String...)
  • BeanContextBuilder.notBeanPackages(boolean, Object...)
  • BeanContextBuilder.notBeanPackagesRemove(Object...)

Description:

When specified, the current list of ignore packages are appended to.

Any classes within these packages will be serialized to strings using Object.toString().

Note that you can specify suffix patterns to include all subpackages.

Values can consist of any of the following types:

• Strings.
• Arrays and collections of strings.

Example:

// Create a serializer that ignores beans in the specified packages. WriterSerializer s = JsonSerializer .create() .notBeanPackages("org.apache.foo", "org.apache.bar.*") .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_notBeanPackages, "org.apache.foo") .addTo(BEAN_notBeanPackages, "org.apache.bar.*") .build();

See Also:

Constant Field Values

BEAN_notBeanPackages_add

public static final String BEAN_notBeanPackages_add

Configuration property: Add to packages whose classes should not be considered beans.

See Also:

Constant Field Values

BEAN_notBeanPackages_remove

public static final String BEAN_notBeanPackages_remove

Configuration property: Remove from packages whose classes should not be considered beans.

See Also:

Constant Field Values

BEAN_pojoSwaps

public static final String BEAN_pojoSwaps

Configuration property: POJO swaps.

Property:

• Name: "BeanContext.pojoSwaps.lc"
• Data type: List<Class>
• Default: empty list
• Session-overridable: false
• Annotations:
  • Swap
  • Swaps
• Methods:
  • BeanContextBuilder.pojoSwaps(Object...)
  • BeanContextBuilder.pojoSwaps(Class...)
  • BeanContextBuilder.pojoSwaps(boolean, Object...)
  • BeanContextBuilder.pojoSwapsRemove(Object...)

Description:

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.

Multiple POJO swaps can be associated with a single class.
When multiple swaps are applicable to the same class, the media type pattern defined by PojoSwap.forMediaTypes() or @Swap.mediaTypes() are used to come up with the best match.

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.

Example:

// Sample swap for converting Dates to ISO8601 strings. public class MyDateSwap extends StringSwap<Date> { // ISO8601 formatter. private DateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ"); @Override public String swap(BeanSession session, Date o) { return format.format(o); } @Override public Date unswap(BeanSession session, String o, ClassMeta hint) throws Exception { return format.parse(o); } } // Sample bean with a Date field. public class MyBean { public Date date = new Date(112, 2, 3, 4, 5, 6); } // Create a serializer that uses our date swap. WriterSerializer s = JsonSerializer .create() .pojoSwaps(MyDateSwap.class) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .addTo(BEAN_pojoSwaps, MyDateSwap.class) .build(); // Produces "{date:'2012-03-03T04:05:06-0500'}" String json = s.serialize(new MyBean()); // Create a serializer that uses our date swap. ReaderParser p = JsonParser .create() .pojoSwaps(MyDateSwap.class) .build(); // Use our parser to parse a bean. MyBean bean = p.parse(json, MyBean.class);

See Also:

• Overview > juneau-marshall > PojoSwaps
• Overview > juneau-marshall > Per-media-type PojoSwaps
• Overview > juneau-marshall > One-way PojoSwaps
• Overview > juneau-marshall > @Swap Annotation
• Overview > juneau-marshall > Swap Methods
• Overview > juneau-marshall > Surrogate Classes

See Also:

Constant Field Values

BEAN_pojoSwaps_add

public static final String BEAN_pojoSwaps_add

Configuration property: Add to POJO swap classes.

See Also:

Constant Field Values

BEAN_pojoSwaps_remove

public static final String BEAN_pojoSwaps_remove

Configuration property: Remove from POJO swap classes.

See Also:

Constant Field Values

BEAN_propertyNamer

public static final String BEAN_propertyNamer

Configuration property: Bean property namer.

Property:

• Name: "BeanContext.propertyNamer.c"
• Data type: Class<? implements PropertyNamer>
• Default: PropertyNamerDefault
• Session-overridable: false
• Annotations:
  • Bean.propertyNamer()
• Methods:
  • BeanContextBuilder.propertyNamer(Class)
  • BeanFilterBuilder.propertyNamer(Class)

Description:

The class to use for calculating bean property names.

Predefined classes:

• PropertyNamerDefault - Default.
• PropertyNamerDLC - Dashed-lower-case names.
• PropertyNamerULC - Dashed-upper-case names.

Example:

// Create a serializer that uses Dashed-Lower-Case property names. // (e.g. "foo-bar-url" instead of "fooBarURL") WriterSerializer s = JsonSerializer .create() .propertyNamer(PropertyNamerDLC.class) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_propertyNamer, PropertyNamerDLC.class) .build();

See Also:

Constant Field Values

BEAN_sortProperties

public static final String BEAN_sortProperties

Configuration property: Sort bean properties.

Property:

• Name: "BeanContext.sortProperties.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Annotations:
  • Bean.sort()
• Methods:
  • BeanContextBuilder.sortProperties(boolean)
  • BeanContextBuilder.sortProperties()
  • BeanFilterBuilder.sortProperties(boolean)
  • BeanFilterBuilder.sortProperties()

Description:

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.
On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).

This property is disabled by default so that IBM JVM users don't have to use @Bean annotations to force bean properties to be in a particular order and can just alter the order of the fields/methods in the Java file.

Example:

// Create a serializer that sorts bean properties. WriterSerializer s = JsonSerializer .create() .sortProperties() .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_sortProperties, true) .build();

See Also:

Constant Field Values

BEAN_timeZone

public static final String BEAN_timeZone

Configuration property: TimeZone.

Property:

• Name: "BeanContext.timeZone.s"
• Data type: String (TimeZone)
• Default: null
• Session-overridable: true
• Methods:
  • BeanContextBuilder.timeZone(TimeZone)
  • BeanSessionArgs.timeZone(TimeZone)

Example:

// Create a serializer that uses GMT if the timezone is not specified in the session args. WriterSerializer s = JsonSerializer .create() .timeZone(TimeZone.GMT) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_timeZone, TimeZone.GMT) .build(); // Define on session-args instead. SerializerSessionArgs sessionArgs = new SerializerSessionArgs().timeZone(TimeZone.GMT); try (WriterSerializerSession ss = JsonSerializer.DEFAULT.createSession(sessionArgs)) { String json = s.serialize(new MyBean()); }

See Also:

Constant Field Values

BEAN_useInterfaceProxies

public static final String BEAN_useInterfaceProxies

Configuration property: Use interface proxies.

Property:

• Name: "BeanContext.useInterfaceProxies.b"
• Data type: Boolean
• Default: true
• Session-overridable: false
• Methods:
  • BeanContextBuilder.useInterfaceProxies(boolean)

Description:

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.
Otherwise, throws a BeanRuntimeException.

Example:

// Create a parser that doesn't try to make interface proxies. ReaderParser p = JsonParser .create() .useInterfaceProxies(false) .build(); // Same, but use property. ReaderParser p = JsonParser .create() .set(BEAN_useInterfaceProxies, false) .build();

See Also:

Constant Field Values

BEAN_useJavaBeanIntrospector

public static final String BEAN_useJavaBeanIntrospector

Configuration property: Use Java Introspector.

Property:

• Name: "BeanContext.useJavaBeanIntrospector.b"
• Data type: Boolean
• Default: false
• Session-overridable: false
• Methods:
  • BeanContextBuilder.useJavaBeanIntrospector(boolean)
  • BeanContextBuilder.useJavaBeanIntrospector()

Description:

Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
Most @Bean annotations will be ignored.

Example:

// Create a serializer that only uses the built-in java bean introspector for finding properties. WriterSerializer s = JsonSerializer .create() .useJavaBeanIntrospector(false) .build(); // Same, but use property. WriterSerializer s = JsonSerializer .create() .set(BEAN_useJavaBeanIntrospector, false) .build();

See Also:

Constant Field Values

DEFAULT

public static final BeanContext DEFAULT

Default config. All default settings.

DEFAULT_SORTED

public static final BeanContext DEFAULT_SORTED

Default config. All default settings except sort bean properties.

Constructor Detail

BeanContext

public BeanContext(PropertyStore ps)

Constructor.

Typically only called from ContextBuilder.build(Class) method.

Parameters:

ps - The property store containing the unmodifiable configuration for this bean context.

Method Detail

builder

public BeanContextBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class Context

Returns:

A new ContextBuilder object.

create

public static BeanContextBuilder create()

Instantiates a new clean-slate BeanContextBuilder object.

This is equivalent to simply calling new BeanContextBuilder().

Returns:

A new JsonSerializerBuilder object.

createSession

public BeanSession createSession()

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class Context

Returns:

A new session object.

createSession

public BeanSession createSession(BeanSessionArgs args)

Create a new bean session based on the properties defined on this context combined with the specified runtime args.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Parameters:

args - The session arguments.

Returns:

A new session object.

createSession

public final Session createSession(SessionArgs args)

Description copied from class: Context

Create a new session based on the properties defined on this context combined with the specified runtime args.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Specified by:

createSession in class Context

Parameters:

args - The session arguments.

Returns:

A new session object.

createBeanSession

public final BeanSession createBeanSession(BeanSessionArgs args)

Same as createSession(BeanSessionArgs) except always returns a BeanSession object unlike createSession(BeanSessionArgs) which is meant to be overridden by subclasses.

Parameters:

args - The session arguments.

Returns:

A new session object.

createBeanSession

public final BeanSession createBeanSession()

Same as createSession() except always returns a BeanSession object unlike createSession() which is meant to be overridden by subclasses.

Returns:

A new session object.

createDefaultSessionArgs

public BeanSessionArgs createDefaultSessionArgs()

Description copied from class: Context

Defines default session arguments used when calling the Context.createSession() method.

Specified by:

createDefaultSessionArgs in class Context

Returns:

A SessionArgs object, possibly a read-only reusable instance.

createDefaultBeanSessionArgs

public final BeanSessionArgs createDefaultBeanSessionArgs()

Same as createDefaultSessionArgs() except always returns a BeanSessionArgs unlike createDefaultBeanSessionArgs() which is meant to be overridden by subclasses.

Returns:

A new session arguments object.

hasSameCache

public final boolean hasSameCache(BeanContext bc)

Returns true if the specified bean context shares the same cache as this bean context.

Useful for testing purposes.

Parameters:

bc - The bean context to compare to.

Returns:

true if the bean contexts have equivalent settings and thus share caches.

isNotABean

protected final boolean isNotABean(Class<?> c)

Determines whether the specified class is ignored as a bean class based on the various exclusion parameters specified on this context class.

Parameters:

c - The class type being tested.

Returns:

true if the specified class matches any of the exclusion parameters.

isBean

public boolean isBean(Object o)

Returns true if the specified object is a bean.

Parameters:

o - The object to test.

Returns:

true if the specified object is a bean. false if the bean is null.

dumpCacheStats

protected static void dumpCacheStats()

Prints meta cache statistics to System.out.

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> type)

Construct a ClassMeta wrapper around a Class object.

Type Parameters:

T - The class type being wrapped.

Parameters:

type - The class to resolve.

Returns:

If the class is not an array, returns a cached ClassMeta object. Otherwise, returns a new ClassMeta object every time.

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 resolved class meta.

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.

resolveClassMeta

protected final <T> ClassMeta<T> resolveClassMeta(BeanProperty p,
                                                  Type t,
                                                  Map<Class<?>,Class<?>[]> typeVarImpls)

Used for determining the class type on a method or field where a @BeanProperty annotation may be present.

Type Parameters:

T - The class type we're wrapping.

Parameters:

p - The property annotation on the type if there is one.

t - The type.

typeVarImpls - Contains known resolved type parameters on the specified class so that we can result ParameterizedTypes and TypeVariables. Can be null if the information is not known.

Returns:

The new ClassMeta object wrapped around the Type object.

getBeanTypePropertyName

protected final String getBeanTypePropertyName()

Returns the type property name as defined by BEAN_beanTypePropertyName.

Returns:

The type property name. Never null.

getBeanRegistry

protected final BeanRegistry getBeanRegistry()

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

Returns:

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

getImplClassConstructor

protected final <T> Constructor<? extends T> getImplClassConstructor(Class<T> c,
                                                                     Visibility v)

Gets the no-arg constructor for the specified class.

Type Parameters:

T - The class to check.

Parameters:

c - The class to check.

v - The minimum visibility for the constructor.

Returns:

The no arg constructor, or null if the class has no no-arg constructor.

getIncludeProperties

public String[] getIncludeProperties(Class<?> c)

Returns the BEAN_includeProperties setting for the specified class.

Parameters:

c - The class.

Returns:

The properties to include for the specified class, or null if it's not defined for the class.

getExcludeProperties

public String[] getExcludeProperties(Class<?> c)

Returns the BEAN_excludeProperties setting for the specified class.

Parameters:

c - The class.

Returns:

The properties to exclude for the specified class, or null if it's not defined for the class.

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.

object

protected 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

protected 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

protected 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.

asMap

public ObjectMap asMap()

Description copied from class: Context

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

Overrides:

asMap in class Context

Returns:

A new map containing the properties defined on this context.