/* ====================================================================
*
* The ObjectStyle Group Software License, Version 1.0
*
* Copyright (c) 2005 The ObjectStyle Group,
* and individual authors of the software. 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
* ObjectStyle Group (http://objectstyle.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "ObjectStyle Group" and "Cayenne"
* must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact andrus@objectstyle.org.
*
* 5. Products derived from this software may not be called "ObjectStyle"
* nor may "ObjectStyle" appear in their names without prior written
* permission of the ObjectStyle 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 OBJECTSTYLE GROUP 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 ObjectStyle Group. For more
* information on the ObjectStyle Group, please see
* <http://objectstyle.org/>.
*
*/
package org.objectstyle.wolips.core.resources.builder;
import java.util.Map;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
public interface IBuilder {
public abstract boolean isEnabled();
/**
* Called when a build is about to begin.
*
* @param kind
* the kind of build that is happening
* (IncrementalProjectBuild.AUTO/FULL/INCREMENTAL/CLEAN)
* @param args
* builder arguments
* @param monitor
* the progress monitor to report status through
* @param project
* the project that is being built
* @param buildCache
* a cache that can be used by builders that lasts for a single
* build cycle
* @return whether or not this builder is requesting to have a full build
* happen when this build is done (only an IDeltaBuilder should
* return true from this)
*/
public abstract boolean buildStarted(int kind, Map args, IProgressMonitor monitor, IProject project, Map buildCache);
/**
* Called when all the preparations for building are complete. Some builders
* may choose not to actually do anything until this method is called.
*
* @param kind
* the kind of build that is happening
* (IncrementalProjectBuild.AUTO/FULL/INCREMENTAL/CLEAN)
* @param args
* builder arguments
* @param monitor
* the progress monitor to report status through
* @param project
* the project that is being built
* @param buildCache
* a cache that can be used by builders that lasts for a single
* build cycle
* @return whether or not this builder is requesting to have a full build
* happen when this build is done (only an IDeltaBuilder should
* return true from this)
*/
public abstract boolean buildPreparationDone(int kind, Map args, IProgressMonitor monitor, IProject project, Map buildCache);
}