com.facebook.buck.shell

Class BashStep

java.lang.Object

com.facebook.buck.shell.ShellStep

com.facebook.buck.shell.BashStep

All Implemented Interfaces:

Step

public class BashStep
extends ShellStep

Command that makes it possible to run an arbitrary command in Bash. Whenever possible, a more specific subclass of ShellStep should be preferred. BashCommand should be reserved for cases where the expressiveness of Bash (often in the form of *-shell-expansion) makes the command considerably easier to implement.

Field Summary

Fields inherited from class com.facebook.buck.shell.ShellStep

workingDirectory

Constructor Summary

Constructors

Constructor and Description
BashStep(AbsPath workingDirectory, String... bashCommand)
BashStep(Path workingDirectory, String... bashCommand)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getShortName()

Methods inherited from class com.facebook.buck.shell.ShellStep

addOptions, execute, getDescription, getDuration, getEnvironmentVariables, getExitCodeFromResult, getShellCommand, getShellCommandArgsForDescription, getStderr, getStdin, getStdout, getTimeout, getTimeoutHandler, shouldPrintStderr, shouldPrintStdout

Methods inherited from class java.lang.Object

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

Constructor Detail

BashStep

public BashStep(Path workingDirectory,
                String... bashCommand)

Parameters:

bashCommand - command to execute. For convenience, multiple arguments are supported and will be joined with space characters if more than one is present.

BashStep

public BashStep(AbsPath workingDirectory,
                String... bashCommand)

Method Detail

getShortName

public String getShortName()

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getShellCommandInternal

protected com.google.common.collect.ImmutableList<String> getShellCommandInternal(ExecutionContext context)

Description copied from class: ShellStep

Implementations of this method should not have any observable side-effects.

Specified by:

getShellCommandInternal in class ShellStep