com.facebook.buck.cli

Interface Command

All Known Implementing Classes:

AbstractCommand, AbstractContainerCommand, AbstractPerfCommand, AbstractQueryCommand, AuditActionGraphCommand, AuditAliasCommand, AuditBuildInfoCommand, AuditCellCommand, AuditClasspathCommand, AuditCommand, AuditConfigCommand, AuditDependenciesCommand, AuditFlavorsCommand, AuditIncludesCommand, AuditInputCommand, AuditMbrCommand, AuditMbrIsolationCommand, AuditModulesCommand, AuditOwnerCommand, AuditRulesCommand, AuditRuleTypeCommand, AuditRuleTypesCommand, AuditTestsCommand, BuckCommand, BuildCommand, CacheCommand, CacheDeleteCommand, CleanCommand, CommandWithPluginManager, DoctorCommand, FetchCommand, FixCommand, HelpCommand, InstallCommand, KillAllCommand, KillCommand, PerfActionGraphCommand, PerfCasCommand, PerfCasDownloadCommand, PerfCasUploadCommand, PerfCommand, PerfManifestCommand, PerfMbrCommand, PerfMbrPrepareRemoteExecutionCommand, PerfMbrSerializationCommand, PerfRuleKeyCommand, PerfStatCommand, ProjectCommand, PublishCommand, QueryCommand, RootCommand, RunCommand, ServerCommand, ServerStatusCommand, TargetsCommand, TestCommand, UnconfiguredQueryCommand, UninstallCommand, VerifyCachesCommand

public interface Command

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)
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()
org.pf4j.PluginManager	getPluginManager()
String	getShortDescription()
com.google.common.collect.ImmutableList<String>	getTargetPlatforms()
boolean	isReadOnly()
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.
void	setPluginManager(org.pf4j.PluginManager pluginManager)

Method Detail

run

ExitCode run(CommandRunnerParams params)
      throws Exception

Returns:

the appropriate exit code for the command

Throws:

Exception

runHelp

Optional<ExitCode> runHelp(PrintStream stream)

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.

isReadOnly

boolean isReadOnly()

Returns:

whether the command doesn't modify the state of the filesystem

isSourceControlStatsGatheringEnabled

boolean isSourceControlStatsGatheringEnabled()

Returns:

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

getShortDescription

String getShortDescription()

getConfigOverrides

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

getLogConfig

LogConfigSetup getLogConfig()

Returns:

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

getEventListeners

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.

printUsage

void printUsage(PrintStream stream)

performsBuild

boolean performsBuild()

setPluginManager

void setPluginManager(org.pf4j.PluginManager pluginManager)

getPluginManager

org.pf4j.PluginManager getPluginManager()

getTargetPlatforms

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

getHostPlatform

Optional<String> getHostPlatform()

createParsingContext

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

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