com.facebook.buck.shell

Class AbstractGenruleStep

java.lang.Object

com.facebook.buck.shell.ShellStep

com.facebook.buck.shell.AbstractGenruleStep

All Implemented Interfaces:

Step

public abstract class AbstractGenruleStep
extends ShellStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGenruleStep.CommandString

Field Summary

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

workingDirectory

Constructor Summary

Constructors

Constructor and Description
AbstractGenruleStep(ProjectFilesystem projectFilesystem, AbstractGenruleStep.CommandString commandString, AbsPath workingDirectory)
AbstractGenruleStep(ProjectFilesystem projectFilesystem, AbstractGenruleStep.CommandString commandString, Path workingDirectory)
AbstractGenruleStep(ProjectFilesystem projectFilesystem, AbstractGenruleStep.CommandString commandString, Path workingDirectory, ProgramRunner programRunner)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addEnvironmentVariables(ExecutionContext context, com.google.common.collect.ImmutableMap.Builder<String,String> environmentVariablesBuilder)
StepExecutionResult	execute(ExecutionContext context)
com.google.common.collect.ImmutableMap<String,String>	getEnvironmentVariables(ExecutionContext context) Returns the environment variables to include when running this ShellStep.
String	getScriptFileContents(ExecutionContext context)
Path	getScriptFilePath(ExecutionContext context)
protected com.google.common.collect.ImmutableList<String>	getShellCommandArgsForDescription(ExecutionContext context)
protected com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getShortName()
protected boolean	shouldPrintStderr(Verbosity verbosity)

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

addOptions, getDescription, getDuration, getExitCodeFromResult, getShellCommand, getStderr, getStdin, getStdout, getTimeout, getTimeoutHandler, shouldPrintStdout

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGenruleStep

public AbstractGenruleStep(ProjectFilesystem projectFilesystem,
                           AbstractGenruleStep.CommandString commandString,
                           Path workingDirectory,
                           ProgramRunner programRunner)

AbstractGenruleStep

public AbstractGenruleStep(ProjectFilesystem projectFilesystem,
                           AbstractGenruleStep.CommandString commandString,
                           Path workingDirectory)

AbstractGenruleStep

public AbstractGenruleStep(ProjectFilesystem projectFilesystem,
                           AbstractGenruleStep.CommandString commandString,
                           AbsPath workingDirectory)

Method Detail

getShortName

public String getShortName()

Returns:

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

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException,
                                   InterruptedException

Specified by:

execute in interface Step

Overrides:

execute in class ShellStep

Throws:

IOException

InterruptedException

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

getShellCommandArgsForDescription

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

Overrides:

getShellCommandArgsForDescription in class ShellStep

getEnvironmentVariables

public com.google.common.collect.ImmutableMap<String,String> getEnvironmentVariables(ExecutionContext context)

Description copied from class: ShellStep

Returns the environment variables to include when running this ShellStep.

By default, this method returns an empty map.

Overrides:

getEnvironmentVariables in class ShellStep

Parameters:

context - that may be useful when determining environment variables to include.

shouldPrintStderr

protected boolean shouldPrintStderr(Verbosity verbosity)

Overrides:

shouldPrintStderr in class ShellStep

Returns:

whether the stderr of the shell command, when executed, should be printed to the stderr of the specified ExecutionContext. If false, stderr will only be printed on error and only if verbosity is set to standard information.

getScriptFileContents

public String getScriptFileContents(ExecutionContext context)

getScriptFilePath

public Path getScriptFilePath(ExecutionContext context)
                       throws IOException

Throws:

IOException

addEnvironmentVariables

protected abstract void addEnvironmentVariables(ExecutionContext context,
                                                com.google.common.collect.ImmutableMap.Builder<String,String> environmentVariablesBuilder)