IActionContext.java

/*****************************************************************************
 * Copyright (c) 2006-2013, Cloudsmith Inc.
 * The code, documentation and other materials contained herein have been
 * licensed under the Eclipse Public License - v 1.0 by the copyright holder
 * listed above, as the Initial Contributor under such license. The text of
 * such license is available at www.eclipse.org.
 *****************************************************************************/
package org.eclipse.buckminster.core.actor;

import java.io.File;
import java.io.PrintStream;
import java.util.Map;

import org.eclipse.buckminster.core.cspec.PathGroup;
import org.eclipse.buckminster.core.cspec.model.Action;
import org.eclipse.buckminster.core.cspec.model.CSpec;
import org.eclipse.buckminster.core.metadata.model.IModelCache;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;

public interface IActionContext extends IModelCache {
	/**
	 * Add all named prerequisite path groups
	 *
	 * @param pgas
	 *            The map that will receive the groups
	 * @throws CoreException
	 */
	void addPrerequisitePathGroups(Map<String, PathGroup[]> pgas) throws CoreException;

	/**
	 * Returns the action.
	 *
	 * @return The action associated with this context
	 */
	Action getAction();

	/**
	 * Returns a progress monitor that can be used for cancellation purposes.
	 *
	 * @return A progress monitor
	 */
	IProgressMonitor getCancellationMonitor();

	/**
	 * Returns the component location as an file system absolute path
	 *
	 * @return The absolute path in the file system to the component.
	 * @throws CoreException
	 */
	IPath getComponentLocation() throws CoreException;

	/**
	 * Returns the component specification
	 *
	 * @return The CSPEC
	 */
	CSpec getCSpec() throws CoreException;

	/**
	 * Returns the stream that should be used for error messages.
	 *
	 * @return A stream for error messages.
	 */
	PrintStream getErrorStream();

	/**
	 * Returns the global context for this execution
	 *
	 * @return The global context
	 */
	IGlobalContext getGlobalContext();

	/**
	 * Returns all named path group arrays for the invocation.
	 *
	 * @return An map of named path group arrays.
	 * @throws CoreException
	 */
	Map<String, PathGroup[]> getNamedPathGroupArrays() throws CoreException;

	/**
	 * Returns the stream that should be used for information and debug
	 * messages.
	 *
	 * @return A stream for information and debug messages.
	 */
	PrintStream getOutputStream();

	/**
	 * Returns the project that this context maps to if applicable.
	 *
	 * @return The project or <code>null</code> if component is not a project.
	 */
	IProject getProject() throws CoreException;

	/**
	 * Returns <code>true</code> if the action is forced. An action that is
	 * forced is executed regardless of if the product is newer then all
	 * prerequisites.
	 *
	 * @return <code>true</code> if the build is forced.
	 */
	boolean isForced();

	/**
	 * Returns <code>true</code> if the perform was issued with the quite flag
	 * set to true.
	 *
	 * @return <code>true</code> if the build is quite.
	 */
	boolean isQuiet();

	/**
	 * Return the absolute path of <code>path</code>. If path is already
	 * absolut, it is returend unaltered. If it is relative it will be made
	 * absolute using the component root.
	 *
	 * @param path
	 *            The path to make absolute. Cannot be <code>null</code>.
	 * @return An absolute path.
	 * @throws CoreException
	 */
	File makeAbsolute(File path) throws CoreException;

	/**
	 * Return the absolute path of <code>path</code>. If path is already
	 * absolut, it is returend unaltered. If it is relative it will be made
	 * absolute using the component root.
	 *
	 * @param path
	 *            The path to make absolute. Cannot be <code>null</code>.
	 * @return An absolute path.
	 * @throws CoreException
	 */
	IPath makeAbsolute(IPath path) throws CoreException;
}