net.sf.juffrou.reflect

Class JuffrouBeanWrapper

java.lang.Object

net.sf.juffrou.reflect.JuffrouBeanWrapper

public class JuffrouBeanWrapper
extends java.lang.Object

Bean handling through property names.

Allows access to the wrapped bean's properties and also to the properties of beans referenced by them. For example the property path "pro1.prop2" will access the property prop2 from the nested bean referenced by prop1.
This bean wrapper auto grows nested paths, so for each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1. The nested bean wrappers can be obtained by calling the getNestesWrappers() method.
You can reference nested properties as deep as you like as long as the bean path exists.

Author:

cemartins

Constructor Summary

Constructors

Constructor and Description
JuffrouBeanWrapper(BeanWrapperContext context) Construct a bean wrapper using the metadata and preferences of an existing BeanWrapperContext. Performance is better, because there is no need to do introspection.
JuffrouBeanWrapper(BeanWrapperContext context, JuffrouBeanWrapper parentBeanWrapper, java.lang.String parentBeanProperty)
JuffrouBeanWrapper(BeanWrapperContext context, java.lang.Object instance) Construct a bean wrapper using the metadata and preferences of an existing BeanWrapperContext and initializes it with an instance value. Performance is better, because there is no need to do introspection.
JuffrouBeanWrapper(java.lang.Class<?> clazz) Construct a bean wrapper around a class.
JuffrouBeanWrapper(java.lang.Object instance) Construct a bean wrapper around an existing bean instance. This constructor will have to create a BeanWrapperContext to get introspection metadata.

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.String propertyName, java.lang.Object element) Add an element to a collection property.
java.lang.Object	getBean() Get the wrapped bean instance.
java.lang.Object	getBean(boolean instantiateIfNull) Get the wrapped bean Get the wrapped bean instance.
java.lang.Class<?>	getBeanClass() Get the wrapped bean class
java.lang.Class<?>	getClazz(java.lang.String propertyName) Gets the class of a property in the wrapped bean.
BeanWrapperContext	getContext()
BeanWrapperFactory	getFactory()
java.lang.reflect.Field	getField(java.lang.String propertyName) Gets the field of a property in the wrapped bean.
JuffrouBeanWrapper	getLocalNestedWrapper(java.lang.String thisProperty) Obtains the BeanWrapper that corresponds to the bean instance of this property type.
JuffrouBeanWrapper	getNestedWrapper(java.lang.String propertyName) Obtains the JuffrouBeanWrapper corresponding to the bean referred by propertyName.
java.util.Map<java.lang.String,JuffrouBeanWrapper>	getNestedWrappers() Returns all the nested bean wrappers that have been created inside this bean wrapper. Nested bean wrappers are created when you access a nested property (i.e.
protected java.lang.String	getParentBeanProperty()
protected JuffrouBeanWrapper	getParentBeanWrapper()
java.lang.String[]	getPropertyNames() Get the names of all properties found in this bean and base ascending hierarchy
java.lang.reflect.Type	getType(java.lang.String propertyName) Gets the type of a property in the wrapped bean.
java.lang.reflect.Type[]	getTypeArguments(java.lang.String propertyName) Gets the type arguments of a property in the wrapped bean.
java.lang.Object	getValue(java.lang.String propertyName) Gets the value of a property in the wrapped bean.
boolean	hasProperty(java.lang.String propertyName) Checks whether a property exists in the wrapped bean.
void	removeElement(java.lang.String propertyName, java.lang.Object element) Remove an element from a collection property.
void	setBean(java.lang.Object bean) Replaces the wrapped bean with another instance of the same type
void	setValue(java.lang.String propertyName, java.lang.Object value) Sets the value of a property in the wrapped bean.
void	setValueOfString(java.lang.String propertyName, java.lang.String value) Same as setValue(String propertyName, Object value) but the value will be converted from String to whatever type the property referenced by propertyName is.
java.lang.String	toString() Returns the string representation of the wrapped bean instance, or and empty string if the instance is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

JuffrouBeanWrapper

public JuffrouBeanWrapper(BeanWrapperContext context)

Construct a bean wrapper using the metadata and preferences of an existing BeanWrapperContext.
Performance is better, because there is no need to do introspection.

Parameters:

context - metadata information about the class to instantiate the wrapped bean

JuffrouBeanWrapper

public JuffrouBeanWrapper(BeanWrapperContext context,
                          java.lang.Object instance)

Construct a bean wrapper using the metadata and preferences of an existing BeanWrapperContext and initializes it with an instance value.
Performance is better, because there is no need to do introspection.

Parameters:

context - metadata and preferences information about the class

instance - bean instance

JuffrouBeanWrapper

public JuffrouBeanWrapper(BeanWrapperContext context,
                          JuffrouBeanWrapper parentBeanWrapper,
                          java.lang.String parentBeanProperty)

JuffrouBeanWrapper

public JuffrouBeanWrapper(java.lang.Object instance)

Construct a bean wrapper around an existing bean instance.
This constructor will have to create a BeanWrapperContext to get introspection metadata. You can use JuffrouBeanWrapper(BeanWrapperContext, Object) instead.

Parameters:

instance - object to wrap.

JuffrouBeanWrapper

public JuffrouBeanWrapper(java.lang.Class<?> clazz)

Construct a bean wrapper around a class. Bean instances will be instances of that class.
This constructor will have to create a BeanWrapperContext to get introspection metadata. You can use JuffrouBeanWrapper(BeanWrapperContext, Object) instead.

Parameters:

clazz - class to instantiate the wrapped bean

Method Detail

getContext

public BeanWrapperContext getContext()

Returns:

the BeanWrapperContext containing introspection information about this bean

getFactory

public BeanWrapperFactory getFactory()

Returns:

The BeanWrapperFactory responsible for creating and caching the BeanWrapperContext for this bean and all its nested beans.

getBean

public java.lang.Object getBean(boolean instantiateIfNull)

Get the wrapped bean Get the wrapped bean instance. If the wrapped instance is null, this method may instantiate it before returning.

Parameters:

instantiateIfNull - is true, this method will force the instantiation of the bean in case it is null.

Returns:

The wrapped bean instance or null.

getBean

public java.lang.Object getBean()

Get the wrapped bean instance. This method will always return a non null value. If the instance is null it will be instantiated.
This is the same as getBean(boolean) with TRUE passed as parameter.

Returns:

the wrapped bean

See Also:

getBean(boolean)

setBean

public void setBean(java.lang.Object bean)

Replaces the wrapped bean with another instance of the same type

Parameters:

bean - instance of the new bean to wrap

Throws:

java.security.InvalidParameterException - if the new bean is not of the same type of the initially wrapped bean.

getBeanClass

public java.lang.Class<?> getBeanClass()

Get the wrapped bean class

Returns:

the class of the wrapped object

getNestedWrappers

public java.util.Map<java.lang.String,JuffrouBeanWrapper> getNestedWrappers()

Returns all the nested bean wrappers that have been created inside this bean wrapper.
Nested bean wrappers are created when you access a nested property (i.e. getValue("prop1.prop2"))

Returns:

a Map where the keys are property names and the values are bean wrappers

hasProperty

public boolean hasProperty(java.lang.String propertyName)

Checks whether a property exists in the wrapped bean. If that property references another bean (a nested bean) the method verifies if the property of the nested bean also exists.
For example hasProperty("pro1.prop2") returns true only if prop1 exists is this bean and prop2 exists in the bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - property name to search for

Returns:

true if the bean has a property with the specified property name

getPropertyNames

public java.lang.String[] getPropertyNames()

Get the names of all properties found in this bean and base ascending hierarchy

Returns:

unordered list of property names.

toString

public java.lang.String toString()

Returns the string representation of the wrapped bean instance, or and empty string if the instance is null.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getValue

public java.lang.Object getValue(java.lang.String propertyName)

Gets the value of a property in the wrapped bean. If that property references another bean (a nested bean) Its property values can also be obtained by specifying a property path.
For example getValue("pro1.prop2") will get the value of prop2 from the nested bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - property to get the value of.

Returns:

the value held in the bean property

getClazz

public java.lang.Class<?> getClazz(java.lang.String propertyName)

Gets the class of a property in the wrapped bean. If that property references another bean (a nested bean) Its property types can also be obtained by specifying a property path.
For example getType("pro1.prop2") will get the type of prop2 from the nested bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - the property name to search

Returns:

the class of the object referenced by the specified property

getType

public java.lang.reflect.Type getType(java.lang.String propertyName)

Gets the type of a property in the wrapped bean. If that property references another bean (a nested bean) Its property types can also be obtained by specifying a property path.
For example getType("pro1.prop2") will get the type of prop2 from the nested bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - the property name

Returns:

the type of the object referenced by the specified property

getTypeArguments

public java.lang.reflect.Type[] getTypeArguments(java.lang.String propertyName)

Gets the type arguments of a property in the wrapped bean. If that property references another bean (a nested bean) Its property types can also be obtained by specifying a property path.
For example getTypeArguments("pro1.prop2") will get the type arguments of prop2 from the nested bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - the property name

Returns:

an array of types

getField

public java.lang.reflect.Field getField(java.lang.String propertyName)

Gets the field of a property in the wrapped bean. If that property references another bean (a nested bean) Its property field can also be obtained by specifying a property path.
For example getField("pro1.prop2") will get the field of prop2 from the nested bean referenced by prop1.
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - the property

Returns:

the field which represents the specified bean property

setValueOfString

public void setValueOfString(java.lang.String propertyName,
                             java.lang.String value)

Same as setValue(String propertyName, Object value) but the value will be converted from String to whatever type the property referenced by propertyName is.

Parameters:

propertyName - property to set the value of

value - String representation of the value to be set

setValue

public void setValue(java.lang.String propertyName,
                     java.lang.Object value)

Sets the value of a property in the wrapped bean. If that property references another bean (a nested bean) Its property values can also be set by specifying a property path.
For example setValue("pro1.prop2", Boolean.TRUE) will set the value of prop2 from the nested bean referenced by prop1. If the value of prop1 was originally null, it would also be set to reference the new bean holding the value of prop2
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - property to set the value of.

value - value to be set

addElement

public void addElement(java.lang.String propertyName,
                       java.lang.Object element)

Add an element to a collection property.

The collection must be a parameterized collection, for example List<ElementBean>.
This method will first try to find an add method in the bean that has the collection with the pattern addElementBean(ElementBean arg). If no such method is found then the element will be added directly to the collection field using the Collection.add method.

Parameters:

propertyName - name of the collection type property. Can be a nested property path.

element - element to add

removeElement

public void removeElement(java.lang.String propertyName,
                          java.lang.Object element)

Remove an element from a collection property.

The collection must be a parameterized collection, for example List<ElementBean>.
This method will first try to find a remove method in the bean that has the collection with the pattern removeElementBean(ElementBean arg). If no such method is found then the element will be removed directly from the collection field using the Collection.remove method.

Parameters:

propertyName - name of the collection type property. Can be a nested property path.

element - element to remove

getNestedWrapper

public JuffrouBeanWrapper getNestedWrapper(java.lang.String propertyName)

Obtains the JuffrouBeanWrapper corresponding to the bean referred by propertyName. If that property references a nested bean, the method will delegate to that nested bean.
For example getNestedWrapper("prop1.prop2") will ask the bean wrapper on prop1 to return the bean wrapper of prop2. If the value of prop1 was originally null, it would also be set to reference the new bean holding the value of prop2
For each nested bean referenced in this manner, a nested bean wrapper is automatically created. In the previous example, a bean wrapper would be created for the bean referenced by property prop1.

Parameters:

propertyName - property name in this bean wrapper or inside a nested bean. It must be of bean type.

Returns:

JuffrouBeanWrapper instance

See Also:

to obtain a bean wrapper corresponding to a non nested property.

getLocalNestedWrapper

public JuffrouBeanWrapper getLocalNestedWrapper(java.lang.String thisProperty)

Obtains the BeanWrapper that corresponds to the bean instance of this property type.

Parameters:

thisProperty - property name in this bean wrapper. The property type must be another bean and nested properties are not allowed.

Returns:

JuffrouBeanWrapper instance

See Also:

to obtain nested wrappers of nested wrappers.

getParentBeanWrapper

protected JuffrouBeanWrapper getParentBeanWrapper()

getParentBeanProperty

protected java.lang.String getParentBeanProperty()