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>
-
Field Summary
FieldsFields 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
ConstructorsModifierConstructorDescriptionMarkdownMultiPageGlobalUsageGenerator
(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 TypeMethodDescriptionprotected 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 groupprotected void
outputGroupCommandUsages
(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected 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
-
Field Details
-
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 classMarkdownGlobalUsageGenerator<T>
- Parameters:
printer
- Usage printerglobal
- Global Meta-datagroups
- 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 classMarkdownGlobalUsageGenerator<T>
- Parameters:
printer
- Usage printerglobal
- 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)
-