com.facebook.buck.cli

Class AbstractContainerCommand

java.lang.Object

com.facebook.buck.cli.CommandWithPluginManager

com.facebook.buck.cli.AbstractContainerCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AuditCommand, AuditMbrCommand, BuckCommand, PerfCasCommand, PerfCommand, PerfMbrCommand, ServerCommand

public abstract class AbstractContainerCommand
extends CommandWithPluginManager

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commandArgsFile

Constructor Summary

Constructors

Constructor and Description
AbstractContainerCommand()

Method Summary

Modifier and Type	Method and Description
ParsingContext	createParsingContext(Cell cell, com.google.common.util.concurrent.ListeningExecutorService executor) Creates a basic ParsingContext with some options populated from command's arguments.
CellConfig	getConfigOverrides(com.google.common.collect.ImmutableMap<CellName,AbsPath> cellMapping)
protected abstract String	getContainerCommandPrefix()
Iterable<BuckEventListener>	getEventListeners(Map<ExecutorPool,com.google.common.util.concurrent.ListeningExecutorService> executorPool, ScheduledExecutorService scheduledExecutorService) If any of these listeners also extends Closeable, it will be closed by Main.
Optional<String>	getHostPlatform()
LogConfigSetup	getLogConfig()
protected abstract Optional<Command>	getSubcommand()
protected String	getSubcommandsFieldName()
com.google.common.collect.ImmutableList<String>	getTargetPlatforms()
boolean	isSourceControlStatsGatheringEnabled()
boolean	performsBuild()
void	printUsage(PrintStream stream)
ExitCode	run(CommandRunnerParams params)
Optional<ExitCode>	runHelp(PrintStream stream) If the current command is a help command, run the action to print out the appropriate help message.

Methods inherited from class com.facebook.buck.cli.CommandWithPluginManager

getPluginManager, setPluginManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.cli.Command

getShortDescription, isReadOnly

Field Detail

commandArgsFile

@Nullable
protected String commandArgsFile

Constructor Detail

AbstractContainerCommand

public AbstractContainerCommand()

Method Detail

getSubcommandsFieldName

protected String getSubcommandsFieldName()

getSubcommand

protected abstract Optional<Command> getSubcommand()

getContainerCommandPrefix

protected abstract String getContainerCommandPrefix()

runHelp

public Optional<ExitCode> runHelp(PrintStream stream)

Description copied from interface: Command

If the current command is a help command, run the action to print out the appropriate help message.

This is an optimization to avoid initializing everything in CommandRunnerParams, in order to return help strings quickly.

Parameters:

stream - stream to output the help text.

Returns:

The exit code of the command, if the command is a help request.

run

public ExitCode run(CommandRunnerParams params)
             throws Exception

Returns:

the appropriate exit code for the command

Throws:

Exception

printUsage

public void printUsage(PrintStream stream)

getConfigOverrides

public CellConfig getConfigOverrides(com.google.common.collect.ImmutableMap<CellName,AbsPath> cellMapping)

getLogConfig

public LogConfigSetup getLogConfig()

Returns:

how we want logging to be configured for the the command.

isSourceControlStatsGatheringEnabled

public boolean isSourceControlStatsGatheringEnabled()

Returns:

whether we should gather source control stats while executing the command.

getEventListeners

public Iterable<BuckEventListener> getEventListeners(Map<ExecutorPool,com.google.common.util.concurrent.ListeningExecutorService> executorPool,
                                                     ScheduledExecutorService scheduledExecutorService)

Description copied from interface: Command

If any of these listeners also extends Closeable, it will be closed by Main.

performsBuild

public boolean performsBuild()

getTargetPlatforms

public com.google.common.collect.ImmutableList<String> getTargetPlatforms()

getHostPlatform

public Optional<String> getHostPlatform()

createParsingContext

public ParsingContext createParsingContext(Cell cell,
                                           com.google.common.util.concurrent.ListeningExecutorService executor)

Description copied from interface: Command

Creates a basic ParsingContext with some options populated from command's arguments.