proposal/mutant/src/java/init/org/apache/ant/init/InitConfig.java

/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Ant", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
 * ITS 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.ant.init;

import java.net.URL;
import java.io.File;

/**
 * InitConfig is the initialization configuration created to start Ant. This
 * is passed to the front end when Ant is started.
 *
 * @author <a href="mailto:conor@apache.org">Conor MacNeill</a>
 * @created 9 January 2002
 */
public class InitConfig {
    /** The system classloader */
    private ClassLoader systemLoader;

    /**
     * The common class loader loads components which are common to tasks
     * and the core
     */
    private ClassLoader commonLoader;

    /**
     * The core loader is the loader which loads classes which are
     * exclusively used by the Ant core
     */
    private ClassLoader coreLoader;

    /**
     * The tools.jar URL is available for things which require the Sun tools
     * jar
     */
    private URL toolsJarURL;

    /**
     * The URLs to the Ant XML parser. These are available to allow tasks
     * which require XML support to use the standard parser rather than
     * having to supply their own
     */
    private URL[] parserURLs;

    /**
     * The location of the Ant library directory from which tasks may be
     * loaded
     */
    private URL libraryURL;

    /** The location of the system configuration file */
    private File systemConfigArea;

    /** The location of ANT_HOME */
    private URL antHome;

    /** The location of the user config file */
    private File userConfigArea;

    /**
     * Sets the location of the user configuration files
     *
     * @param userConfigArea the new user config area
     */
    public void setUserConfigArea(File userConfigArea) {
        this.userConfigArea = userConfigArea;
    }

    /**
     * Set the location of ANT_HOME
     *
     * @param antHome the new value of ANT_HOME
     */
    public void setAntHome(URL antHome) {
        this.antHome = antHome;
    }

    /**
     * Sets the location of the system configuration files
     *
     * @param systemConfigArea the new system config area
     */
    public void setSystemConfigArea(File systemConfigArea) {
        this.systemConfigArea = systemConfigArea;
    }

    /**
     * Sets the systemLoader of the InitConfig
     *
     * @param systemLoader the new systemLoader value
     */
    public void setSystemLoader(ClassLoader systemLoader) {
        this.systemLoader = systemLoader;
    }

    /**
     * Sets the commonLoader of the InitConfig
     *
     * @param commonLoader the new commonLoader value
     */
    public void setCommonLoader(ClassLoader commonLoader) {
        this.commonLoader = commonLoader;
    }

    /**
     * Sets the coreLoader of the InitConfig
     *
     * @param coreLoader the new coreLoader value
     */
    public void setCoreLoader(ClassLoader coreLoader) {
        this.coreLoader = coreLoader;
    }

    /**
     * Sets the toolsJarURL of the InitConfig
     *
     * @param toolsJarURL the new toolsJarURL value
     */
    public void setToolsJarURL(URL toolsJarURL) {
        this.toolsJarURL = toolsJarURL;
    }

    /**
     * Sets the parserURLs of the InitConfig
     *
     * @param parserURLs the new parserURLs value
     */
    public void setParserURLs(URL[] parserURLs) {
        this.parserURLs = parserURLs;
    }

    /**
     * Sets the libraryURL of the InitConfig
     *
     * @param libraryURL the new libraryURL value
     */
    public void setLibraryURL(URL libraryURL) {
        this.libraryURL = libraryURL;
    }

    /**
     * Get the location of the user's config files
     *
     * @return the location of the user's Ant config files
     */
    public File getUserConfigArea() {
        return userConfigArea;
    }

    /**
     * Get the location of Ant's home area
     *
     * @return the location of ANT_HOME
     */
    public URL getAntHome() {
        return antHome;
    }

    /**
     * Get the location of the system config files
     *
     * @return the location of the system Ant config files
     */
    public File getSystemConfigArea() {
        return systemConfigArea;
    }

    /**
     * Gets the systemLoader of the InitConfig
     *
     * @return the systemLoader value
     */
    public ClassLoader getSystemLoader() {
        return systemLoader;
    }

    /**
     * Gets the commonLoader of the InitConfig
     *
     * @return the commonLoader value
     */
    public ClassLoader getCommonLoader() {
        return commonLoader;
    }

    /**
     * Gets the coreLoader of the InitConfig
     *
     * @return the coreLoader value
     */
    public ClassLoader getCoreLoader() {
        return coreLoader;
    }

    /**
     * Gets the toolsJarURL of the InitConfig
     *
     * @return the toolsJarURL value
     */
    public URL getToolsJarURL() {
        return toolsJarURL;
    }

    /**
     * Gets the parserURLs of the InitConfig
     *
     * @return the parserURLs value
     */
    public URL[] getParserURLs() {
        return parserURLs;
    }

    /**
     * Gets the libraryURL of the InitConfig
     *
     * @return the libraryURL value
     */
    public URL getLibraryURL() {
        return libraryURL;
    }
}