org.jarbframework.utils.bean.FlexibleBeanWrapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jarb-utils Show documentation
Provides common utilities
There is a newer version: 2.4.3
package org.jarbframework.utils.bean;

import static org.jarbframework.utils.Asserts.notNull;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.BeanWrapper;
import org.springframework.beans.BeanWrapperImpl;
import org.springframework.beans.DirectFieldAccessor;
import org.springframework.beans.NullValueInNestedPathException;
import org.springframework.beans.PropertyAccessor;

/**
 * Attempts to access properties based on the public
 * getter and setters methods. But whenever no matching
 * method could be found we access the field directly.
 *
 * @author Jeroen van Schagen
 * @date Aug 16, 2011
 */
public final class FlexibleBeanWrapper {
	
	private static final Logger LOGGER = LoggerFactory.getLogger(FlexibleBeanWrapper.class);
	
    private final T bean;

    private final BeanWrapper beanWrapper;
    
    private final PropertyAccessor fieldAccessor;

    private FlexibleBeanWrapper(T bean) {
        this.bean = notNull(bean, "Wrapped bean cannot be null.");
        this.beanWrapper = new BeanWrapperImpl(bean);
        this.fieldAccessor = new DirectFieldAccessor(bean);
    }

    /**
     * Wrap an existing bean with property modification behavior.
     * 
     * @param  type of bean
     * @param bean the bean being wrapped
     * @return modifiable bean, wrapping the specified bean
     */
    public static  FlexibleBeanWrapper wrap(T bean) {
        return new FlexibleBeanWrapper(bean);
    }

    /**
     * Build a new bean with property modification behavior.
     * 
     * @param  type of bean
     * @param beanClass class of the bean being created and wrapped
     * @return modifiable bean, wrapping a new bean instance
     */
    public static  FlexibleBeanWrapper instantiate(Class beanClass) {
        return wrap(BeanUtils.instantiateClass(beanClass));
    }

    public boolean isReadableProperty(String propertyName) {
        return beanWrapper.isReadableProperty(propertyName) || fieldAccessor.isReadableProperty(propertyName);
    }

    public Object getPropertyValue(String propertyName) {
        if (beanWrapper.isReadableProperty(propertyName)) {
            return beanWrapper.getPropertyValue(propertyName);
        } else {
            return fieldAccessor.getPropertyValue(propertyName);
        }
    }
    
    public Object getPropertyValueNullSafe(String propertyName) {
        Object value = null;
        try {
            value = getPropertyValue(propertyName);
        } catch (NullValueInNestedPathException e) {
            LOGGER.debug("Could not retrieve actual property value.", e);
        }
        return value;
    }

    public boolean isWritableProperty(String propertyName) {
        return beanWrapper.isWritableProperty(propertyName) || fieldAccessor.isWritableProperty(propertyName);
    }

    public FlexibleBeanWrapper setPropertyValue(String propertyName, Object value) {
        if (beanWrapper.isWritableProperty(propertyName)) {
            beanWrapper.setPropertyValue(propertyName, value);
        } else {
            fieldAccessor.setPropertyValue(propertyName, value);
        }
        return this;
    }

    public T getWrappedBean() {
        return bean;
    }
    
}