com.facebook.buck.cli

Class HelpCommand

java.lang.Object

com.facebook.buck.cli.CommandWithPluginManager

com.facebook.buck.cli.AbstractCommand

com.facebook.buck.cli.HelpCommand

All Implemented Interfaces:

Command

public class HelpCommand
extends AbstractCommand

Field Summary

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

commandArgsFile

Constructor Summary

Constructors

Constructor and Description
HelpCommand()

Method Summary

Modifier and Type	Method and Description
String	getShortDescription()
boolean	isReadOnly()
void	printUsage(PrintStream stream)
ExitCode	run(PrintStream stream) This overload runs the actual help subcommand.
ExitCode	runWithoutHelp(CommandRunnerParams params)

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

addCommandSpecificConfigOverrides, convertArgumentsToBuildTargets, createParsingContext, getCommandArgsFile, getCommandLineBuildTargetNormalizer, getConcurrencyLimit, getConfigOverrides, getEnableParserProfiling, getEventListeners, getEventsOutputPath, getExcludeIncompatibleTargets, getExecutionContext, getExecutionContextBuilder, getHostPlatform, getLogConfig, getTargetPlatforms, handleException, handleException, isNoCache, isReuseCurrentConfig, isSourceControlStatsGatheringEnabled, matchBuildTargetsWithLabelsFromSpecs, performsBuild, prepareExecutionContext, printWarning, printWarning, run, runHelp

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

HelpCommand

public HelpCommand()

Method Detail

isReadOnly

public boolean isReadOnly()

Returns:

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

getShortDescription

public String getShortDescription()

runWithoutHelp

public ExitCode runWithoutHelp(CommandRunnerParams params)

Specified by:

runWithoutHelp in class AbstractCommand

run

public ExitCode run(PrintStream stream)

This overload runs the actual help subcommand.

Used by BuckCommand.runHelp(java.io.PrintStream) to run the help subcommand without initializing CommandRunnerParams.

printUsage

public void printUsage(PrintStream stream)

Specified by:

printUsage in interface Command

Overrides:

printUsage in class AbstractCommand