com.facebook.buck.cli

Class CommandHelper

java.lang.Object

com.facebook.buck.cli.CommandHelper

public final class CommandHelper
extends Object

Utility class with print methods

Method Summary

Modifier and Type	Method and Description
static void	maybePrintShowOutputWarning(CliConfig cliConfig, Ansi ansi, BuckEventBus buckEventBus) Prints a warning to terminal about --show-output being replaced by --show-outputs if the warning is enabled in the buck config and the environment supports ANSI.
static void	print(com.google.common.collect.Multimap<String,QueryTarget> targetsAndDependencies, PrintStream printStream) Prints target and dependencies map into printStream.
static void	print(Set<QueryTarget> targets, PrintStream printStream) Prints target set into printStream.
static void	printJsonOutput(com.google.common.collect.Multimap<String,QueryTarget> targetsAndResults, PrintStream printStream) Prints target and result map's json representation into printStream.
static void	printJsonOutput(Set<QueryTarget> targets, PrintStream printStream) Prints targets set json representation into printStream.
static void	printShortDescription(Command command, PrintStream printStream) Prints short description of a given command into printStream.

Methods inherited from class java.lang.Object

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

Method Detail

printJsonOutput

public static void printJsonOutput(com.google.common.collect.Multimap<String,QueryTarget> targetsAndResults,
                                   PrintStream printStream)
                            throws IOException

Prints target and result map's json representation into printStream.

Parameters:

targetsAndResults - input to query result multi map

printStream - print stream for output

Throws:

IOException - in case of IO exception during json writing operation

printJsonOutput

public static void printJsonOutput(Set<QueryTarget> targets,
                                   PrintStream printStream)
                            throws IOException

Prints targets set json representation into printStream.

Parameters:

targets - set of query result

printStream - print stream for output

Throws:

IOException - in case of IO exception during json writing operation

print

public static void print(com.google.common.collect.Multimap<String,QueryTarget> targetsAndDependencies,
                         PrintStream printStream)

Prints target and dependencies map into printStream.

Parameters:

targetsAndDependencies - input to query result multi map

printStream - print stream for output

print

public static void print(Set<QueryTarget> targets,
                         PrintStream printStream)

Prints target set into printStream.

Parameters:

targets - set of query result

printStream - print stream for output

printShortDescription

public static void printShortDescription(Command command,
                                         PrintStream printStream)

Prints short description of a given command into printStream.

Parameters:

command - CLI command

printStream - print stream for output

maybePrintShowOutputWarning

public static void maybePrintShowOutputWarning(CliConfig cliConfig,
                                               Ansi ansi,
                                               BuckEventBus buckEventBus)

Prints a warning to terminal about --show-output being replaced by --show-outputs if the warning is enabled in the buck config and the environment supports ANSI.