public abstract class AbstractGlobalUsageGenerator<T> extends AbstractUsageGenerator implements GlobalUsageGenerator<T>
DEFAULT_COLUMNS
Constructor and Description |
---|
AbstractGlobalUsageGenerator() |
AbstractGlobalUsageGenerator(boolean includeHidden) |
AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected List<CommandGroupMetadata> |
sortCommandGroups(List<CommandGroupMetadata> groups)
Sorts the command groups assumign a non-null comparator was provided at
instantiation time
|
void |
usage(GlobalMetadata<T> global)
Generate the help and output it on standard out
|
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
usage
public AbstractGlobalUsageGenerator()
public AbstractGlobalUsageGenerator(boolean includeHidden)
public AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
public void usage(GlobalMetadata<T> global) throws IOException
GlobalUsageGenerator
usage
in interface GlobalUsageGenerator<T>
global
- Global MetadataIOException
protected List<CommandGroupMetadata> sortCommandGroups(List<CommandGroupMetadata> groups)
groups
- Command groupsCopyright © 2012–2017. All rights reserved.