com.facebook.buck.cli

Class AbstractCommand

java.lang.Object

com.facebook.buck.cli.CommandWithPluginManager

com.facebook.buck.cli.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AbstractPerfCommand, AbstractQueryCommand, AuditActionGraphCommand, AuditAliasCommand, AuditBuildInfoCommand, AuditCellCommand, AuditClasspathCommand, AuditConfigCommand, AuditDependenciesCommand, AuditFlavorsCommand, AuditIncludesCommand, AuditInputCommand, AuditMbrIsolationCommand, AuditModulesCommand, AuditOwnerCommand, AuditRulesCommand, AuditRuleTypeCommand, AuditRuleTypesCommand, AuditTestsCommand, BuildCommand, CacheCommand, CacheDeleteCommand, CleanCommand, DoctorCommand, FixCommand, HelpCommand, KillAllCommand, KillCommand, PerfCasDownloadCommand, PerfCasUploadCommand, PerfStatCommand, ProjectCommand, RootCommand, RunCommand, ServerStatusCommand, TargetsCommand, UninstallCommand, VerifyCachesCommand

public abstract class AbstractCommand
extends CommandWithPluginManager

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commandArgsFile

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

Method Summary

Modifier and Type	Method and Description
protected void	addCommandSpecificConfigOverrides(CellConfig.Builder builder) Injection point for commands to add config overrides.
protected com.google.common.collect.ImmutableSet<BuildTarget>	convertArgumentsToBuildTargets(CommandRunnerParams params, List<String> arguments) Converts target arguments to fully qualified form (including resolving aliases, resolving the implicit package target, etc).
ParsingContext	createParsingContext(Cell cell, com.google.common.util.concurrent.ListeningExecutorService executor) Creates a basic ParsingContext with some options populated from command's arguments.
String	getCommandArgsFile()
protected com.facebook.buck.cli.CommandLineBuildTargetNormalizer	getCommandLineBuildTargetNormalizer(Cell rootCell, Path clientWorkingDirectory, BuckConfig buckConfig)
ConcurrencyLimit	getConcurrencyLimit(BuckConfig buckConfig)
CellConfig	getConfigOverrides(com.google.common.collect.ImmutableMap<CellName,AbsPath> cellMapping)
boolean	getEnableParserProfiling()
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<Path>	getEventsOutputPath()
boolean	getExcludeIncompatibleTargets()
protected ExecutionContext	getExecutionContext()
protected ExecutionContext.Builder	getExecutionContextBuilder(CommandRunnerParams params)
Optional<String>	getHostPlatform()
LogConfigSetup	getLogConfig()
com.google.common.collect.ImmutableList<String>	getTargetPlatforms()
void	handleException(org.kohsuke.args4j.CmdLineException e) Handle CmdLineException when calling parseArguments()
protected void	handleException(org.kohsuke.args4j.CmdLineException e, String printedErrorMessage) Print error message when there are unknown options
boolean	isNoCache()
boolean	isReuseCurrentConfig()
boolean	isSourceControlStatsGatheringEnabled()
protected com.google.common.collect.ImmutableSet<BuildTargetWithOutputs>	matchBuildTargetsWithLabelsFromSpecs(com.google.common.collect.ImmutableList<TargetNodeSpec> specs, Set<BuildTarget> buildTargets) Returns a set of BuildTargetWithOutputs instances by matching the given BuildTarget instances with the given TargetNodeSpec instances, and applying any OutputLabel instances to the matching BuildTarget instances.
boolean	performsBuild()
protected Closeable	prepareExecutionContext(CommandRunnerParams params)
void	printUsage(PrintStream stream)
protected void	printWarning(CommandRunnerParams params, String s) Helper for printing warnings to the console.
protected void	printWarning(CommandRunnerParams params, String format, Object... args) Helper for printing warnings to the console.
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.
abstract ExitCode	runWithoutHelp(CommandRunnerParams params)

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

AbstractCommand

public AbstractCommand()

Method Detail

getLogConfig

public LogConfigSetup getLogConfig()

Returns:

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

isNoCache

public boolean isNoCache()

Returns:

{code true} if the [cache] in .buckconfig should be ignored.

isReuseCurrentConfig

public boolean isReuseCurrentConfig()

getCommandArgsFile

@Nullable
public String getCommandArgsFile()

getEventsOutputPath

public Optional<Path> getEventsOutputPath()

handleException

public void handleException(org.kohsuke.args4j.CmdLineException e)
                     throws org.kohsuke.args4j.CmdLineException

Handle CmdLineException when calling parseArguments()

Throws:

org.kohsuke.args4j.CmdLineException

handleException

protected void handleException(org.kohsuke.args4j.CmdLineException e,
                               String printedErrorMessage)
                        throws org.kohsuke.args4j.CmdLineException

Print error message when there are unknown options

Throws:

org.kohsuke.args4j.CmdLineException

printUsage

public void printUsage(PrintStream stream)

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 final ExitCode run(CommandRunnerParams params)
                   throws Exception

Returns:

the appropriate exit code for the command

Throws:

Exception

prepareExecutionContext

protected Closeable prepareExecutionContext(CommandRunnerParams params)

printWarning

protected void printWarning(CommandRunnerParams params,
                            String format,
                            Object... args)

Helper for printing warnings to the console.

printWarning

protected void printWarning(CommandRunnerParams params,
                            String s)

Helper for printing warnings to the console.

runWithoutHelp

public abstract ExitCode runWithoutHelp(CommandRunnerParams params)
                                 throws Exception

Throws:

Exception

getCommandLineBuildTargetNormalizer

protected com.facebook.buck.cli.CommandLineBuildTargetNormalizer getCommandLineBuildTargetNormalizer(Cell rootCell,
                                                                                                     Path clientWorkingDirectory,
                                                                                                     BuckConfig buckConfig)

getEnableParserProfiling

public boolean getEnableParserProfiling()

matchBuildTargetsWithLabelsFromSpecs

protected com.google.common.collect.ImmutableSet<BuildTargetWithOutputs> matchBuildTargetsWithLabelsFromSpecs(com.google.common.collect.ImmutableList<TargetNodeSpec> specs,
                                                                                                              Set<BuildTarget> buildTargets)

Returns a set of BuildTargetWithOutputs instances by matching the given BuildTarget instances with the given TargetNodeSpec instances, and applying any OutputLabel instances to the matching BuildTarget instances. Applies the default label if a given build target cannot find a matching spec.

getExecutionContext

protected ExecutionContext getExecutionContext()

getExecutionContextBuilder

protected ExecutionContext.Builder getExecutionContextBuilder(CommandRunnerParams params)

getConcurrencyLimit

public ConcurrencyLimit getConcurrencyLimit(BuckConfig buckConfig)

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()

getExcludeIncompatibleTargets

public boolean getExcludeIncompatibleTargets()

convertArgumentsToBuildTargets

protected com.google.common.collect.ImmutableSet<BuildTarget> convertArgumentsToBuildTargets(CommandRunnerParams params,
                                                                                             List<String> arguments)

Converts target arguments to fully qualified form (including resolving aliases, resolving the implicit package target, etc).

getConfigOverrides

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

addCommandSpecificConfigOverrides

protected void addCommandSpecificConfigOverrides(CellConfig.Builder builder)

Injection point for commands to add config overrides. Adding anything here will likely invalidate the @{link BuckGlobalState} and so it should be used extremely sparingly.

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.