Module com.github.rvesse.airline

Package com.github.rvesse.airline.help.common

Class AbstractPrintedGlobalUsageGenerator<T>

java.lang.Object

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

com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator<T>

com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator<T>

All Implemented Interfaces:

GlobalUsageGenerator<T>

Direct Known Subclasses:

CliGlobalUsageGenerator, CliGlobalUsageSummaryGenerator, MarkdownGlobalUsageGenerator

public abstract class AbstractPrintedGlobalUsageGenerator<T>
extends AbstractGlobalUsageGenerator<T>

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

Field Summary

Fields

Modifier and Type	Field	Description
private final int	columns

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Constructor	Description
AbstractPrintedGlobalUsageGenerator(int columns, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)

Method Summary

Modifier and Type	Method	Description
protected UsagePrinter	createUsagePrinter(OutputStream out)	Creates a usage printer for the given stream
protected abstract void	usage(GlobalMetadata<T> global, UsagePrinter out)	Generate the help and output is using the provided UsagePrinter
void	usage(GlobalMetadata<T> global, OutputStream out)	Generate the help and output it to the stream

Methods inherited from class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator

findHelpSections, sortCommandGroups, usage

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

Field Details

columns

private final int columns

Constructor Details

AbstractPrintedGlobalUsageGenerator

public AbstractPrintedGlobalUsageGenerator(int columns,
 Comparator<? super HelpHint> hintComparator,
 Comparator<? super OptionMetadata> optionComparator,
 Comparator<? super CommandMetadata> commandComparator,
 Comparator<? super CommandGroupMetadata> commandGroupComparator,
 boolean includeHidden)

Method Details

usage

protected abstract void usage(GlobalMetadata<T> global,
 UsagePrinter out)
                       throws IOException

Generate the help and output is using the provided UsagePrinter

Parameters:

global - Global Metadata

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 void usage(GlobalMetadata<T> global,
 OutputStream out)
           throws IOException

Description copied from interface: GlobalUsageGenerator

Generate the help and output it to the stream

Parameters:

global - Global metadata

out - Stream to output to

Throws:

IOException - Thrown if there is a problem generating usage output