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 AbstractPrintedCommandUsageGenerator
commandUsageGenerator
private MarkdownUsageHelper
helper
-
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
-
Constructor Summary
Constructors Constructor Description MarkdownGlobalUsageGenerator()
MarkdownGlobalUsageGenerator(boolean includeHidden)
MarkdownGlobalUsageGenerator(int columns)
MarkdownGlobalUsageGenerator(int columns, boolean includeHidden)
MarkdownGlobalUsageGenerator(int columnSize, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden, AbstractPrintedCommandUsageGenerator commandUsageGenerator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected MarkdownUsageHelper
createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected void
outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)
Outputs the description for a commandprotected void
outputCommandList(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section listing the commandsprotected void
outputCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)
Outputs the command usages for all groupsprotected void
outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)
Outputs the command usages for the commands in the default groupprotected void
outputDescription(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a description of the CLIprotected void
outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
protected void
outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
Outputs the command usages for the commands in the given groupprotected void
outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a synopsis of CLI usageprotected 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 providedUsagePrinter
-
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 Detail
-
helper
private final MarkdownUsageHelper helper
-
commandUsageGenerator
protected final AbstractPrintedCommandUsageGenerator commandUsageGenerator
-
-
Constructor Detail
-
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, java.util.Comparator<? super HelpHint> hintComparator, java.util.Comparator<? super OptionMetadata> optionComparator, java.util.Comparator<? super CommandMetadata> commandComparator, java.util.Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden, AbstractPrintedCommandUsageGenerator commandUsageGenerator)
-
-
Method Detail
-
createHelper
protected MarkdownUsageHelper createHelper(java.util.Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
-
usage
protected void usage(GlobalMetadata<T> global, UsagePrinter out) throws java.io.IOException
Description copied from class:AbstractPrintedGlobalUsageGenerator
Generate the help and output is using the providedUsagePrinter
- Specified by:
usage
in classAbstractPrintedGlobalUsageGenerator<T>
- Parameters:
global
- Global Metadataout
- Usage printer to output with- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputCommandList
protected void outputCommandList(UsagePrinter out, GlobalMetadata<T> global) throws java.io.IOException
Outputs a documentation section listing the commands- Parameters:
out
- Usage printerglobal
- Global meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputGroupCommandsList
protected void outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups) throws java.io.IOException
- Throws:
java.io.IOException
-
outputSynopsis
protected void outputSynopsis(UsagePrinter out, GlobalMetadata<T> global) throws java.io.IOException
Outputs a documentation section with a synopsis of CLI usage- Parameters:
out
- Usage printerglobal
- Global meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputDescription
protected void outputDescription(UsagePrinter out, GlobalMetadata<T> global) throws java.io.IOException
Outputs a documentation section with a description of the CLI- Parameters:
out
- Usage printerglobal
- Global meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputCommandDescription
protected void outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) throws java.io.IOException
Outputs the description for a command- Parameters:
out
- Usage printergroup
- Group meta-datacommand
- Command meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputUserAliases
protected void outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases) throws java.io.IOException
- Throws:
java.io.IOException
-
outputCommandUsages
protected void outputCommandUsages(UsagePrinter printer, GlobalMetadata<T> global) throws java.io.IOException
Outputs the command usages for all groups- Parameters:
printer
- Usage printerglobal
- Global meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputDefaultGroupCommandUsages
protected void outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global) throws java.io.IOException
Outputs the command usages for the commands in the default group- Parameters:
printer
- Usage printerglobal
- Global meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
outputGroupCommandUsages
protected void outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups) throws java.io.IOException
Outputs the command usages for the commands in the given group- Parameters:
printer
- Usage printerglobal
- Global Meta-datagroups
- Groups Meta-data- Throws:
java.io.IOException
- Thrown if there is a problem generating usage output
-
-