/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2009 by Red Hat Inc and/or its affiliates or by
 * third-party contributors as indicated by either @author tags or express
 * copyright attribution statements applied by the authors.  All
 * third-party contributions are distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.property;

import java.beans.Introspector;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.util.Map;

import org.hibernate.HibernateException;
import org.hibernate.PropertyAccessException;
import org.hibernate.PropertyNotFoundException;
import org.hibernate.PropertySetterAccessException;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.internal.CoreLogging;
import org.hibernate.internal.CoreMessageLogger;
import org.hibernate.internal.util.ReflectHelper;

import org.jboss.logging.Logger;

Accesses property values via a get/set pair, which may be nonpublic. The default (and recommended strategy).
Author:Gavin King
/** * Accesses property values via a get/set pair, which may be nonpublic. * The default (and recommended strategy). * * @author Gavin King */
public class BasicPropertyAccessor implements PropertyAccessor { private static final CoreMessageLogger LOG = CoreLogging.messageLogger( BasicPropertyAccessor.class ); public static final class BasicSetter implements Setter { private Class clazz; private final transient Method method; private final String propertyName; private BasicSetter(Class clazz, Method method, String propertyName) { this.clazz=clazz; this.method=method; this.propertyName=propertyName; } @Override public void set(Object target, Object value, SessionFactoryImplementor factory) throws HibernateException { try { method.invoke( target, value ); } catch (NullPointerException npe) { if ( value==null && method.getParameterTypes()[0].isPrimitive() ) { throw new PropertyAccessException( npe, "Null value was assigned to a property of primitive type", true, clazz, propertyName ); } else { throw new PropertyAccessException( npe, "NullPointerException occurred while calling", true, clazz, propertyName ); } } catch (InvocationTargetException ite) { throw new PropertyAccessException( ite, "Exception occurred inside", true, clazz, propertyName ); } catch (IllegalAccessException iae) { throw new PropertyAccessException( iae, "IllegalAccessException occurred while calling", true, clazz, propertyName ); //cannot occur } catch (IllegalArgumentException iae) { if ( value==null && method.getParameterTypes()[0].isPrimitive() ) { throw new PropertyAccessException( iae, "Null value was assigned to a property of primitive type", true, clazz, propertyName ); } else { final Class expectedType = method.getParameterTypes()[0]; LOG.illegalPropertySetterArgument( clazz.getName(), propertyName ); LOG.expectedType( expectedType.getName(), value == null ? null : value.getClass().getName() ); throw new PropertySetterAccessException( iae, clazz, propertyName, expectedType, target, value ); } } } @Override public Method getMethod() { return method; } @Override public String getMethodName() { return method.getName(); } Object readResolve() { return createSetter(clazz, propertyName); } @Override public String toString() { return "BasicSetter(" + clazz.getName() + '.' + propertyName + ')'; } } public static final class BasicGetter implements Getter { private Class clazz; private final transient Method method; private final String propertyName; private BasicGetter(Class clazz, Method method, String propertyName) { this.clazz=clazz; this.method=method; this.propertyName=propertyName; } @Override public Object get(Object target) throws HibernateException { try { return method.invoke( target, (Object[]) null ); } catch (InvocationTargetException ite) { throw new PropertyAccessException( ite, "Exception occurred inside", false, clazz, propertyName ); } catch (IllegalAccessException iae) { throw new PropertyAccessException( iae, "IllegalAccessException occurred while calling", false, clazz, propertyName ); //cannot occur } catch (IllegalArgumentException iae) { LOG.illegalPropertyGetterArgument(clazz.getName(), propertyName); throw new PropertyAccessException( iae, "IllegalArgumentException occurred calling", false, clazz, propertyName ); } } @Override public Object getForInsert(Object target, Map mergeMap, SessionImplementor session) { return get( target ); } @Override public Class getReturnType() { return method.getReturnType(); } @Override public Member getMember() { return method; } @Override public Method getMethod() { return method; } @Override public String getMethodName() { return method.getName(); } @Override public String toString() { return "BasicGetter(" + clazz.getName() + '.' + propertyName + ')'; } Object readResolve() { return createGetter(clazz, propertyName); } } @Override public Setter getSetter(Class theClass, String propertyName) throws PropertyNotFoundException { return createSetter(theClass, propertyName); } private static Setter createSetter(Class theClass, String propertyName) throws PropertyNotFoundException { BasicSetter result = getSetterOrNull(theClass, propertyName); if (result==null) { throw new PropertyNotFoundException( "Could not find a setter for property " + propertyName + " in class " + theClass.getName() ); } return result; } private static BasicSetter getSetterOrNull(Class theClass, String propertyName) { if (theClass==Object.class || theClass==null) return null; Method method = setterMethod(theClass, propertyName); if (method!=null) { method.setAccessible(true); return new BasicSetter(theClass, method, propertyName); } else { BasicSetter setter = getSetterOrNull( theClass.getSuperclass(), propertyName ); if (setter==null) { Class[] interfaces = theClass.getInterfaces(); for ( int i=0; setter==null && i<interfaces.length; i++ ) { setter=getSetterOrNull( interfaces[i], propertyName ); } } return setter; } } private static Method setterMethod(Class theClass, String propertyName) { BasicGetter getter = getGetterOrNull(theClass, propertyName); Class returnType = (getter==null) ? null : getter.getReturnType(); Method[] methods = theClass.getDeclaredMethods(); Method potentialSetter = null; for ( Method method : methods ) { final String methodName = method.getName(); if ( method.getParameterTypes().length == 1 && methodName.startsWith( "set" ) ) { String testStdMethod = Introspector.decapitalize( methodName.substring( 3 ) ); String testOldMethod = methodName.substring( 3 ); if ( testStdMethod.equals( propertyName ) || testOldMethod.equals( propertyName ) ) { potentialSetter = method; if ( returnType == null || method.getParameterTypes()[0].equals( returnType ) ) { return potentialSetter; } } } } return potentialSetter; } @Override public Getter getGetter(Class theClass, String propertyName) throws PropertyNotFoundException { return createGetter(theClass, propertyName); } public static Getter createGetter(Class theClass, String propertyName) throws PropertyNotFoundException { BasicGetter result = getGetterOrNull(theClass, propertyName); if (result==null) { throw new PropertyNotFoundException( "Could not find a getter for " + propertyName + " in class " + theClass.getName() ); } return result; } private static BasicGetter getGetterOrNull(Class theClass, String propertyName) { if (theClass==Object.class || theClass==null) { return null; } Method method = getterMethod(theClass, propertyName); if (method!=null) { method.setAccessible(true); return new BasicGetter(theClass, method, propertyName); } else { BasicGetter getter = getGetterOrNull( theClass.getSuperclass(), propertyName ); if (getter==null) { Class[] interfaces = theClass.getInterfaces(); for ( int i=0; getter==null && i<interfaces.length; i++ ) { getter=getGetterOrNull( interfaces[i], propertyName ); } } return getter; } } private static Method getterMethod(Class theClass, String propertyName) { Method[] methods = theClass.getDeclaredMethods(); for ( Method method : methods ) { // if the method has parameters, skip it if ( method.getParameterTypes().length != 0 ) { continue; } // if the method is a "bridge", skip it if ( method.isBridge() ) { continue; } final String methodName = method.getName(); // try "get" if ( methodName.startsWith( "get" ) ) { String testStdMethod = Introspector.decapitalize( methodName.substring( 3 ) ); String testOldMethod = methodName.substring( 3 ); if ( testStdMethod.equals( propertyName ) || testOldMethod.equals( propertyName ) ) { return method; } } // if not "get", then try "is" if ( methodName.startsWith( "is" ) ) { String testStdMethod = Introspector.decapitalize( methodName.substring( 2 ) ); String testOldMethod = methodName.substring( 2 ); if ( testStdMethod.equals( propertyName ) || testOldMethod.equals( propertyName ) ) { return method; } } } return null; } }