Class ManMultiPageGlobalUsageGenerator<T>
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator<T>
com.github.rvesse.airline.help.man.ManGlobalUsageGenerator<T>
com.github.rvesse.airline.help.man.ManMultiPageGlobalUsageGenerator<T>
- All Implemented Interfaces:
GlobalUsageGenerator<T>
-
Field Summary
FieldsFields inherited from class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
commandUsageGenerator, helper, manSection
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsModifierConstructorDescriptionManMultiPageGlobalUsageGenerator
(int manSection) ManMultiPageGlobalUsageGenerator
(int manSection, boolean includeHidden) protected
ManMultiPageGlobalUsageGenerator
(int manSection, boolean includeHidden, CommandUsageGenerator commandUsageGenerator, File baseDir) ManMultiPageGlobalUsageGenerator
(int manSection, boolean includeHidden, File baseDirectory) -
Method Summary
Modifier and TypeMethodDescriptionprotected FileOutputStream
createCommandFile
(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command) protected void
outputCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) Outputs the command usages for all groupsprotected void
outputDefaultGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) Outputs the command usages for the commands in the default groupprotected void
outputGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected void
outputReferenceToSuite
(TroffPrinter printer, GlobalMetadata<T> global) Methods inherited from class com.github.rvesse.airline.help.man.ManGlobalUsageGenerator
createHelper, getCommandName, outputCommandList, outputGroupCommandsList, outputGroupList, outputSynopsis, outputTitle, toDescription, 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, toSynopsisUsage, toUsage, toUsage
-
Field Details
-
baseDirectory
-
-
Constructor Details
-
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator() -
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator(int manSection) -
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden) -
ManMultiPageGlobalUsageGenerator
-
ManMultiPageGlobalUsageGenerator
protected ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden, CommandUsageGenerator commandUsageGenerator, File baseDir)
-
-
Method Details
-
outputCommandUsages
protected void outputCommandUsages(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) throws IOException Description copied from class:ManGlobalUsageGenerator
Outputs the command usages for all groups- Overrides:
outputCommandUsages
in classManGlobalUsageGenerator<T>
- Parameters:
output
- Output streamprinter
- Writerglobal
- Global meta-data- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputGroupCommandUsages
protected void outputGroupCommandUsages(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) throws IOException Description copied from class:ManGlobalUsageGenerator
Outputs the command usages for the commands in the given group- Overrides:
outputGroupCommandUsages
in classManGlobalUsageGenerator<T>
- Parameters:
output
- Outputprinter
- Writerglobal
- Global Meta-datagroups
- Groups Meta-data- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputReferenceToSuite
protected void outputReferenceToSuite(TroffPrinter printer, 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(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) throws IOException Description copied from class:ManGlobalUsageGenerator
Outputs the command usages for the commands in the default group- Overrides:
outputDefaultGroupCommandUsages
in classManGlobalUsageGenerator<T>
- Parameters:
output
- Outputprinter
- Writerglobal
- Global meta-data- Throws:
IOException
- Thrown if there is a problem generating usage output
-