com.facebook.buck.util

Class DefaultProcessExecutor

java.lang.Object

com.facebook.buck.util.DefaultProcessExecutor

All Implemented Interfaces:

ProcessExecutor

public class DefaultProcessExecutor
extends Object
implements ProcessExecutor

Executes a Process and blocks until it is finished.

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.util.ProcessExecutor

ProcessExecutor.LaunchedProcess, ProcessExecutor.LaunchedProcessImpl, ProcessExecutor.Option, ProcessExecutor.Result

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultProcessExecutor(Console console) Creates a new DefaultProcessExecutor with the specified parameters used for writing the output of the process.
protected	DefaultProcessExecutor(PrintStream stdOutStream, PrintStream stdErrStream, Ansi ansi, ProcessHelper processHelper, ProcessRegistry processRegistry)

Method Summary

Modifier and Type	Method and Description
ProcessExecutor	cloneWithOutputStreams(PrintStream newStdOutStream, PrintStream newStdErrStream) Makes a clone of this process executor with the stdout and stderr streams overridden.
void	destroyLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess) Terminates a process previously returned by ProcessExecutor.launchProcess(ProcessExecutorParams).
ProcessExecutor.Result	execute(ProcessExecutor.LaunchedProcess launchedProcess, Set<ProcessExecutor.Option> options, Optional<String> stdin, Optional<Long> timeOutMs, Optional<java.util.function.Consumer<Process>> timeOutHandler) Executes the specified already-launched process.
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params) Convenience method for ProcessExecutor.launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional) with boolean values set to false and optional values set to absent.
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context)
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context, Set<ProcessExecutor.Option> options, Optional<String> stdin, Optional<Long> timeOutMs, Optional<java.util.function.Consumer<Process>> timeOutHandler)
ProcessExecutor.Result	launchAndExecute(ProcessExecutorParams params, Set<ProcessExecutor.Option> options, Optional<String> stdin, Optional<Long> timeOutMs, Optional<java.util.function.Consumer<Process>> timeOutHandler) Launches then executes a process with the specified params.
ProcessExecutor.LaunchedProcess	launchProcess(ProcessExecutorParams params) Launches a Process given ProcessExecutorParams.
ProcessExecutor.LaunchedProcess	launchProcess(ProcessExecutorParams params, com.google.common.collect.ImmutableMap<String,String> context)
ProcessExecutor.Result	waitForLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess) Blocks while waiting for a process previously returned by ProcessExecutor.launchProcess(ProcessExecutorParams) to exit, then returns the exit code of the process.
ProcessExecutor.Result	waitForLaunchedProcessWithTimeout(ProcessExecutor.LaunchedProcess launchedProcess, long millis, Optional<java.util.function.Consumer<Process>> timeOutHandler) As ProcessExecutor.waitForLaunchedProcess(LaunchedProcess) but with a timeout in milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultProcessExecutor

public DefaultProcessExecutor(Console console)

Creates a new DefaultProcessExecutor with the specified parameters used for writing the output of the process.

DefaultProcessExecutor

protected DefaultProcessExecutor(PrintStream stdOutStream,
                                 PrintStream stdErrStream,
                                 Ansi ansi,
                                 ProcessHelper processHelper,
                                 ProcessRegistry processRegistry)

Method Detail

cloneWithOutputStreams

public ProcessExecutor cloneWithOutputStreams(PrintStream newStdOutStream,
                                              PrintStream newStdErrStream)

Description copied from interface: ProcessExecutor

Makes a clone of this process executor with the stdout and stderr streams overridden.

Specified by:

cloneWithOutputStreams in interface ProcessExecutor

launchAndExecute

public ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params)
                                        throws InterruptedException,
                                               IOException

Description copied from interface: ProcessExecutor

Convenience method for ProcessExecutor.launchAndExecute(ProcessExecutorParams, Set, Optional, Optional, Optional) with boolean values set to false and optional values set to absent.

Specified by:

launchAndExecute in interface ProcessExecutor

Throws:

InterruptedException

IOException

launchAndExecute

public ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                               com.google.common.collect.ImmutableMap<String,String> context)
                                        throws InterruptedException,
                                               IOException

Specified by:

launchAndExecute in interface ProcessExecutor

Throws:

InterruptedException

IOException

launchAndExecute

public ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                               Set<ProcessExecutor.Option> options,
                                               Optional<String> stdin,
                                               Optional<Long> timeOutMs,
                                               Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                        throws InterruptedException,
                                               IOException

Description copied from interface: ProcessExecutor

Launches then executes a process with the specified params.

If options contains ProcessExecutor.Option.PRINT_STD_OUT, then the stdout of the process will be written directly to the stdout passed to the constructor of this executor. Otherwise, the stdout of the process will be made available via ProcessExecutor.Result.getStdout().

If options contains ProcessExecutor.Option.PRINT_STD_ERR, then the stderr of the process will be written directly to the stderr passed to the constructor of this executor. Otherwise, the stderr of the process will be made available via ProcessExecutor.Result.getStderr().

Specified by:

launchAndExecute in interface ProcessExecutor

Throws:

InterruptedException

IOException

launchAndExecute

public ProcessExecutor.Result launchAndExecute(ProcessExecutorParams params,
                                               com.google.common.collect.ImmutableMap<String,String> context,
                                               Set<ProcessExecutor.Option> options,
                                               Optional<String> stdin,
                                               Optional<Long> timeOutMs,
                                               Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                        throws InterruptedException,
                                               IOException

Specified by:

launchAndExecute in interface ProcessExecutor

Throws:

InterruptedException

IOException

launchProcess

public ProcessExecutor.LaunchedProcess launchProcess(ProcessExecutorParams params)
                                              throws IOException

Description copied from interface: ProcessExecutor

Launches a Process given ProcessExecutorParams.

Specified by:

launchProcess in interface ProcessExecutor

Throws:

IOException

launchProcess

public ProcessExecutor.LaunchedProcess launchProcess(ProcessExecutorParams params,
                                                     com.google.common.collect.ImmutableMap<String,String> context)
                                              throws IOException

Specified by:

launchProcess in interface ProcessExecutor

Throws:

IOException

destroyLaunchedProcess

public void destroyLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess)

Description copied from interface: ProcessExecutor

Terminates a process previously returned by ProcessExecutor.launchProcess(ProcessExecutorParams).

Specified by:

destroyLaunchedProcess in interface ProcessExecutor

waitForLaunchedProcess

public ProcessExecutor.Result waitForLaunchedProcess(ProcessExecutor.LaunchedProcess launchedProcess)
                                              throws InterruptedException

Description copied from interface: ProcessExecutor

Blocks while waiting for a process previously returned by ProcessExecutor.launchProcess(ProcessExecutorParams) to exit, then returns the exit code of the process.

After this method returns, the launchedProcess can no longer be passed to any methods of this object.

Specified by:

waitForLaunchedProcess in interface ProcessExecutor

Throws:

InterruptedException

waitForLaunchedProcessWithTimeout

public ProcessExecutor.Result waitForLaunchedProcessWithTimeout(ProcessExecutor.LaunchedProcess launchedProcess,
                                                                long millis,
                                                                Optional<java.util.function.Consumer<Process>> timeOutHandler)
                                                         throws InterruptedException

Description copied from interface: ProcessExecutor

As ProcessExecutor.waitForLaunchedProcess(LaunchedProcess) but with a timeout in milliseconds.

Specified by:

waitForLaunchedProcessWithTimeout in interface ProcessExecutor

Throws:

InterruptedException

execute

public ProcessExecutor.Result execute(ProcessExecutor.LaunchedProcess launchedProcess,
                                      Set<ProcessExecutor.Option> options,
                                      Optional<String> stdin,
                                      Optional<Long> timeOutMs,
                                      Optional<java.util.function.Consumer<Process>> timeOutHandler)
                               throws InterruptedException

Executes the specified already-launched process.

If options contains Option#PRINT_STD_OUT, then the stdout of the process will be written directly to the stdout passed to the constructor of this executor. Otherwise, the stdout of the process will be made available via Result#getStdout().

If options contains Option#PRINT_STD_ERR, then the stderr of the process will be written directly to the stderr passed to the constructor of this executor. Otherwise, the stderr of the process will be made available via Result#getStderr().

Parameters:

timeOutHandler - If present, this method will be called before the process is killed.

Throws:

InterruptedException