com.googlecode.juffrou.util.reflect

Class BeanWrapper

java.lang.Object

com.googlecode.juffrou.util.reflect.BeanWrapper

public class BeanWrapper
extends Object

Utility class for bean handling.
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:

cem

Constructor Summary

Constructors

Constructor and Description
BeanWrapper(Class clazz) Construct a bean wrapper around an object that is an instance of the class
BeanWrapper(Object instance) Construct a bean wrapper around an existing bean object

Method Summary

Methods

Modifier and Type	Method and Description
Object	getBean() Get the wrapped bean
Class<?>	getBeanClass() Get the wrapped bean class
Class<?>	getClazz(String propertyName) Gets the class of a property in the wrapped bean.
Field	getField(String propertyName) Gets the type of a property in the wrapped bean.
Map<String,BeanWrapper>	getNestesWrappers() 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.
Type	getType(String propertyName) Gets the type of a property in the wrapped bean.
Type[]	getTypeArguments(String propertyName) Gets the type of a property in the wrapped bean.
Object	getValue(String propertyName) Gets the value of a property in the wrapped bean.
boolean	hasProperty(String propertyName) Checks whether a property exists in the wrapped bean.
void	reset() sets all properties to null in this instance and in all nested bean instances
void	setBean(Object bean) Replaces the wrapped bean with another instance of the same type
void	setValue(String propertyName, Object value) Sets the value of a property in the wrapped bean.
void	setValueOfString(String propertyName, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanWrapper

public BeanWrapper(Object instance)

Construct a bean wrapper around an existing bean object

Parameters:

instance -

BeanWrapper

public BeanWrapper(Class clazz)

Construct a bean wrapper around an object that is an instance of the class

Parameters:

clazz - class to instantiate the wrapped bean

Method Detail

getBean

public Object getBean()

Get the wrapped bean

Returns:

the wrapped bean

setBean

public void setBean(Object bean)

Replaces the wrapped bean with another instance of the same type

Parameters:

bean - instance of the new bean to wrap

Throws:

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

getBeanClass

public Class<?> getBeanClass()

Get the wrapped bean class

Returns:

getNestesWrappers

public Map<String,BeanWrapper> getNestesWrappers()

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

reset

public void reset()

sets all properties to null in this instance and in all nested bean instances

hasProperty

public boolean hasProperty(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 -

Returns:

getValue

public Object getValue(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 -

Returns:

the value held in the bean property

getClazz

public Class<?> getClazz(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 -

Returns:

getType

public Type getType(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 -

Returns:

getTypeArguments

public Type[] getTypeArguments(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 -

Returns:

getField

public Field getField(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 -

Returns:

setValueOfString

public void setValueOfString(String propertyName,
                    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 -

value - String representation of the value to be set

setValue

public void setValue(String propertyName,
            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 -

value - value to be set