io.airlift.airline

Class CommandGroupUsage

java.lang.Object

io.airlift.airline.CommandGroupUsage

public class CommandGroupUsage
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private int	columnSize
private java.util.Comparator<? super CommandMetadata>	commandComparator
private boolean	hideGlobalOptions
private java.util.Comparator<? super OptionMetadata>	optionComparator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	longest(java.lang.Iterable<java.lang.String> iterable)
void	usage(GlobalMetadata global, CommandGroupMetadata group) Display the help on System.out.
void	usage(GlobalMetadata global, CommandGroupMetadata group, java.lang.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

Field Detail

columnSize

private final int columnSize

hideGlobalOptions

private final boolean hideGlobalOptions

optionComparator

private final java.util.Comparator<? super OptionMetadata> optionComparator

commandComparator

private final java.util.Comparator<? super CommandMetadata> commandComparator

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
                         java.util.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,
                  java.lang.StringBuilder out)

Store the help in the passed string builder.

usage

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

longest

private static java.lang.String longest(java.lang.Iterable<java.lang.String> iterable)