Module com.github.rvesse.airline
Class AbstractCommandGroupUsageGenerator<T>
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.common.AbstractCommandGroupUsageGenerator<T>
- All Implemented Interfaces:
CommandGroupUsageGenerator<T>
- Direct Known Subclasses:
AbstractPrintedCommandGroupUsageGenerator
public abstract class AbstractCommandGroupUsageGenerator<T>
extends AbstractUsageGenerator
implements CommandGroupUsageGenerator<T>
Abstract command group usage generator
-
Field Summary
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractCommandGroupUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescriptionvoid
usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups) Generate the help and output it on standard outMethods inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.github.rvesse.airline.help.CommandGroupUsageGenerator
usage
-
Constructor Details
-
AbstractCommandGroupUsageGenerator
public AbstractCommandGroupUsageGenerator() -
AbstractCommandGroupUsageGenerator
public AbstractCommandGroupUsageGenerator(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
-
-
Method Details
-
usage
Description copied from interface:CommandGroupUsageGenerator
Generate the help and output it on standard out- Specified by:
usage
in interfaceCommandGroupUsageGenerator<T>
- Parameters:
global
- Global Metadatagroups
- Group path to the command- Throws:
IOException
- Thrown if there is a problem generating usage output
-