org.apache.commons.beanutils.BeanToPropertyValueTransformer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.beanutils;
import org.apache.commons.collections.Transformer;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.lang.reflect.InvocationTargetException;
/**
* Transformer that outputs a property value.
*
* An implementation of org.apache.commons.collections.Transformer that transforms
* the object provided by returning the value of a specified property of the object. The
* constructor for BeanToPropertyValueTransformer requires the name of the property
* that will be used in the transformation. The property 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 transformer
* BeanToPropertyValueTransformer transformer = new BeanToPropertyValueTransformer( "person.address.city" );
*
* // transform the Collection
* Collection peoplesCities = CollectionUtils.collect( peopleCollection, transformer );
*
*
*
* This would take a Collection of person objects and return a Collection
* of objects which represents the cities in which each person lived. Assuming...
*
* -
* The top level object in the
peeopleCollection is an object which represents a
* person.
*
* -
* The person object has a
getAddress() method which returns an object which
* represents a person's address.
*
* -
* The address object has a
getCity() method which returns an object which
* represents the city in which a person lives.
*
*
*
* @version $Id: BeanToPropertyValueTransformer.java 1454597 2013-03-08 21:58:12Z britter $
* @see org.apache.commons.beanutils.PropertyUtils
* @see org.apache.commons.collections.Transformer
*/
public class BeanToPropertyValueTransformer implements Transformer {
/** For logging. */
private final Log log = LogFactory.getLog(this.getClass());
/** The name of the property that will be used in the transformation of the object. */
private String propertyName;
/**
* Should null objects on the property path throw an IllegalArgumentException?
*
* 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 evaluate to null then the
* IllegalArgumentException throw by PropertyUtils will be logged but
* not rethrown and null will be returned. If set to false then if any
* objects in the property path evaluate to null then the
* IllegalArgumentException throw by PropertyUtils will be logged and
* rethrown.
*
*/
private boolean ignoreNull;
/**
* Constructs a Transformer which does not ignore nulls.
* Constructor which takes the name of the property that will be used in the transformation and
* assumes ignoreNull to be false.
*
* @param propertyName The name of the property that will be used in the transformation.
* @throws IllegalArgumentException If the propertyName is null or
* empty.
*/
public BeanToPropertyValueTransformer(String propertyName) {
this(propertyName, false);
}
/**
* Constructs a Transformer and sets ignoreNull.
* Constructor which takes the name of the property that will be used in the transformation and
* a boolean which determines whether null objects in the property path will
* genenerate an IllegalArgumentException or not.
*
* @param propertyName The name of the property that will be used in the transformation.
* @param ignoreNull Determines whether null objects in the property path will
* genenerate an IllegalArgumentException or not.
* @throws IllegalArgumentException If the propertyName is null or
* empty.
*/
public BeanToPropertyValueTransformer(String propertyName, boolean ignoreNull) {
super();
if ((propertyName != null) && (propertyName.length() > 0)) {
this.propertyName = propertyName;
this.ignoreNull = ignoreNull;
} else {
throw new IllegalArgumentException(
"propertyName cannot be null or empty");
}
}
/**
* Returns the value of the property named in the transformer's constructor for
* the object provided. 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.
*
* @param object The object to be transformed.
* @return The value of the property named in the transformer's constructor for the object
* provided.
* @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 is null and
* ignoreNull is set to false.
*/
public Object transform(Object object) {
Object propertyValue = null;
try {
propertyValue = PropertyUtils.getProperty(object, propertyName);
} catch (IllegalArgumentException e) {
final String errorMsg = "Problem during transformation. Null value encountered in property path...";
if (ignoreNull) {
log.warn("WARNING: " + errorMsg + e);
} else {
IllegalArgumentException iae = new IllegalArgumentException(errorMsg);
if (!BeanUtils.initCause(iae, e)) {
log.error(errorMsg, e);
}
throw iae;
}
} catch (IllegalAccessException e) {
final String errorMsg = "Unable to access the property provided.";
IllegalArgumentException iae = new IllegalArgumentException(errorMsg);
if (!BeanUtils.initCause(iae, e)) {
log.error(errorMsg, e);
}
throw iae;
} catch (InvocationTargetException e) {
final String errorMsg = "Exception occurred in property's getter";
IllegalArgumentException iae = new IllegalArgumentException(errorMsg);
if (!BeanUtils.initCause(iae, e)) {
log.error(errorMsg, e);
}
throw iae;
} catch (NoSuchMethodException e) {
final String errorMsg = "No property found for name [" +
propertyName + "]";
IllegalArgumentException iae = new IllegalArgumentException(errorMsg);
if (!BeanUtils.initCause(iae, e)) {
log.error(errorMsg, e);
}
throw iae;
}
return propertyValue;
}
/**
* Returns the name of the property that will be used in the transformation of the bean.
*
* @return The name of the property that will be used in the transformation of the bean.
*/
public String getPropertyName() {
return propertyName;
}
/**
* Returns the flag which 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 evaluate to null then the
* IllegalArgumentException throw by PropertyUtils will be logged but
* not rethrown and null will be returned. If set to false then if any
* objects in the property path evaluate to null then the
* IllegalArgumentException throw by PropertyUtils will be logged and
* rethrown.
*
* @return The flag which determines whether null objects in the property path will
* genenerate an IllegalArgumentException or not.
*/
public boolean isIgnoreNull() {
return ignoreNull;
}
}