com.github.rvesse.airline.help

Class UsageHelper

java.lang.Object

com.github.rvesse.airline.help.UsageHelper

public class UsageHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<CommandMetadata>	DEFAULT_COMMAND_COMPARATOR Default comparator for commands
static Comparator<CommandGroupMetadata>	DEFAULT_COMMAND_GROUP_COMPARATOR
static Comparator<Map.Entry<Integer,String>>	DEFAULT_EXIT_CODE_COMPARATOR Default comparator for exit codes
static Comparator<HelpHint>	DEFAULT_HINT_COMPARATOR Default comparator for help hints
static Comparator<OptionMetadata>	DEFAULT_OPTION_COMPARATOR Default comparator for options

Constructor Summary

Constructors

Constructor and Description
UsageHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static String[]	toGroupNames(List<CommandGroupMetadata> groupPath)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HINT_COMPARATOR

public static final Comparator<HelpHint> DEFAULT_HINT_COMPARATOR

Default comparator for help hints

Compares by class name of the implementation to give a predictable order in output. Where multiple instances of same implementation hint exists compares by identity hash codes of the instances.

DEFAULT_OPTION_COMPARATOR

public static final Comparator<OptionMetadata> DEFAULT_OPTION_COMPARATOR

Default comparator for options

Compares against the user readable portion of the option name omitting any leading - characters

DEFAULT_COMMAND_COMPARATOR

public static final Comparator<CommandMetadata> DEFAULT_COMMAND_COMPARATOR

Default comparator for commands

Compares by alphabetical ordering

DEFAULT_COMMAND_GROUP_COMPARATOR

public static final Comparator<CommandGroupMetadata> DEFAULT_COMMAND_GROUP_COMPARATOR

DEFAULT_EXIT_CODE_COMPARATOR

public static final Comparator<Map.Entry<Integer,String>> DEFAULT_EXIT_CODE_COMPARATOR

Default comparator for exit codes

Compares by numerical sorting on the exit codes and then alphabetical sorting on the descriptions

Constructor Detail

UsageHelper

public UsageHelper()

Method Detail

toGroupNames

public static String[] toGroupNames(List<CommandGroupMetadata> groupPath)