Package org.oddjob.arooa.reflect

Interface PropertyAccessor

All Known Implementing Classes:

BeanUtilsPropertyAccessor

public interface PropertyAccessor

Property access.

Method Summary

Modifier and Type	Method	Description
PropertyAccessor	accessorWithConversions(ArooaConverter converter)	Provide an accessor that performs conversions.
BeanOverview	getBeanOverview(Class<?> forClass)	Provide BeanOverview.
ArooaClass	getClassName(Object bean)	Get the ArooaClass for a bean.
Object	getIndexedProperty(Object bean, String property, int index)	Get an indexed property.
Object	getMappedProperty(Object bean, String property, String key)	Get a property.
Object	getProperty(Object bean, String property)	Get a property.
<T> T	getProperty(Object bean, String property, Class<T> required)	Get a property of a required type.
Object	getSimpleProperty(Object bean, String property)	Get a simple property.
void	setIndexedProperty(Object bean, String name, int index, Object value)	Set an indexed property on a bean.
void	setMappedProperty(Object bean, String name, String key, Object value)	Set a mapped property on a bean.
void	setProperty(Object bean, String expression, Object value)	Set a property using a property expression.
void	setSimpleProperty(Object bean, String name, Object value)	Set a property on a bean.

Method Details

setProperty

void setProperty(Object bean,
 String expression,
 Object value)
          throws ArooaPropertyException

Set a property using a property expression.

Parameters:

bean - The bean. Must not be null.

expression - The name. Must not be null.

value - The value. Can be null.

Throws:

ArooaPropertyException

setSimpleProperty

void setSimpleProperty(Object bean,
 String name,
 Object value)
                throws ArooaPropertyException

Set a property on a bean.

Parameters:

bean - The bean. Must not be null.

name - The name. Must not be null.

value - The value. Can be null.

Throws:

ArooaPropertyException

setMappedProperty

void setMappedProperty(Object bean,
 String name,
 String key,
 Object value)
                throws ArooaPropertyException

Set a mapped property on a bean.

Parameters:

bean - The bean. Must not be null.

name - The name. Must not be null.

key - The mapped property's key. Must not be null.

value - The value. Can be null.

Throws:

ArooaPropertyException

setIndexedProperty

void setIndexedProperty(Object bean,
 String name,
 int index,
 Object value)
                 throws ArooaPropertyException

Set an indexed property on a bean.

Parameters:

bean - The bean. Must not be null.

name - The name. Must not be null.

index - The indexed property's index. 0 based.

value - The value. Can be null.

Throws:

ArooaPropertyException

getClassName

ArooaClass getClassName(Object bean)

Get the ArooaClass for a bean.

Parameters:

bean - The bean.

Returns:

An Arooa Class

getBeanOverview

BeanOverview getBeanOverview(Class<?> forClass)
                      throws ArooaException

Provide BeanOverview. Note that this will provide the overview for the Java class. If using a bean that might be a DynaBean then use getClassName(Object) and then ArooaClass.getBeanOverview(PropertyAccessor) instead.

Parameters:

forClass - The class to provide the overview for.

Returns:

An overview. Never null.

Throws:

ArooaException - If something goes wrong.

getProperty

Object getProperty(Object bean,
 String property)
            throws ArooaPropertyException

Get a property. The property is a full property expression.

Parameters:

bean - The bean.

property - The property expression.

Returns:

The property value.

Throws:

ArooaPropertyException

getProperty

<T> T getProperty(Object bean,
 String property,
 Class<T> required)
           throws ArooaPropertyException,
ArooaConversionException

Get a property of a required type.

Parameters:

bean - The bean.

property - The property expression.

Returns:

The property value.

Throws:

ArooaPropertyException

ArooaConversionException

getSimpleProperty

Object getSimpleProperty(Object bean,
 String property)
                  throws ArooaPropertyException

Get a simple property. A none nested, none indexed, none mapped property.

Parameters:

bean - The bean.

property - The property name.

Returns:

The property value.

Throws:

ArooaPropertyException

getIndexedProperty

Object getIndexedProperty(Object bean,
 String property,
 int index)
                   throws ArooaPropertyException

Get an indexed property.

Parameters:

bean - The bean.

property - The property name.

index - The index.

Returns:

The property value.

Throws:

ArooaPropertyException

getMappedProperty

Object getMappedProperty(Object bean,
 String property,
 String key)
                  throws ArooaPropertyException

Get a property. The property is a full property expression.

Parameters:

bean - The bean.

property - The property name.

key - The key .

Returns:

The property value.

Throws:

ArooaPropertyException

accessorWithConversions

PropertyAccessor accessorWithConversions(ArooaConverter converter)

Provide an accessor that performs conversions.

Parameters:

converter - The converter.

Returns:

An accessor that performs conversions.