Package org.apache.commons.beanutils2
Class BeanPropertyValueChangeConsumer<T,V>
java.lang.Object
org.apache.commons.beanutils2.BeanPropertyValueChangeConsumer<T,V>
- Type Parameters:
T- The type of the input to the operationV- The property value type.
- All Implemented Interfaces:
Consumer<T>
Closure that sets a property.
An implementation of Consumer 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
Closurethat will update an object by setting the property specified bypropertyName</code> to the value specified by <code>propertyValue.
Note: Property names can be a simple, nested, indexed, or mapped property as defined by
org.apache.commons.beanutils2.PropertyUtils. If any object in the property path
specified by propertyName</code> is <code>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 );
This would take a Collection of person objects and update the
activeEmployee</code> property of each object in the <code>Collection to true. Assuming...
- The top level object in the
peopleCollectionis an object which represents a person. - The person object has a
setActiveEmployee( boolean )method which updates the value for the object'sactiveEmployeeproperty.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionBeanPropertyValueChangeConsumer(String propertyName, V propertyValue) Constructor which takes the name of the property to be changed, the new value to set the property to, and assumesignoreNull</code> to be <code>false.BeanPropertyValueChangeConsumer(String propertyName, V 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 whethernullobjects in the property path will generate anIllegalArgumentExceptionor not. -
Method Summary
Modifier and TypeMethodDescriptionvoidUpdates the target object provided using the property update criteria provided when thisBeanPropertyValueChangeClosurewas constructed.Returns the name of the property which will be updated when thisClosureexecutes.Returns the value that the property specified bypropertyNamewill be updated to when thisClosureexecutes.booleanReturns the flag that determines whethernullobjects in the property path will generate anIllegalArgumentException</code> or not. If set to <code>truethen if any objects in the property path leading up to the target property evaluate tonull</code> then the <code>IllegalArgumentExceptionthrow byPropertyUtils</code> will be logged but not re-thrown. If set to <code>falsethen if any objects in the property path leading up to the target property evaluate tonull</code> then the <code>IllegalArgumentExceptionthrow byPropertyUtilswill be logged and re-thrown.
-
Constructor Details
-
BeanPropertyValueChangeConsumer
Constructor which takes the name of the property to be changed, the new value to set the property to, and assumesignoreNull</code> to be <code>false.- Parameters:
propertyName- The name of the property that will be updated with the value specified bypropertyValue.propertyValue- The value thatpropertyNamewill be set to on the target object.- Throws:
IllegalArgumentException- If the propertyName provided is null or empty.
-
BeanPropertyValueChangeConsumer
Constructor which takes the name of the property to be changed, the new value to set the property to and a boolean which determines whethernullobjects in the property path will generate anIllegalArgumentExceptionor not.- Parameters:
propertyName- The name of the property that will be updated with the value specified bypropertyValue.propertyValue- The value thatpropertyNamewill be set to on the target object.ignoreNull- Determines whethernullobjects in the property path will generate anIllegalArgumentExceptionor not.- Throws:
IllegalArgumentException- If the propertyName provided is null or empty.
-
-
Method Details
-
accept
Updates the target object provided using the property update criteria provided when thisBeanPropertyValueChangeClosurewas constructed. If any object in the property path leading up to the target property isnullthen the outcome will be based on the value of theignoreNull</code> attribute. By default, <code>ignoreNullisfalse</code> and would result in an <code>IllegalArgumentExceptionif an object in the property path leading up to the target property isnull. @param object The object to be updated.- Specified by:
acceptin interfaceConsumer<T>- Throws:
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 isnullandignoreNull</code> is set to <code>false.
-
getPropertyName
Returns the name of the property which will be updated when thisClosureexecutes.- Returns:
- The name of the property which will be updated when this
Closureexecutes.
-
getPropertyValue
Returns the value that the property specified bypropertyNamewill be updated to when thisClosureexecutes.- Returns:
- The value that the property specified by
propertyNamewill be updated to when thisClosureexecutes.
-
isIgnoreNull
Returns the flag that determines whethernullobjects in the property path will generate anIllegalArgumentException</code> or not. If set to <code>truethen if any objects in the property path leading up to the target property evaluate tonull</code> then the <code>IllegalArgumentExceptionthrow byPropertyUtils</code> will be logged but not re-thrown. If set to <code>falsethen if any objects in the property path leading up to the target property evaluate tonull</code> then the <code>IllegalArgumentExceptionthrow byPropertyUtilswill be logged and re-thrown.- Returns:
- The flag that determines whether
nullobjects in the property path will generate anIllegalArgumentExceptionor not.
-