xyz.proteanbear.template.utils.ClassUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of PbPOITemplate Show documentation
The tools is created for easy use of Apache POI.
The newest version!
package xyz.proteanbear.template.utils;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Class related tools.
 *
 * @author ProteanBear
 */
public class ClassUtils
{
    /**
     * generate title — getMethod map by annotation
     *
     * @param annotationClass the annotation class
     * @param ofClass         the primary class
     * @param              the type of the annotation
     * @param              the type of the annotation
     * @return the hash map for the annotation object to the method
     * @throws NoSuchMethodException No such method
     */
    public static  Map titleMapGetMethodBy(
            Class annotationClass, Class ofClass
    )
            throws NoSuchMethodException
    {
        Map result = new LinkedHashMap<>();

        //All fields
        Field[] fields = ofClass.getDeclaredFields();
        T annotation;
        for (Field field : fields)
        {
            //Get annotation
            annotation = field.getAnnotation(annotationClass);

            //Annotation is null
            if (annotation == null) continue;
            //field's setter method
            result.put(annotation, methodGetterOf(field, ofClass));
        }

        return result;
    }

    /**
     * generate title — setMethod map by annotation
     *
     * @param annotationClass    the annotation class
     * @param ofClass            the primary class
     * @param titleMapAnnotation the map for title — annotation object
     * @param                 the annotation
     * @param                 the annotation
     * @return the hash map for valueKey to the method
     * @throws NoSuchMethodException     No such method
     * @throws InvocationTargetException Invocation target
     * @throws IllegalAccessException    Illegal access
     */
    public static  Map titleMapSetMethodBy(
            Class annotationClass, Class ofClass,
            Map titleMapAnnotation
    )
            throws NoSuchMethodException, InvocationTargetException, IllegalAccessException
    {
        Map result = new LinkedHashMap<>();

        //All fields
        Field[] fields = ofClass.getDeclaredFields();
        Method valueMethod;
        Object annotation;
        String method;
        for (Field field : fields)
        {
            //Get annotation
            annotation = field.getAnnotation(annotationClass);

            //Annotation is null
            if (annotation == null) continue;
            //Annotation's value method
            valueMethod = annotationClass.getMethod("value");
            //method
            method = (String) valueMethod.invoke(annotation);
            //field's setter method
            result.put(method, methodSetterOf(field, ofClass));
            //annotation
            titleMapAnnotation.put(method, annotation);
        }

        return result;
    }

    /**
     * generate title — getMethod map by annotation
     *
     * @param annotationClass the annotation class
     * @param data            data objects with template variables declared by annotations
     * @param              annotation type
     * @return the hash map for the annotation value() to the data content
     * @throws NoSuchMethodException     No such method
     * @throws InvocationTargetException Invocation target
     * @throws IllegalAccessException    Illegal access
     */
    public static  Map dataMapBy(Class annotationClass, Object data)
            throws NoSuchMethodException, InvocationTargetException, IllegalAccessException
    {
        return dataMapBy(annotationClass, data, null);
    }

    /**
     * generate title — getMethod map by annotation
     *
     * @param annotationClass the annotation class
     * @param data            data objects with template variables declared by annotations
     * @return the hash map for the annotation value() to the data content
     * @throws NoSuchMethodException     No such method
     * @throws InvocationTargetException Invocation target
     * @throws IllegalAccessException    Illegal access
     */
    public static  Map dataMapBy(
            Class annotationClass, Object data, Wrapper wrapper
    )
            throws NoSuchMethodException, InvocationTargetException, IllegalAccessException
    {
        Map result = new HashMap<>();

        //All fields
        Class dataClass = data.getClass();
        Field[] fields = dataClass.getDeclaredFields();
        T annotation;
        Method valueMethod, getMethod;
        String method;
        for (Field field : fields)
        {
            //Get annotation
            annotation = field.getAnnotation(annotationClass);

            //Annotation is null
            if (annotation == null) continue;
            //Annotation's value method
            valueMethod = annotationClass.getMethod("value");
            //method
            method = (String) valueMethod.invoke(annotation);
            //field's getter method
            getMethod = methodGetterOf(field, dataClass);

            result.put(
                    method,
                    (wrapper != null ? wrapper.wrap(annotation, getMethod.invoke(data)) : getMethod.invoke(data))
            );
        }

        return result;
    }

    /**
     * Get setter method of field
     *
     * @param fieldName The class field name string
     * @param ofClass   The class
     * @return The field's getter method
     * @throws NoSuchMethodException No such method
     * @throws NoSuchFieldException  No such field
     */
    public static  Method methodGetterOf(String fieldName, Class ofClass)
            throws NoSuchMethodException, NoSuchFieldException
    {
        return methodGetterOf(ofClass.getDeclaredField(fieldName), ofClass);
    }

    /**
     * Get setter method of field
     *
     * @param field   The class field
     * @param ofClass The class
     * @param      the type of the field
     * @return The field's getter method
     * @throws NoSuchMethodException No such method
     */
    private static  Method methodGetterOf(Field field, Class ofClass) throws NoSuchMethodException
    {
        String name = field.getName();
        String methodName = "get" +
                String.valueOf(name.charAt(0))
                      .toUpperCase() +
                (name.length() > 1 ? name.substring(1) : "");
        return ofClass.getMethod(methodName);
    }

    /**
     * Get setter method of field
     *
     * @param field   The class field
     * @param ofClass The class
     * @return The field's getter method
     * @throws NoSuchMethodException No such method
     */
    private static  Method methodSetterOf(Field field, Class ofClass) throws NoSuchMethodException
    {
        String name = field.getName();
        String methodName = "set" +
                String.valueOf(name.charAt(0))
                      .toUpperCase() +
                (name.length() > 1 ? name.substring(1) : "");
        return ofClass.getMethod(methodName, field.getType());
    }

    /**
     * Wrapper
     */
    public interface Wrapper
    {
        /**
         * @param annotation the annotation
         * @param data       the data
         * @param         the type of the data
         * @return Return the wrapped object.
         */
         Object wrap(T annotation, Object data);
    }
}