All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.parancoe.yaml.ReflectionUtil Maven / Gradle / Ivy

/*
 * Copyright (c) 2005, Yu Cheung Ho
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted 
 * provided that the following conditions are met:
 *
 *    * Redistributions of source code must retain the above copyright notice, this list of 
 *        conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright notice, this list 
 *        of conditions and the following disclaimer in the documentation and/or other materials 
 *        provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR 
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.parancoe.yaml;

import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.io.File;
import java.lang.reflect.Array;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.List;

class ReflectionUtil {

    /**
     * 
     * @param bean
     * @param key
     * @return
     */
    public static PropertyDescriptor getPropertyDescriptor(Class clazz, String key) {
        try {
            for (PropertyDescriptor prop : Introspector.getBeanInfo(clazz).getPropertyDescriptors())
                if (key.equals(prop.getName()))
                    return prop;
        } catch (IntrospectionException e) {
        }
        return null;
    }

    public static boolean hasProperty(Class clazz, String prop) {
        return null != getPropertyDescriptor(clazz, prop);
    }

    public static boolean hasProperty(Object obj, String prop) {
        return null != getPropertyDescriptor(obj.getClass(), prop);
    }

    /**
     * 
     * @param obj
     * @param key
     * @return
     */
    public static PropertyDescriptor getPropertyDescriptor(Object obj, String key) {
        return getPropertyDescriptor(obj.getClass(), key);
    }

    /**
     * 
     * @param bean
     * @return
     */
    public static List getProperties(Object bean) {
        try {
            return filterProps(Introspector.getBeanInfo(bean.getClass()).getPropertyDescriptors());
        } catch (IntrospectionException e) {
            throw new YamlParserException(e);
        }
    }

    public static List getPropertiesExcluding(List exclude, Object bean) {
        try {
            return filterProps(Introspector.getBeanInfo(bean.getClass()).getPropertyDescriptors(), exclude);
        } catch (IntrospectionException e) {
            throw new YamlParserException(e);
        }
    }

    public static List getFields(Object bean) {
        ArrayList ret = new ArrayList();
        Field[] fields = bean.getClass().getFields();
        for (Field field : fields)
            ret.add(field);
        return ret;
    }

    public static List getFieldsExcluding(List exclude, Object bean) {
        ArrayList ret = new ArrayList();
        Field[] fields = bean.getClass().getFields();
        for (Field field : fields)
            for (String toExclude : exclude)
                if (!toExclude.equals(field.getName()))
                    ret.add(field);
        return ret;
    }

    public static boolean isPublicMemberField(Field field) {
        return 0 == (~Modifier.PUBLIC & Modifier.STATIC & field.getModifiers());
    }

    /**
     * 
     * @param props
     * @return
     */
    static List filterProps(PropertyDescriptor[] props) {
        return filterProps(props, null);
    }

    /**
     * This method will filter properties down to the ones that have both read
     * and write methods.
     * 
     * @param props
     * @return
     */
    static List filterProps(PropertyDescriptor[] props, List exclude) {
        ArrayList ret = new ArrayList();
        for (PropertyDescriptor prop : props)
            if (exclude != null) {
                if (!"class".equals(prop.getName()))
                    for (String toExclude : exclude)
                        if (!toExclude.equals(prop.getName()))
                            ret.add(prop);
            } else if (prop.getReadMethod() != null && prop.getWriteMethod() != null)
                ret.add(prop);
        return ret;
    }

    /**
     * 
     * @param bean
     * @param key
     * @param value
     */
    public static void setProperty(Object bean, String key, Object value) {
        PropertyDescriptor prop = getPropertyDescriptor(bean, key);
        try {
            prop.getWriteMethod().invoke(bean, new Object[] { value });
        } catch (Exception e) {
            System.err.println("Can't set" + key + " property on " + bean + " with value ("
                    + value.getClass() + ")" + value + "\n" + e);
        }
    }

    /**
     * 
     * @param clazz
     * @param fieldname
     * @return
     */
    public static Class getFieldType(Class clazz, String fieldname) {
        try {
            Field field = clazz.getField(fieldname);
            return field.getType();
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 
     * @param obj
     * @param fieldname
     * @return
     */
    public static Object readField(Object obj, String fieldname) {
        try {
            Field field = obj.getClass().getField(fieldname);
            field.setAccessible(true);
            return field.get(obj);
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 
     * @param obj
     * @param fieldname
     * @param value
     */
    public static void setField(Object obj, String fieldname, Object value) {
        try {
            Field field = obj.getClass().getField(fieldname);
            field.setAccessible(true);
            field.set(obj, value);
        } catch (Exception e) {
            // ignore
        }
    }

    /**
     * 
     * @param clazz
     * @param argTypes
     * @param args
     * @return
     */
    public static Object invokeConstructor(Class clazz, Class[] argTypes, Object[] args) {
        Constructor constructor = ReflectionUtil.getConstructor(clazz, argTypes);
        try {
            Object newObject = constructor.newInstance(args);
            return newObject;
        } catch (Exception e) {
            throw new YamlParserException("Can't invoke constructor for " + clazz + " with arguments "
                    + Arrays.asList(argTypes) + " with values " + Arrays.asList(args));
        }
    }

    /**
     * 
     * @param clazz
     * @param argTypes
     * @return
     */
    public static Constructor getConstructor(Class clazz, Class[] argTypes) {
        try {
            return clazz.getConstructor(argTypes);
        } catch (Exception e) {
            throw new YamlParserException("Can't find constructor for " + clazz + " with arguments "
                    + Arrays.asList(argTypes) + "\n" + e);
        }

    }

    /**
     * 
     * @param name
     * @return
     */
    public static boolean isPrimitiveType(String name) {
        return Integer.TYPE.getName().equals(name) || Double.TYPE.getName().equals(name)
                || Float.TYPE.getName().equals(name) || Boolean.TYPE.getName().equals(name)
                || Character.TYPE.getName().equals(name) || Byte.TYPE.getName().equals(name)
                || Long.TYPE.getName().equals(name) || Short.TYPE.getName().equals(name);
    }

    /**
     * 
     * @param name
     * @return
     */
    public static Class getPrimitiveType(String name) {
        if (Integer.TYPE.getName().equals(name))
            return Integer.TYPE;
        else if (Double.TYPE.getName().equals(name))
            return Double.TYPE;
        else if (Float.TYPE.getName().equals(name))
            return Float.TYPE;
        else if (Boolean.TYPE.getName().equals(name))
            return Boolean.TYPE;
        else if (Character.TYPE.getName().equals(name))
            return Character.TYPE;
        else if (Byte.TYPE.getName().equals(name))
            return Byte.TYPE;
        else if (Long.TYPE.getName().equals(name))
            return Long.TYPE;
        else if (Short.TYPE.getName().equals(name))
            return Short.TYPE;
        else
            throw new YamlParserException(name + " is not a primitive type.");
    }

    public static boolean isArrayName(String classname) {
        return classname != null && classname.indexOf("[]") != -1;
    }

    public static String arrayComponentName(String classname) {
        return classname.substring(0, classname.length() - 2);
    }

    public static Class getArrayType(String arrayname) {
        if (isArrayName(arrayname))
            return getArrayTypeHelper(arrayname);
        else
            return null;
    }

    /**
     * assumes arrayType is an array type in the top level invocation
     * 
     * @param arrayType
     * @return
     */
    public static String arrayName(Class arrayType, YamlConfig config) {
        if (arrayType.isArray())
            return arrayName(arrayType.getComponentType(), config) + "[]";
        else
            return config.classname2transfer(arrayType.getName());
    }

    public static Class classForName(String classname) {
        if (isPrimitiveType(classname))
            return getPrimitiveType(classname);
        else if (isArrayName(classname))
            return getArrayType(classname);
        else
            try {
                return Class.forName(classname);
            } catch (Exception e) {
                return null;
            }
    }

    public static String transfer2classname(String transfer, YamlConfig config) {
        if (isArrayName(transfer)) {
            return transfer2classname(arrayComponentName(transfer), config) + "[]";
        } else
            return config.transfer2classname(transfer);
    }

    static Class getArrayTypeHelper(String classname) {
        if (!isArrayName(classname))
            return classForName(classname);
        else
            return Array.newInstance(getArrayTypeHelper(arrayComponentName(classname)), 0).getClass();
    }

    public static String className(Class clazz) {
        return className(clazz, new YamlConfig());
    }

    public static String className(Class clazz, YamlConfig config) {
        if (clazz.isArray())
            return arrayName(clazz, config);
        else
            return config.classname2transfer(clazz.getName());
    }

    public static boolean isSimpleType(Class c) {
        return c.isPrimitive() || c == String.class || c == Integer.class || c == Long.class || c == Short.class
                || c == Double.class || c == Float.class || c == Boolean.class || c == BigInteger.class
                || c == BigDecimal.class || c == Date.class || c.isEnum() || c == File.class;
    }

    public static boolean isCastableFrom(Class clazz, String expectedClassname) {
        Class expected = ReflectionUtil.classForName(expectedClassname);
        if (expected.isAssignableFrom(clazz))
            return true;
        else if (isPrimitiveType(expectedClassname)) {
            try {
                if (clazz.getField("TYPE").get(clazz) == expected)
                    return true;
            } catch (Exception e) {
            }
        }
        return false;
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy