package org.marketcetera.util.spring;

import org.marketcetera.util.misc.ClassVersion;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.factory.config.ConstructorArgumentValues;
import org.springframework.beans.factory.config.RuntimeBeanReference;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;

/**
 * Utilities for the Spring framework.
 *
 * @author tlerios@marketcetera.com
 * @since 0.5.0
 * @version $Id: SpringUtils.java 16841 2014-02-20 19:59:04Z colin $
 */

/* $License$ */

@ClassVersion("$Id: SpringUtils.java 16841 2014-02-20 19:59:04Z colin $")
public final class SpringUtils
{

    // CLASS METHODS.

    /**
     * Creates a string bean in the given application context. The new
     * bean has the given name and contains the given text value.
     *
     * @param context The context.
     * @param name The bean name.
     * @param value The text value.
     */

    public static void addStringBean(BeanDefinitionRegistry context,
                                     String name,
                                     String value)
    {
        RootBeanDefinition bean = new RootBeanDefinition(String.class);
        bean.setResourceDescription(SpringUtils.class.getName());
        ConstructorArgumentValues values = new ConstructorArgumentValues();
        values.addGenericArgumentValue(value);
        bean.setConstructorArgumentValues(values);
        context.registerBeanDefinition(name,
                                       bean);
    }
    /**
     * Creates a preferences configurer bean in the given application
     * context. The new bean has the given name and refers to another
     * bean with another given name for the properties' locations.
     *
     * @param inRegistry The context.
     * @param configurerName The bean name.
     * @param locationRef The name of the bean whose value is the
     * properties' locations (can be a string or a list).
     */

    public static void addPropertiesConfigurer(BeanDefinitionRegistry inRegistry,
                                               String configurerName,
                                               String locationRef)
    {
        RootBeanDefinition bean = new RootBeanDefinition(PropertySourcesPlaceholderConfigurer.class);
        bean.setResourceDescription(SpringUtils.class.getName());
        MutablePropertyValues values = new MutablePropertyValues();
        values.addPropertyValue("locations", //$NON-NLS-1$
                                new RuntimeBeanReference(locationRef));
        bean.setPropertyValues(values);
        inRegistry.registerBeanDefinition(configurerName,
                                          bean);
    }


    // CONSTRUCTOR.

    /**
     * Constructor. It is private so that no instances can be created.
     */

    private SpringUtils() {}
}