Class AbstractPrintedCommandUsageGenerator

java.lang.Object

com.github.rvesse.airline.help.common.AbstractUsageGenerator

com.github.rvesse.airline.help.common.AbstractCommandUsageGenerator

com.github.rvesse.airline.help.common.AbstractPrintedCommandUsageGenerator

All Implemented Interfaces:

CommandUsageGenerator

Direct Known Subclasses:

CliCommandUsageGenerator, MarkdownCommandUsageGenerator

public abstract class AbstractPrintedCommandUsageGenerator
extends AbstractCommandUsageGenerator

Abstract command usage generator for generators that use a UsagePrinter to generate the documentation

Field Summary

Fields

Modifier and Type	Field	Description
private final int	columnSize

Fields inherited from class AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
AbstractPrintedCommandUsageGenerator(int columns, Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method	Description
protected UsagePrinter	createUsagePrinter(OutputStream out)	Creates a usage printer for the given stream
abstract <T> void	usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)	Generate the help and output it using the provided UsagePrinter
<T> void	usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream out)	Generate the help and output it to the stream

Methods inherited from class AbstractCommandUsageGenerator

findHelpSections, sortExitCodes, usage, usage

Methods inherited from class AbstractUsageGenerator

getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

columnSize

private final int columnSize

Constructor Details

AbstractPrintedCommandUsageGenerator

public AbstractPrintedCommandUsageGenerator(int columns,
 Comparator<? super OptionMetadata> optionComparator,
 boolean includeHidden)

Method Details

usage

public abstract <T> void usage(String programName,
 String[] groupNames,
 String commandName,
 CommandMetadata command,
 ParserMetadata<T> parserConfig,
 UsagePrinter out)
                        throws IOException

Generate the help and output it using the provided UsagePrinter

Type Parameters:

T - Command type

Parameters:

programName - Program Name

groupNames - Group Name(s)

commandName - Command Name

command - Command Metadata

parserConfig - Parser configuration

out - Usage printer to output with

Throws:

IOException - Thrown if there is a problem generating usage output

createUsagePrinter

protected UsagePrinter createUsagePrinter(OutputStream out)

Creates a usage printer for the given stream

Parameters:

out - Output stream

Returns:

Usage Printer

usage

public <T> void usage(String programName,
 String[] groupNames,
 String commandName,
 CommandMetadata command,
 ParserMetadata<T> parserConfig,
 OutputStream out)
               throws IOException

Description copied from interface: CommandUsageGenerator

Generate the help and output it to the stream

Type Parameters:

T - Command type

Parameters:

programName - Program Name

groupNames - Group Name(s)

commandName - Command Name

command - Command Metadata

parserConfig - Parser Configuration, if null is passed then the parser configuration is automatically determined based on the command class for which we are producing help

out - Stream to output to

Throws:

IOException - Thrown if there is a problem generating usage output