| java.lang.Object
 org.apache.commons.beanutils.BeanPropertyValueChangeClosure
| BeanPropertyValueChangeClosure | | public class BeanPropertyValueChangeClosure implements Closure(Code) | | Closure that sets a property.
An implementation of org.apache.commons.collections.Closure that updates
a specified property on the object provided with a specified value.
The BeanPropertyValueChangeClosure constructor takes two parameters which determine
what property will be updated and with what value.
-
public BeanPropertyValueChangeClosure( String propertyName, Object propertyValue )
-
Will create a
Closure that will update an object by setting the property
specified by propertyName to the value specified by propertyValue.
Note: Property names can be a simple, nested, indexed, or mapped property as defined by
org.apache.commons.beanutils.PropertyUtils. If any object in the property path
specified by propertyName is null then the outcome is based on the
value of the ignoreNull attribute.
A typical usage might look like:
// create the closure
BeanPropertyValueChangeClosure closure =
new BeanPropertyValueChangeClosure( "activeEmployee", Boolean.TRUE );
// update the Collection
CollectionUtils.forAllDo( peopleCollection, closure );
Collection of person objects and update the
activeEmployee property of each object in the Collection to
true. Assuming...
-
The top level object in the
peopleCollection is an object which represents a
person.
-
The person object has a
setActiveEmployee( boolean ) method which updates
the value for the object's activeEmployee property.
author:
Norm Deane
See Also: org.apache.commons.beanutils.PropertyUtils
See Also: org.apache.commons.collections.Closure |
| Constructor Summary | |
| public | BeanPropertyValueChangeClosure(String propertyName, Object propertyValue)
Constructor which takes the name of the property to be changed, the new value to set
the property to, and assumes ignoreNull to be false. | | public | BeanPropertyValueChangeClosure(String propertyName, Object propertyValue, boolean ignoreNull)
Constructor which takes the name of the property to be changed, the new value to set
the property to and a boolean which determines whether null objects in the
property path will genenerate an IllegalArgumentException or not. |
| Method Summary | |
| public void | execute(Object object)
Updates the target object provided using the property update criteria provided when this
BeanPropertyValueChangeClosure was constructed. | | public String | getPropertyName()
Returns the name of the property which will be updated when this Closure executes. | | public Object | getPropertyValue()
Returns the value that the property specified by propertyName
will be updated to when this Closure executes. | | public boolean | isIgnoreNull()
Returns the flag that determines whether null objects in the property path will
genenerate an IllegalArgumentException or not. |
| BeanPropertyValueChangeClosure | | public BeanPropertyValueChangeClosure(String propertyName, Object propertyValue)(Code) | | Constructor which takes the name of the property to be changed, the new value to set
the property to, and assumes ignoreNull to be false.
Parameters:
propertyName - The name of the property that will be updated with the value specified bypropertyValue.
Parameters:
propertyValue - The value that propertyName will be set to on the targetobject.
throws:
IllegalArgumentException - If the propertyName provided is null or empty. |
| BeanPropertyValueChangeClosure | | public BeanPropertyValueChangeClosure(String propertyName, Object propertyValue, boolean ignoreNull)(Code) | | Constructor which takes the name of the property to be changed, the new value to set
the property to and a boolean which determines whether null objects in the
property path will genenerate an IllegalArgumentException or not.
Parameters:
propertyName - The name of the property that will be updated with the value specified bypropertyValue.
Parameters:
propertyValue - The value that propertyName will be set to on the targetobject.
Parameters:
ignoreNull - Determines whether null objects in the property path willgenenerate an IllegalArgumentException or not.
throws:
IllegalArgumentException - If the propertyName provided is null or empty. |
| execute | | public void execute(Object object)(Code) | | Updates the target object provided using the property update criteria provided when this
BeanPropertyValueChangeClosure was constructed. If any object in the property
path leading up to the target property is null then the outcome will be based on
the value of the ignoreNull attribute. By default, ignoreNull is
false and would result in an IllegalArgumentException if an object
in the property path leading up to the target property is null.
Parameters:
object - The object to be updated.
throws:
IllegalArgumentException - If an IllegalAccessException, InvocationTargetException, orNoSuchMethodException is thrown when trying to access the property specified on the objectprovided. Or if an object in the property path provided is null andignoreNull is set to false. |
| getPropertyName | | public String getPropertyName()(Code) | | Returns the name of the property which will be updated when this Closure executes.
The name of the property which will be updated when this Closure executes. |
| getPropertyValue | | public Object getPropertyValue()(Code) | | Returns the value that the property specified by propertyName
will be updated to when this Closure executes.
The value that the property specified by propertyNamewill be updated to when this Closure executes. |
| isIgnoreNull | | public boolean isIgnoreNull()(Code) | | Returns the flag that determines whether null objects in the property path will
genenerate an IllegalArgumentException or not. If set to true then
if any objects in the property path leading up to the target property evaluate to
null then the IllegalArgumentException throw by
PropertyUtils will be logged but not rethrown. If set to false then
if any objects in the property path leading up to the target property evaluate to
null then the IllegalArgumentException throw by
PropertyUtils will be logged and rethrown.
The flag that determines whether null objects in the property path willgenenerate an IllegalArgumentException or not. |
|
|