Module com.github.rvesse.airline.help.markdown

Package com.github.rvesse.airline.help.markdown

Class MarkdownMultiPageGlobalUsageGenerator<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>

com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator<T>

com.github.rvesse.airline.help.markdown.MarkdownMultiPageGlobalUsageGenerator<T>

All Implemented Interfaces:

GlobalUsageGenerator<T>

public class MarkdownMultiPageGlobalUsageGenerator<T>
extends MarkdownGlobalUsageGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
private File	baseDirectory

Fields inherited from class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator

commandUsageGenerator

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

DEFAULT_COLUMNS

Constructor Summary

Constructors

Modifier	Constructor	Description
	MarkdownMultiPageGlobalUsageGenerator()
	MarkdownMultiPageGlobalUsageGenerator(boolean includeHidden)
	MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden)
protected	MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden, AbstractPrintedCommandUsageGenerator commandUsageGenerator, File baseDirectory)
	MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden, File baseDirectory)

Method Summary

Modifier and Type	Method	Description
protected FileOutputStream	createCommandFile(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command)
protected String	getCommandName(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command)
protected void	outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)	Outputs the command usages for the commands in the default group
protected void	outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups)	Outputs the command usages for the commands in the given group
protected void	outputReferenceToSuite(OutputStream output, GlobalMetadata<T> global)

Methods inherited from class com.github.rvesse.airline.help.markdown.MarkdownGlobalUsageGenerator

createHelper, outputCommandDescription, outputCommandList, outputCommandUsages, outputDescription, outputGroupCommandsList, outputSynopsis, outputUserAliases, usage

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

createUsagePrinter, usage

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

baseDirectory

private File baseDirectory

Constructor Details

MarkdownMultiPageGlobalUsageGenerator

public MarkdownMultiPageGlobalUsageGenerator()

MarkdownMultiPageGlobalUsageGenerator

public MarkdownMultiPageGlobalUsageGenerator(boolean includeHidden)

MarkdownMultiPageGlobalUsageGenerator

public MarkdownMultiPageGlobalUsageGenerator(int columns,
 boolean includeHidden)

MarkdownMultiPageGlobalUsageGenerator

public MarkdownMultiPageGlobalUsageGenerator(int columns,
 boolean includeHidden,
 File baseDirectory)

MarkdownMultiPageGlobalUsageGenerator

protected MarkdownMultiPageGlobalUsageGenerator(int columns,
 boolean includeHidden,
 AbstractPrintedCommandUsageGenerator commandUsageGenerator,
 File baseDirectory)

Method Details

outputGroupCommandUsages

protected void outputGroupCommandUsages(UsagePrinter printer,
 GlobalMetadata<T> global,
 List<CommandGroupMetadata> groups)
                                 throws IOException

Description copied from class: MarkdownGlobalUsageGenerator

Outputs the command usages for the commands in the given group

Overrides:

outputGroupCommandUsages in class MarkdownGlobalUsageGenerator<T>

Parameters:

printer - Usage printer

global - Global Meta-data

groups - Groups Meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputReferenceToSuite

protected void outputReferenceToSuite(OutputStream output,
 GlobalMetadata<T> global)
                               throws IOException

Throws:

IOException

createCommandFile

protected FileOutputStream createCommandFile(GlobalMetadata<T> global,
 String[] groupNames,
 CommandMetadata command)
                                      throws FileNotFoundException

Throws:

FileNotFoundException

outputDefaultGroupCommandUsages

protected void outputDefaultGroupCommandUsages(UsagePrinter printer,
 GlobalMetadata<T> global)
                                        throws IOException

Description copied from class: MarkdownGlobalUsageGenerator

Outputs the command usages for the commands in the default group

Overrides:

outputDefaultGroupCommandUsages in class MarkdownGlobalUsageGenerator<T>

Parameters:

printer - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

getCommandName

protected String getCommandName(GlobalMetadata<T> global,
 String[] groupNames,
 CommandMetadata command)