com.github.rvesse.airline.help.common

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

public abstract class AbstractGlobalUsageGenerator<T>
extends AbstractUsageGenerator
implements GlobalUsageGenerator<T>

Abstract global usage generator

Field Summary

Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

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)

Method Summary

Modifier and Type	Method and Description
protected void	findHelpSections(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections
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

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

Constructor Detail

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 Detail

usage

public void usage(GlobalMetadata<T> global)
           throws IOException

Description copied from interface: GlobalUsageGenerator

Generate the help and output it on standard out

Specified by:

usage in interface GlobalUsageGenerator<T>

Parameters:

global - Global Metadata

Throws:

IOException - Thrown if there is a problem generating usage output

sortCommandGroups

protected List<CommandGroupMetadata> sortCommandGroups(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,
                                List<HelpSection> preSections,
                                List<HelpSection> postSections)

Finds the help sections

Parameters:

command - Command meta-data

preSections - Sections that should be placed before base content

postSections - Sections that should be placed after base content