OrderedMethodCollector.java

/*
 * Copyright 2007 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License")
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.sf.beanlib.provider.collector;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;

import net.sf.beanlib.spi.BeanMethodCollector;
import net.sf.beanlib.utils.ClassUtils;

/**
 * Supports collecting JavaBean public setter methods. This class differs from the
 * {@link net.sf.beanlib.provider.collector.PublicSetterMethodCollector PublicSetterMethodCollector} in that
 * <ul>
 * <li>Immutable and {@link java.util.Date Date} property setter methods are placed before the other setter methods in
 * the returned {@link java.lang.reflect.Method Method} array; and</li>
 * <li>{@link java.util.Collection Collection} and {@link java.util.Map Map} setter methods are guaranteed to be placed
 * after the other setter methods in the returned {@link java.lang.reflect.Method Method} array.</li>
 * </ul>
 * 
 * @author Joe D. Velopar
 */
public class OrderedMethodCollector implements BeanMethodCollector {
    private final BeanMethodCollector beanMethodCollector;

    public OrderedMethodCollector() {
        beanMethodCollector = new PublicSetterMethodCollector();
    }

    public OrderedMethodCollector(BeanMethodCollector beanMethodCollector) {
        this.beanMethodCollector = beanMethodCollector;
    }

    @Override
    public Method[] collect(Object bean) {
        Method[] ma = beanMethodCollector.collect(bean);
        List<Method> leaveMethods = new ArrayList<Method>();
        List<Method> colMethods = new ArrayList<Method>();

        for (Method m : ma) {
            Class<?> paramType = m.getParameterTypes()[0];

            if (ClassUtils.immutable(paramType) || Date.class.isAssignableFrom(paramType))
                leaveMethods.add(m);
            else if (Collection.class.isAssignableFrom(paramType) || Map.class.isAssignableFrom(paramType))
                colMethods.add(m);
        }
        List<Method> methods = new ArrayList<Method>(Arrays.asList(ma));

        if (leaveMethods.size() == ma.length || colMethods.size() == ma.length)
            return ma;
        methods.removeAll(leaveMethods);
        methods.removeAll(colMethods);
        // The "methods" array now contain only the non-leave non-collection methods
        leaveMethods.addAll(methods);
        leaveMethods.addAll(colMethods);
        return leaveMethods.toArray(ma);
    }

    @Override
    public String getMethodPrefix() {
        return beanMethodCollector.getMethodPrefix();
    }
}