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

All Implemented Interfaces:

GlobalUsageGenerator<T>

Direct Known Subclasses:

MarkdownMultiPageGlobalUsageGenerator

public class MarkdownGlobalUsageGenerator<T>
extends AbstractPrintedGlobalUsageGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final AbstractPrintedCommandUsageGenerator	commandUsageGenerator
private final MarkdownUsageHelper	helper

Fields inherited from class AbstractUsageGenerator

DEFAULT_COLUMNS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected MarkdownUsageHelper	createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected void	outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
protected void	outputCommandList(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section listing the commands
protected void	outputCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)	Outputs the command usages for all groups
protected void	outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)	Outputs the command usages for the commands in the default group
protected void	outputDescription(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a description of the CLI
protected void	outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, List<CommandGroupMetadata> groups)
protected void	outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups)	Outputs the command usages for the commands in the given group
protected void	outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a synopsis of CLI usage
protected void	outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases)
protected void	usage(GlobalMetadata<T> global, UsagePrinter out)	Generate the help and output is using the provided UsagePrinter

Methods inherited from class AbstractPrintedGlobalUsageGenerator

createUsagePrinter, usage

Methods inherited from class AbstractGlobalUsageGenerator

findHelpSections, sortCommandGroups, 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

helper

private final MarkdownUsageHelper helper

commandUsageGenerator

protected final AbstractPrintedCommandUsageGenerator commandUsageGenerator

Constructor Details

MarkdownGlobalUsageGenerator

public MarkdownGlobalUsageGenerator()

MarkdownGlobalUsageGenerator

public MarkdownGlobalUsageGenerator(boolean includeHidden)

MarkdownGlobalUsageGenerator

public MarkdownGlobalUsageGenerator(int columns)

MarkdownGlobalUsageGenerator

public MarkdownGlobalUsageGenerator(int columns,
 boolean includeHidden)

MarkdownGlobalUsageGenerator

public MarkdownGlobalUsageGenerator(int columnSize,
 Comparator<? super HelpHint> hintComparator,
 Comparator<? super OptionMetadata> optionComparator,
 Comparator<? super CommandMetadata> commandComparator,
 Comparator<? super CommandGroupMetadata> commandGroupComparator,
 boolean includeHidden,
 AbstractPrintedCommandUsageGenerator commandUsageGenerator)

Method Details

createHelper

protected MarkdownUsageHelper createHelper(Comparator<? super OptionMetadata> optionComparator,
 boolean includeHidden)

usage

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

Description copied from class: AbstractPrintedGlobalUsageGenerator

Generate the help and output is using the provided UsagePrinter

Specified by:

usage in class AbstractPrintedGlobalUsageGenerator<T>

Parameters:

global - Global Metadata

out - Usage printer to output with

Throws:

IOException - Thrown if there is a problem generating usage output

outputCommandList

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

Outputs a documentation section listing the commands

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputGroupCommandsList

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

Throws:

IOException

outputSynopsis

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

Outputs a documentation section with a synopsis of CLI usage

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputDescription

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

Outputs a documentation section with a description of the CLI

Parameters:

out - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputCommandDescription

protected void outputCommandDescription(UsagePrinter out,
 CommandGroupMetadata group,
 CommandMetadata command)
                                 throws IOException

Outputs the description for a command

Parameters:

out - Usage printer

group - Group meta-data

command - Command meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputUserAliases

protected void outputUserAliases(UsagePrinter out,
 GlobalMetadata<T> global,
 UserAliasesSource<T> userAliases)
                          throws IOException

Throws:

IOException

outputCommandUsages

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

Outputs the command usages for all groups

Parameters:

printer - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputDefaultGroupCommandUsages

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

Outputs the command usages for the commands in the default group

Parameters:

printer - Usage printer

global - Global meta-data

Throws:

IOException - Thrown if there is a problem generating usage output

outputGroupCommandUsages

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

Outputs the command usages for the commands in the given group

Parameters:

printer - Usage printer

global - Global Meta-data

groups - Groups Meta-data

Throws:

IOException - Thrown if there is a problem generating usage output