it.inspired.reflection.Reflection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation
Inspired utility classes
The newest version!
/*******************************************************************************
* Inspired Model Exporter is a framework to export data from pojo class.
* Copyright (C) 2016 Inspired Soft
* 
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see .    
*******************************************************************************/

package it.inspired.reflection;

import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.UndeclaredThrowableException;
import java.math.BigDecimal;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.beanutils.DynaProperty;
import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * This class contains some useful reflection methods.
 * 
 * @author Massimo Romano
 *
 */
@SuppressWarnings("unchecked")
public class Reflection {
	
	private static final Log log = LogFactory.getLog( Reflection.class );

	/**
	 * Get property value from an object.
	 * 
	 * @param object The object.
	 * @param property The property name.
	 * @return The property value.
	 */
	public static Object getProperty( Object object, String property ) {
		try {
			return PropertyUtils.getProperty( object, property );
		} catch( IllegalAccessException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( InvocationTargetException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( NoSuchMethodException ex ) {
			throw new InvalidPropertyException( property, ex );
		}
	}
	
	/**
	 * Set property value in an object.
	 * 
	 * @param object The object.
	 * @param property The property to name.
	 * @param value The value to set.
	 */
	public static void setProperty( Object object, String property, Object value ) {
		try {
			PropertyUtils.setProperty( object, property, value );
		} catch( IllegalAccessException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( InvocationTargetException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( NoSuchMethodException ex ) {
			throw new InvalidPropertyException( property, ex );
		}
	}

	/**
	 * Set a property value in an object.
	 * 
	 * @param object The object.
	 * @param propName The property name to set.
	 * @param propValue The value to set.
	 */
	public static void setStringProperty(Object object, String propName, String propValue )  {
		if ( object!=null ){
			PropertyDescriptor propDescr = Reflection.getPropertyDescriptor( object, propName );
			String propClass = propDescr.getPropertyType().getName();
			
			if ( "int".equals( propClass )  || "java.lang.Integer".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Integer( propValue ) );

			} else if ( "double".equals( propClass )  || "java.lang.Double".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Double( propValue ) );
			
			} else if ( "float".equals( propClass )  || "java.lang.Float".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Float( propValue ) );
			
			} else if ( "boolean".equals( propClass )  || "java.lang.Boolean".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Boolean( propValue ) );
			
			} else if ( "long".equals( propClass )  || "java.lang.Long".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Long( propValue ) );
			
			} else if ( "short".equals( propClass )  || "java.lang.Short".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Short( propValue ) );
			
			} else if ( "char".equals( propClass )  || "java.lang.Character".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Character( propValue.charAt( 0 ) ) );
			
			} else if ( "byte".equals( propClass )  || "java.lang.Byte".equals( propClass )  ){
					Reflection.setProperty( object, propName, new Byte( propValue ) );
			
			} else if ( "java.math.BigDecimal".equals( propClass )  ){
					Reflection.setProperty( object, propName, new BigDecimal( propValue ) );
			} else {	
					Reflection.setProperty( object, propName, propValue );
			}
		}									
	}

	/**
	 * Return the string value of a property in an object.
	 * 
	 * @param object The object.
	 * @param property The property to get.
	 * @return The property value.
	 */
	public static String getStringProperty( Object object, String property ) {
		try {
			return BeanUtils.getProperty( object, property );
		} catch( IllegalAccessException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( InvocationTargetException ex ) {
			throw new InvalidPropertyException( property, ex );
		} catch( NoSuchMethodException ex ) {
			throw new InvalidPropertyException( property, ex );
		}
	}

	/**
	 * Instantiate a class.
	 * 
	 * @param clazz The full class name to instantiate.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Class getClass( String clazz ) {
		try {
			return Class.forName( clazz );
		} catch( ClassNotFoundException ex ) {
			throw new RuntimeException( "Class not found: " + clazz, ex );
		} 
	}

	/**
	 * Instantiate a class.
	 * 
	 * @param clazz The full class name to instantiate.
	 * @return
	 */
	public static Object newInstance( String clazz ) {
		try {
			return Class.forName( clazz ).newInstance();
		} catch( ClassNotFoundException ex ) {
			throw new NewInstanceException( clazz, ex );
		} catch( InstantiationException ex ) {
			throw new NewInstanceException( clazz, ex );
		} catch( IllegalAccessException ex ) {
			throw new NewInstanceException( clazz, ex );
		}
	}

	/**
	 * Instantiate a class.
	 * 
	 * @param clazz The class type instantiate.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Object newInstance( Class clazz ) {
		try {
			return clazz.newInstance();
		} catch( InstantiationException ex ) {
			throw new NewInstanceException( clazz, ex );
		} catch( IllegalAccessException ex ) {
			throw new NewInstanceException( clazz, ex );
		}
	}
	
	/**
	 * Return the method descriptor.
	 * 
	 * @param methodName The method name.
	 * @param object The target object.
	 * @param parms The admitted method parameters.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Method getMethod( String methodName, Object object, Class[] parms ) {
		return getMethod( methodName, object.getClass(), parms );
	}
	
	/**
	 * Return the method descriptor.
	 * 
	 * @param methodName The method name.
	 * @param clazz The target class.
	 * @param parms The admitted method parameters.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Method getMethod( String methodName, Class clazz, Class[] parms ) {
		try {
			return clazz.getMethod( methodName, parms );
		} catch( SecurityException ex ) {
			throw new InvalidMethodException( methodName, clazz, ex);
		} catch( NoSuchMethodException ex ) {
			log.warn( ex.getLocalizedMessage() );
			return null;
		}
		
	}
	
	/**
	 * Return the method descriptor.
	 * Null value is returned if any error occurs.
	 * 
	 * @param methodName The method name.
	 * @param object The target object.
	 * @param parms The admitted method parameters.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Method findMethod( String methodName, Object object, Class[] parms ) {
		try {
			return getMethod( methodName, object, parms );
		} catch( InvalidMethodException ex ) {
			return null;
		}
	}

	/**
	 * Return the method descriptor.
	 * Null value is returned if any error occurs.
	 * 
	 * @param methodName The method name.
	 * @param clazz The target class.
	 * @param parms The admitted method parameters.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Method findMethod( String methodName, Class clazz, Class[] parms ) {
		try {
			return getMethod( methodName, clazz, parms );
		} catch( InvalidMethodException ex ) {
			return null;
		}
		
	}

	/**
	 * Invoke a method in an target object.
	 * 
	 * @param method The method to invoke.
	 * @param object The target object.
	 * @param args The method arguments.
	 * @return The value returned by the mothod invocation.
	 */
	public static Object invokeMethod( Method method, Object object, Object[] args ) {
		try {
			 return method.invoke( object, args );
		} catch( IllegalArgumentException ex ) {
			throw new InvocationException( method, ex );
		} catch( IllegalAccessException ex ) {
			throw new InvocationException( method, ex );
		} catch( InvocationTargetException ex ) {
			throw new InvocationException( method, ex );
		}
	}
	
	/**
	 * Return the descriptor for a property in a bean.
	 * 
	 * @param bean The target bean.
	 * @param propertyName The property name.
	 * @return
	 */
	public static PropertyDescriptor getPropertyDescriptor( Object bean, String propertyName ) {

		if( bean == null ) {
			throw new PropertyDescriptionException( propertyName );
		}
		try {
			return PropertyUtils.getPropertyDescriptor( bean, propertyName );
		} catch( IllegalAccessException ex ) {
			throw new PropertyDescriptionException( bean, propertyName, ex );
		} catch( InvocationTargetException ex ) {
			throw new PropertyDescriptionException( bean, propertyName, ex );
		} catch( NoSuchMethodException ex ) {
			throw new PropertyDescriptionException( bean, propertyName, ex );
		}
	}

	/**
	 * Return the property descriptor for all the properties in a bean.
	 *  
	 * @param bean The target bean.
	 * @return An array of descriptors.
	 */
	public static PropertyDescriptor[] getPropertyDescriptors( Object bean ) {
		return PropertyUtils.getPropertyDescriptors( bean );
	}
	
	/**
	 * Return the property descriptor for all the properties in a class.
	 *  
	 * @param clazz The target class.
	 * @return An array of descriptors.
	 */
	@SuppressWarnings("rawtypes")
	public static PropertyDescriptor[] getPropertyDescriptors( Class clazz ) {
		return PropertyUtils.getPropertyDescriptors( clazz );
	}
	
	/**
	 * Copy properties from source to destination bean.
	 * 
	 * @param destination Source bean.
	 * @param source Destination bean.
	 */
	public static void copyProperties( Object destination, Object source ) {
		try {
			BeanUtils.copyProperties( destination, source );
		} catch (IllegalAccessException e) {
			throw new RuntimeException( "Errore in copia", e );
		} catch (InvocationTargetException e) {
			throw new RuntimeException( "Errore in copia", e );
		}
	}

	/**
	 * Search in a collection the element having the specified property value.
	 * 
	 * @param coll The collection to search.
	 * @param property The property.
	 * @param value The property value to search.
	 * @param beanClazz The class of the element to return.
	 * @return
	 */
	@SuppressWarnings("rawtypes")
	public static Object searchBean( Collection coll, String property, Object value, Class beanClazz ) {
		if(coll==null)
			return null;
		Iterator elements = coll.iterator();
		while( elements.hasNext() ) {
			Object element = elements.next();
			Object cfr = Reflection.getProperty( element, property );

			if( cfr != null && cfr.equals( value ) && element.getClass().equals( beanClazz ) ) {
				return element;
			}
		}
		return null;
	}
	
	@SuppressWarnings("rawtypes")
	public static Object searchBean(Collection coll, String[] properties, Object obj, Class beanClazz ) {
		if(coll==null)
			return null;
		
		for(int i=0;i WRAPPER_TYPES = new HashSet(Arrays.asList( Boolean.class, Character.class, Byte.class, Short.class, Integer.class, Long.class, Float.class, Double.class, Void.class, String.class, Date.class, BigDecimal.class) );
   	@SuppressWarnings("rawtypes")
   	public static boolean isWrapperType(Class clazz) {
   	    return WRAPPER_TYPES.contains(clazz);
   	}
   	
   	/**
   	 * Recupera il valore di una proprieta' privata nell'oggetto specificato
   	 * @param obj
   	 * @param fieldName
   	 * @return
   	 */
   	public static Object getPrivateFieldValue(Object obj, String fieldName) {
   		try {
   			Field field = obj.getClass().getDeclaredField( fieldName ); 
   			field.setAccessible(true);
			return field.get(obj);
		} catch (IllegalArgumentException e) {
			log.error( e );		
		} catch (IllegalAccessException e) {
			log.error( e );	
		} catch (NoSuchFieldException e) {
			log.error( e );	
		} catch (SecurityException e) {
			log.error( e );	
		}
   		return null;
   	}


}