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
Fields Modifier and Type Field Description private java.util.Comparator<? super CommandGroupMetadata>
commandGroupComparator
-
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
-
Constructor Summary
Constructors Constructor Description AbstractGlobalUsageGenerator()
AbstractGlobalUsageGenerator(boolean includeHidden)
AbstractGlobalUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
findHelpSections(GlobalMetadata<T> global, java.util.List<HelpSection> preSections, java.util.List<HelpSection> postSections)
Finds the help sectionsprotected java.util.List<CommandGroupMetadata>
sortCommandGroups(java.util.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 out-
Methods 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 Detail
-
commandGroupComparator
private final java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator
-
-
Constructor Detail
-
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator()
-
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator(boolean includeHidden)
-
AbstractGlobalUsageGenerator
public AbstractGlobalUsageGenerator(java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
-
-
Method Detail
-
usage
public void usage(GlobalMetadata<T> global) throws java.io.IOException
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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
sortCommandGroups
protected java.util.List<CommandGroupMetadata> sortCommandGroups(java.util.List<CommandGroupMetadata> groups)
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, java.util.List<HelpSection> preSections, java.util.List<HelpSection> postSections)
Finds the help sections- Parameters:
command
- Command meta-datapreSections
- Sections that should be placed before base contentpostSections
- Sections that should be placed after base content
-
-