io.airlift.command

Class CommandUsage

java.lang.Object

io.airlift.command.CommandUsage

public class CommandUsage
extends Object

Constructor Summary

Constructors

Constructor and Description
CommandUsage()
CommandUsage(int columnSize)
CommandUsage(int columnSize, Comparator<? super OptionMetadata> optionComparator)

Method Summary

Methods

Modifier and Type	Method and Description
void	usage(String programName, String groupName, String commandName, CommandMetadata command) Display the help on System.out.
void	usage(String programName, String groupName, String commandName, CommandMetadata command, StringBuilder out) Store the help in the passed string builder.
void	usage(String programName, String groupName, String commandName, CommandMetadata command, UsagePrinter out)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandUsage

public CommandUsage()

CommandUsage

public CommandUsage(int columnSize)

CommandUsage

public CommandUsage(int columnSize,
            @Nullable
            Comparator<? super OptionMetadata> optionComparator)

Method Detail

usage

public void usage(@Nullable
         String programName,
         @Nullable
         String groupName,
         String commandName,
         CommandMetadata command)

Display the help on System.out.

usage

public void usage(@Nullable
         String programName,
         @Nullable
         String groupName,
         String commandName,
         CommandMetadata command,
         StringBuilder out)

Store the help in the passed string builder.

usage

public void usage(@Nullable
         String programName,
         @Nullable
         String groupName,
         String commandName,
         CommandMetadata command,
         UsagePrinter out)