com.cloudhopper.commons.util

Class BeanProperty

java.lang.Object

com.cloudhopper.commons.util.BeanProperty

public class BeanProperty
extends Object

Represents a "bean" property for a class. A property in this case follows a coding convention of how the field is named and how it matches getter and setter methods with the same Class type. For example, a field may be declared such as "firstName" and have access methods such as "getFirstName()" and "setFirstName()". This class abstracts that association and provides more useful methods of "get" and "set" which may fall back to direct access of the underlying field if no getter or setter methods exist.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
BeanProperty(String name, Class type, Field field)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Object obj, Object value) Adds the property value on the object.
void	addOrSet(Object obj, Object value) Adds or Sets the property value on the object.
boolean	canAdd() Returns whether the "add" method would succeed or throw an exception.
boolean	canAddOrSet() Returns whether the "addOrSet" method would succeed or throw an exception.
boolean	canGet() Returns whether the "get" method would succeed or throw an exception.
boolean	canSet() Returns whether the "set" method would succeed or throw an exception.
Object	get(Object obj) Gets the property value on the object.
Method	getAddMethod() Gets the underlying declared adder method for this property.
Field	getField() Gets the underlying declared field within the class for this property.
Method	getGetMethod() Gets the underlying declared getter method for this property.
String	getName() Gets the name of the property such as "firstName".
Method	getSetMethod() Gets the underlying declared setter method for this property.
Class	getType() Gets the Class type of the property such as "java.lang.String".
void	set(Object obj, Object value) Sets the property value on the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanProperty

public BeanProperty(String name,
            Class type,
            Field field)

Method Detail

getName

public String getName()

Gets the name of the property such as "firstName". Usually is the name of the underlying field of a property.

Returns:

The name of the property such as "firstName"

getType

public Class getType()

Gets the Class type of the property such as "java.lang.String".

Returns:

The Class type of the property

canAdd

public boolean canAdd()

Returns whether the "add" method would succeed or throw an exception.

Returns:

True if an "add" would succeed, otherwise false.

canAddOrSet

public boolean canAddOrSet()

Returns whether the "addOrSet" method would succeed or throw an exception.

Returns:

True if an "addOrSet" would succeed, otherwise false.

canGet

public boolean canGet()

Returns whether the "get" method would succeed or throw an exception.

Returns:

True if an "get" would succeed, otherwise false.

canSet

public boolean canSet()

Returns whether the "set" method would succeed or throw an exception.

Returns:

True if an "set" would succeed, otherwise false.

getField

public Field getField()

Gets the underlying declared field within the class for this property. Its possible the underlying field may be null, since all access may specifically be required to go thru getter and setter methods.

Returns:

The declared field for this property

getGetMethod

public Method getGetMethod()

Gets the underlying declared getter method for this property. Its possible the underlying method may be null, since it may not exist for this property. In that case, direct access to the field may be required to obtain its value.

Returns:

The declared getter method for this property such as getFirstName()

getSetMethod

public Method getSetMethod()

Gets the underlying declared setter method for this property. Its possible the underlying method may be null, since it may not exist for this property. In that case, direct access to the field may be required to obtain its value.

Returns:

The declared setter method for this property such as setFirstName()

getAddMethod

public Method getAddMethod()

Gets the underlying declared adder method for this property. Its possible the underlying method may be null, since it may not exist for this property.

Returns:

The declared adder method for this property such as addFirstName()

set

public void set(Object obj,
       Object value)
         throws IllegalAccessException,
                InvocationTargetException

Sets the property value on the object. Attempts to first set the property via its setter method such as "setFirstName()". If a setter method doesn't exist, this will then attempt to set the property value directly on the underlying field within the class.
NOTE: If the setter method throws an exception during execution, the exception will be accessible in the getCause() method of the InvocationTargetException.

Parameters:

obj - The object to set the property on

value - The value of the property

Throws:

IllegalAccessException - Thrown if an access exception occurs while attempting to set the property value.

InvocationTargetException - Thrown if there is an exception thrown while calling the underlying method.

get

public Object get(Object obj)
           throws IllegalAccessException,
                  InvocationTargetException

Gets the property value on the object. Attempts to first get the property via its getter method such as "getFirstName()". If a getter method doesn't exist, this will then attempt to get the property value directly from the underlying field within the class.
NOTE: If the getter method throws an exception during execution, the exception will be accessible in the getCause() method of the InvocationTargetException.

Parameters:

obj - The object to get the property from

Returns:

The value of the property

Throws:

IllegalAccessException - Thrown if an access exception occurs while attempting to get the property value.

IllegalArgumentException - Thrown if an illegal argument is used while attempting to get the property value.

InvocationTargetException - Thrown if there is an exception thrown while calling the underlying method.

add

public void add(Object obj,
       Object value)
         throws IllegalAccessException,
                InvocationTargetException

Adds the property value on the object. Attempts to call "addFirstName()". If the adder method doesn't exist, this will throw an exception.
NOTE: If the adder method throws an exception during execution, the exception will be accessible in the getCause() method of the InvocationTargetException.

Parameters:

obj - The object to add the property on

value - The value to add

Throws:

IllegalAccessException - Thrown if an access exception occurs while attempting to set the property value.

IllegalArgumentException - Thrown if an illegal argument is used while attempting to set the property value.

InvocationTargetException - Thrown if there is an exception thrown while calling the underlying method.

addOrSet

public void addOrSet(Object obj,
            Object value)
              throws IllegalAccessException,
                     InvocationTargetException

Adds or Sets the property value on the object. Attempts to first add the property and falls back to setting the property.
NOTE: If the adder or setter method throws an exception during execution, the exception will be accessible in the getCause() method of the InvocationTargetException.

Parameters:

obj - The object to add or set the property on

value - The value of the property

Throws:

IllegalAccessException - Thrown if an access exception occurs while attempting to set the property value.

InvocationTargetException - Thrown if there is an exception thrown while calling the underlying method.