io.airlift.command

Class CommandGroupUsage

java.lang.Object

io.airlift.command.CommandGroupUsage

public class CommandGroupUsage
extends Object

Constructor Summary

Constructors

Constructor and Description
CommandGroupUsage()
CommandGroupUsage(int columnSize)
CommandGroupUsage(int columnSize, boolean hideGlobalOptions)
CommandGroupUsage(int columnSize, boolean hideGlobalOptions, Comparator<? super OptionMetadata> optionComparator)

Method Summary

Methods

Modifier and Type	Method and Description
void	usage(GlobalMetadata global, CommandGroupMetadata group) Display the help on System.out.
void	usage(GlobalMetadata global, CommandGroupMetadata group, StringBuilder out) Store the help in the passed string builder.
void	usage(GlobalMetadata global, CommandGroupMetadata group, UsagePrinter out)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandGroupUsage

public CommandGroupUsage()

CommandGroupUsage

public CommandGroupUsage(int columnSize)

CommandGroupUsage

public CommandGroupUsage(int columnSize,
                 boolean hideGlobalOptions)

CommandGroupUsage

public CommandGroupUsage(int columnSize,
                 boolean hideGlobalOptions,
                 @Nullable
                 Comparator<? super OptionMetadata> optionComparator)

Method Detail

usage

public void usage(@Nullable
         GlobalMetadata global,
         CommandGroupMetadata group)

Display the help on System.out.

usage

public void usage(@Nullable
         GlobalMetadata global,
         CommandGroupMetadata group,
         StringBuilder out)

Store the help in the passed string builder.

usage

public void usage(@Nullable
         GlobalMetadata global,
         CommandGroupMetadata group,
         UsagePrinter out)