Package org.apache.commons.beanutils
Class BeanPropertyValueChangeClosure
- java.lang.Object
-
- org.apache.commons.beanutils.BeanPropertyValueChangeClosure
-
- All Implemented Interfaces:
org.apache.commons.collections.Closure
public class BeanPropertyValueChangeClosure extends java.lang.Object implements org.apache.commons.collections.Closure
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. TheBeanPropertyValueChangeClosure
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 bypropertyName
to the value specified bypropertyValue
.
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 bypropertyName
isnull
then the outcome is based on the value of theignoreNull
attribute.A typical usage might look like:
// create the closure BeanPropertyValueChangeClosure closure = new BeanPropertyValueChangeClosure( "activeEmployee", Boolean.TRUE ); // update the Collection CollectionUtils.forAllDo( peopleCollection, closure );
This would take a
Collection
of person objects and update theactiveEmployee
property of each object in theCollection
totrue
. 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'sactiveEmployee
property.
- See Also:
PropertyUtils
,Closure
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
ignoreNull
Determines whethernull
objects in the property path will genenerate anIllegalArgumentException
or not.private org.apache.commons.logging.Log
log
For logging.private java.lang.String
propertyName
The name of the property which will be updated when thisClosure
executes.private java.lang.Object
propertyValue
The value that the property specified bypropertyName
will be updated to when thisClosure
executes.
-
Constructor Summary
Constructors Constructor Description BeanPropertyValueChangeClosure(java.lang.String propertyName, java.lang.Object propertyValue)
Constructor which takes the name of the property to be changed, the new value to set the property to, and assumesignoreNull
to befalse
.BeanPropertyValueChangeClosure(java.lang.String propertyName, java.lang.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 whethernull
objects in the property path will genenerate anIllegalArgumentException
or not.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(java.lang.Object object)
Updates the target object provided using the property update criteria provided when thisBeanPropertyValueChangeClosure
was constructed.java.lang.String
getPropertyName()
Returns the name of the property which will be updated when thisClosure
executes.java.lang.Object
getPropertyValue()
Returns the value that the property specified bypropertyName
will be updated to when thisClosure
executes.boolean
isIgnoreNull()
Returns the flag that determines whethernull
objects in the property path will genenerate anIllegalArgumentException
or not.
-
-
-
Field Detail
-
log
private final org.apache.commons.logging.Log log
For logging.
-
propertyName
private final java.lang.String propertyName
The name of the property which will be updated when thisClosure
executes.
-
propertyValue
private final java.lang.Object propertyValue
The value that the property specified bypropertyName
will be updated to when thisClosure
executes.
-
ignoreNull
private final boolean ignoreNull
Determines whethernull
objects in the property path will genenerate anIllegalArgumentException
or not. If set totrue
then if any objects in the property path leading up to the target property evaluate tonull
then theIllegalArgumentException
throw byPropertyUtils
will be logged but not rethrown. If set tofalse
then if any objects in the property path leading up to the target property evaluate tonull
then theIllegalArgumentException
throw byPropertyUtils
will be logged and rethrown.
-
-
Constructor Detail
-
BeanPropertyValueChangeClosure
public BeanPropertyValueChangeClosure(java.lang.String propertyName, java.lang.Object propertyValue)
Constructor which takes the name of the property to be changed, the new value to set the property to, and assumesignoreNull
to befalse
.- Parameters:
propertyName
- The name of the property that will be updated with the value specified bypropertyValue
.propertyValue
- The value thatpropertyName
will be set to on the target object.- Throws:
java.lang.IllegalArgumentException
- If the propertyName provided is null or empty.
-
BeanPropertyValueChangeClosure
public BeanPropertyValueChangeClosure(java.lang.String propertyName, java.lang.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 whethernull
objects in the property path will genenerate anIllegalArgumentException
or not.- Parameters:
propertyName
- The name of the property that will be updated with the value specified bypropertyValue
.propertyValue
- The value thatpropertyName
will be set to on the target object.ignoreNull
- Determines whethernull
objects in the property path will genenerate anIllegalArgumentException
or not.- Throws:
java.lang.IllegalArgumentException
- If the propertyName provided is null or empty.
-
-
Method Detail
-
execute
public void execute(java.lang.Object object)
Updates the target object provided using the property update criteria provided when thisBeanPropertyValueChangeClosure
was constructed. If any object in the property path leading up to the target property isnull
then the outcome will be based on the value of theignoreNull
attribute. By default,ignoreNull
isfalse
and would result in anIllegalArgumentException
if an object in the property path leading up to the target property isnull
.- Specified by:
execute
in interfaceorg.apache.commons.collections.Closure
- Parameters:
object
- The object to be updated.- Throws:
java.lang.IllegalArgumentException
- If an IllegalAccessException, InvocationTargetException, or NoSuchMethodException is thrown when trying to access the property specified on the object provided. Or if an object in the property path provided isnull
andignoreNull
is set tofalse
.
-
getPropertyName
public java.lang.String getPropertyName()
Returns the name of the property which will be updated when thisClosure
executes.- Returns:
- The name of the property which will be updated when this
Closure
executes.
-
getPropertyValue
public java.lang.Object getPropertyValue()
Returns the value that the property specified bypropertyName
will be updated to when thisClosure
executes.- Returns:
- The value that the property specified by
propertyName
will be updated to when thisClosure
executes.
-
isIgnoreNull
public boolean isIgnoreNull()
Returns the flag that determines whethernull
objects in the property path will genenerate anIllegalArgumentException
or not. If set totrue
then if any objects in the property path leading up to the target property evaluate tonull
then theIllegalArgumentException
throw byPropertyUtils
will be logged but not rethrown. If set tofalse
then if any objects in the property path leading up to the target property evaluate tonull
then theIllegalArgumentException
throw byPropertyUtils
will be logged and rethrown.- Returns:
- The flag that determines whether
null
objects in the property path will genenerate anIllegalArgumentException
or not.
-
-