- java.lang.Object
-
- com.github.rvesse.airline.help.UsageHelper
-
public class UsageHelper extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.util.Comparator<CommandMetadata>
DEFAULT_COMMAND_COMPARATOR
Default comparator for commandsstatic java.util.Comparator<CommandGroupMetadata>
DEFAULT_COMMAND_GROUP_COMPARATOR
static java.util.Comparator<java.util.Map.Entry<java.lang.Integer,java.lang.String>>
DEFAULT_EXIT_CODE_COMPARATOR
Default comparator for exit codesstatic java.util.Comparator<HelpHint>
DEFAULT_HINT_COMPARATOR
Default comparator for help hintsstatic java.util.Comparator<OptionMetadata>
DEFAULT_OPTION_COMPARATOR
Default comparator for options
-
Constructor Summary
Constructors Constructor Description UsageHelper()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String[]
toGroupNames(java.util.List<CommandGroupMetadata> groupPath)
-
-
-
Field Detail
-
DEFAULT_HINT_COMPARATOR
public static final java.util.Comparator<HelpHint> DEFAULT_HINT_COMPARATOR
Default comparator for help hintsCompares 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 java.util.Comparator<OptionMetadata> DEFAULT_OPTION_COMPARATOR
Default comparator for optionsCompares against the user readable portion of the option name omitting any leading
-
characters
-
DEFAULT_COMMAND_COMPARATOR
public static final java.util.Comparator<CommandMetadata> DEFAULT_COMMAND_COMPARATOR
Default comparator for commandsCompares by alphabetical ordering
-
DEFAULT_COMMAND_GROUP_COMPARATOR
public static final java.util.Comparator<CommandGroupMetadata> DEFAULT_COMMAND_GROUP_COMPARATOR
-
DEFAULT_EXIT_CODE_COMPARATOR
public static final java.util.Comparator<java.util.Map.Entry<java.lang.Integer,java.lang.String>> DEFAULT_EXIT_CODE_COMPARATOR
Default comparator for exit codesCompares by numerical sorting on the exit codes and then alphabetical sorting on the descriptions
-
-
Method Detail
-
toGroupNames
public static java.lang.String[] toGroupNames(java.util.List<CommandGroupMetadata> groupPath)
-
-