proposal/mutant/src/java/common/org/apache/ant/common/antlib/AntContext.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.common.antlib;
import java.io.File;
import org.apache.ant.common.util.ExecutionException;
import org.apache.ant.common.util.Location;

/**
 * The AntContext is the interface through which the Ant container and the
 * Ant components communicate. Common operations are provided directly in
 * this interface. Other core services are available through the generic
 * service objects supported by the core.
 *
 * @author <a href="mailto:conor@apache.org">Conor MacNeill</a>
 * @created 14 January 2002
 */
public interface AntContext {
    /**
     * Log a message
     *
     * @param message the message to be logged
     * @param level the priority level of the message
     */
    void log(String message, int level);

    /**
     * Get a instance of the specified service interface with which to
     * interact with the core.
     *
     * @param serviceInterfaceClass the class object for the required
     *      interface
     * @return an instance of the requested interface
     * @exception ExecutionException if the core service is not supported
     */
    Object getCoreService(Class serviceInterfaceClass)
         throws ExecutionException;

    /**
     * Get the basedir for the current execution
     *
     * @return the base directory for this execution of Ant
     */
    File getBaseDir();

    /**
     * Gets the location associated witj the AntContext
     *
     * @return the location
     */
    Location getLocation();
    
    /**
     * Get the classloader associated with this context
     *
     * @return a classloader instance.
     */
    ClassLoader getClassLoader();
}