core/org.eclipse.ptp.remote.core/src/org/eclipse/ptp/remote/IRemoteProcessBuilder.java

/*******************************************************************************
 * Copyright (c) 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * IBM Corporation - Initial API and implementation
 *******************************************************************************/
package org.eclipse.ptp.remote;

import java.io.IOException;
import java.util.List;
import java.util.Map;

import org.eclipse.core.filesystem.IFileStore;

public interface IRemoteProcessBuilder {

	/**
	 * Returns this process builder's connection.
	 * 
	 * @return
	 */
	public abstract IRemoteConnection connection();

	/**
	 * Sets this process builder's connection.
	 * 
	 * @return This process builder
	 */
	public abstract IRemoteProcessBuilder connection(
			IRemoteConnection conn);

	/**
	 * Returns this process builder's operating system program and arguments.
	 * 
	 * @return
	 */
	public abstract List<String> command();

	/**
	 * Sets this process builder's operating system program and arguments.
	 * 
	 * @param command
	 * @return This process builder
	 */
	public abstract IRemoteProcessBuilder command(List<String> command);

	/**
	 * Sets this process builder's operating system program and arguments.
	 * 
	 * @param command
	 * @return
	 */
	public abstract IRemoteProcessBuilder command(String... command);

	/**
	 * Returns this process builder's working directory.
	 * 
	 * @return
	 */
	public abstract IFileStore directory();

	/**
	 * Sets this process builder's working directory.
	 * 
	 * @param directory
	 * @return This process builder
	 */
	public abstract IRemoteProcessBuilder directory(IFileStore directory);

	/**
	 * Returns a string map view of this process builder's environment.
	 * 
	 * @return
	 */
	public abstract Map<String, String> environment();

	/**
	 * Tells whether this process builder merges standard error and standard
	 * output.
	 * 
	 * @return
	 */
	public abstract boolean redirectErrorStream();

	/**
	 * Sets this process builder's redirectErrorStream property.
	 * 
	 * @param redirectErrorStream
	 * @return This process builder
	 */
	public abstract IRemoteProcessBuilder redirectErrorStream(
			boolean redirectErrorStream);

	/**
	 * Starts a new process using the attributes of this process builder.
	 * 
	 * @return
	 */
	public abstract IRemoteProcess start() throws IOException;

	/**
	 * Starts a new process using the attributes of this process builder. Guarantess
	 * that the process will execute asynchronously with respect to the Java process 
	 * that owns the IRemoteProcess object.
	 * 
	 * @return
	 */
	public abstract IRemoteProcess asyncStart() throws IOException;

}