com.facebook.buck.cli

Class BuckCommand

java.lang.Object

com.facebook.buck.cli.CommandWithPluginManager

com.facebook.buck.cli.AbstractContainerCommand

com.facebook.buck.cli.BuckCommand

All Implemented Interfaces:

Command

public class BuckCommand
extends AbstractContainerCommand

Field Summary

Fields inherited from class com.facebook.buck.cli.AbstractContainerCommand

commandArgsFile

Constructor Summary

Constructors

Constructor and Description
BuckCommand()

Method Summary

Modifier and Type	Method and Description
protected String	getContainerCommandPrefix()
String	getShortDescription()
Optional<Command>	getSubcommand()
String	getSubCommandNameForLogging()
boolean	isReadOnly()
boolean	isSourceControlStatsGatheringEnabled()
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.AbstractContainerCommand

createParsingContext, getConfigOverrides, getEventListeners, getHostPlatform, getLogConfig, getSubcommandsFieldName, getTargetPlatforms, performsBuild, printUsage, run

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

Constructor Detail

BuckCommand

public BuckCommand()

Method Detail

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.

Specified by:

runHelp in interface Command

Overrides:

runHelp in class AbstractContainerCommand

Parameters:

stream - stream to output the help text.

Returns:

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

isReadOnly

public boolean isReadOnly()

Returns:

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

getShortDescription

public String getShortDescription()

getContainerCommandPrefix

protected String getContainerCommandPrefix()

Specified by:

getContainerCommandPrefix in class AbstractContainerCommand

getSubcommand

public Optional<Command> getSubcommand()

Specified by:

getSubcommand in class AbstractContainerCommand

getSubCommandNameForLogging

public String getSubCommandNameForLogging()

Returns:

String'fied version of the SubCommand or "no_sub_command" if the SubCommand is null.

isSourceControlStatsGatheringEnabled

public boolean isSourceControlStatsGatheringEnabled()

Specified by:

isSourceControlStatsGatheringEnabled in interface Command

Overrides:

isSourceControlStatsGatheringEnabled in class AbstractContainerCommand

Returns:

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