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>
public class ManMultiPageGlobalUsageGenerator<T> extends ManGlobalUsageGenerator<T>
-
-
Field Summary
Fields Modifier and Type Field Description private java.io.File
baseDirectory
-
Fields 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
Constructors Modifier Constructor Description ManMultiPageGlobalUsageGenerator()
ManMultiPageGlobalUsageGenerator(int manSection)
ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden)
protected
ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden, CommandUsageGenerator commandUsageGenerator, java.io.File baseDir)
ManMultiPageGlobalUsageGenerator(int manSection, 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 void
outputCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global)
Outputs the command usages for all groupsprotected void
outputDefaultGroupCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global)
Outputs the command usages for the commands in the default groupprotected void
outputGroupCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, java.util.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
-
-
-
-
Constructor Detail
-
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator()
-
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator(int manSection)
-
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden)
-
ManMultiPageGlobalUsageGenerator
public ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden, java.io.File baseDirectory)
-
ManMultiPageGlobalUsageGenerator
protected ManMultiPageGlobalUsageGenerator(int manSection, boolean includeHidden, CommandUsageGenerator commandUsageGenerator, java.io.File baseDir)
-
-
Method Detail
-
outputCommandUsages
protected void outputCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) throws java.io.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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputGroupCommandUsages
protected void outputGroupCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups) throws java.io.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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputReferenceToSuite
protected void outputReferenceToSuite(TroffPrinter printer, 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(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) throws java.io.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:
java.io.IOException
- Thrown if there is a problem generating usage output
-
-