io.airlift.airline

Class CommandUsage

java.lang.Object

io.airlift.airline.CommandUsage

public class CommandUsage
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private java.util.List<OptionMetadata>	sortOptions(java.util.List<OptionMetadata> options)
void	usage(java.lang.String programName, java.lang.String groupName, java.lang.String commandName, CommandMetadata command) Display the help on System.out.
void	usage(java.lang.String programName, java.lang.String groupName, java.lang.String commandName, CommandMetadata command, java.lang.StringBuilder out) Store the help in the passed string builder.
void	usage(java.lang.String programName, java.lang.String groupName, java.lang.String commandName, CommandMetadata command, 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

optionComparator

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

Constructor Detail

CommandUsage

public CommandUsage()

CommandUsage

public CommandUsage(int columnSize)

CommandUsage

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

Method Detail

usage

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

Display the help on System.out.

usage

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

Store the help in the passed string builder.

usage

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

sortOptions

private java.util.List<OptionMetadata> sortOptions(java.util.List<OptionMetadata> options)