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 java.io.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, java.io.File baseDirectory)
MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden, java.io.File baseDirectory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.io.FileOutputStream
createCommandFile(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)
protected java.lang.String
getCommandName(GlobalMetadata<T> global, java.lang.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, java.util.List<CommandGroupMetadata> groups)
Outputs the command usages for the commands in the given groupprotected void
outputReferenceToSuite(java.io.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
-
-
-
-
Constructor Detail
-
MarkdownMultiPageGlobalUsageGenerator
public MarkdownMultiPageGlobalUsageGenerator()
-
MarkdownMultiPageGlobalUsageGenerator
public MarkdownMultiPageGlobalUsageGenerator(boolean includeHidden)
-
MarkdownMultiPageGlobalUsageGenerator
public MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden)
-
MarkdownMultiPageGlobalUsageGenerator
public MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden, java.io.File baseDirectory)
-
MarkdownMultiPageGlobalUsageGenerator
protected MarkdownMultiPageGlobalUsageGenerator(int columns, boolean includeHidden, AbstractPrintedCommandUsageGenerator commandUsageGenerator, java.io.File baseDirectory)
-
-
Method Detail
-
outputGroupCommandUsages
protected void outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups) throws java.io.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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputReferenceToSuite
protected void outputReferenceToSuite(java.io.OutputStream output, GlobalMetadata<T> global) throws java.io.IOException
- Throws:
java.io.IOException
-
createCommandFile
protected java.io.FileOutputStream createCommandFile(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command) throws java.io.FileNotFoundException
- Throws:
java.io.FileNotFoundException
-
outputDefaultGroupCommandUsages
protected void outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global) throws java.io.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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
getCommandName
protected java.lang.String getCommandName(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)
-
-