Module com.github.rvesse.airline
Class AbstractGlobalUsageGenerator<T>
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator<T>
- All Implemented Interfaces:
GlobalUsageGenerator<T>
- Direct Known Subclasses:
AbstractPrintedGlobalUsageGenerator
,BashCompletionGenerator
,ManGlobalUsageGenerator
public abstract class AbstractGlobalUsageGenerator<T>
extends AbstractUsageGenerator
implements GlobalUsageGenerator<T>
Abstract global usage generator
-
Field Summary
FieldsFields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractGlobalUsageGenerator
(boolean includeHidden) AbstractGlobalUsageGenerator
(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
findHelpSections
(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sectionsprotected List
<CommandGroupMetadata> sortCommandGroups
(List<CommandGroupMetadata> groups) Sorts the command groups assumign a non-null comparator was provided at instantiation timevoid
usage
(GlobalMetadata<T> global) 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.GlobalUsageGenerator
usage
-
Field Details
-
commandGroupComparator
-
-
Constructor Details
-
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator() -
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator(boolean includeHidden) -
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
-
-
Method Details
-
usage
Description copied from interface:GlobalUsageGenerator
Generate the help and output it on standard out- Specified by:
usage
in interfaceGlobalUsageGenerator<T>
- Parameters:
global
- Global Metadata- Throws:
IOException
- Thrown if there is a problem generating usage output
-
sortCommandGroups
Sorts the command groups assumign a non-null comparator was provided at instantiation time- Parameters:
groups
- Command groups- Returns:
- Sorted command groups
-
findHelpSections
protected void findHelpSections(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections- Parameters:
preSections
- Sections that should be placed before base contentpostSections
- Sections that should be placed after base contentcommand
- Command meta-data
-