Uses of Class
com.github.rvesse.airline.io.printers.UsagePrinter

Packages that use UsagePrinter

Package	Description
com.github.rvesse.airline.help.cli
com.github.rvesse.airline.help.common
com.github.rvesse.airline.help.markdown
com.github.rvesse.airline.io.printers

Uses of UsagePrinter in com.github.rvesse.airline.help.cli

Methods in com.github.rvesse.airline.help.cli with parameters of type UsagePrinter

Modifier and Type	Method	Description
<T> void	CliUsageHelper.outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected void	CliUsageHelper.outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option
protected void	CliGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
protected void	CliGlobalUsageGenerator.outputCommandList(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section listing the commands
protected void	CliGlobalUsageSummaryGenerator.outputCommandList(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section listing the common commands and groups
protected void	CliCommandGroupUsageGenerator.outputDescription(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a description of the group
protected void	CliCommandUsageGenerator.outputDescription(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a documentation section describing the command
protected void	CliGlobalUsageGenerator.outputDescription(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a description of the CLI
protected void	CliGlobalUsageSummaryGenerator.outputFooter(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section detailing how to get more help
protected void	CliGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
void	CliUsageHelper.outputHelpSection(UsagePrinter out, HelpSection section)	Outputs a help section
protected void	CliUsageHelper.outputHint(UsagePrinter out, HelpHint hint, boolean newPara)
protected void	CliUsageHelper.outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option
protected void	CliCommandGroupUsageGenerator.outputOptions(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing the available options and their usages
void	CliUsageHelper.outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options)
protected <T> void	CliCommandUsageGenerator.outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, java.util.List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing options and their usages
protected void	CliCommandGroupUsageGenerator.outputSynopsis(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing a usage synopsis
protected java.util.List<OptionMetadata>	CliCommandUsageGenerator.outputSynopsis(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a documentation section with a synopsis of command usage
protected void	CliGlobalUsageGenerator.outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a synopsis of CLI usage
protected void	CliGlobalUsageSummaryGenerator.outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a brief synopsis of usage
protected void	CliGlobalUsageGenerator.outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases)
protected void	CliCommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out)
<T> void	CliCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)
protected void	CliGlobalUsageGenerator.usage(GlobalMetadata<T> global, UsagePrinter out)
void	CliGlobalUsageSummaryGenerator.usage(GlobalMetadata<T> global, UsagePrinter out)

Uses of UsagePrinter in com.github.rvesse.airline.help.common

Methods in com.github.rvesse.airline.help.common that return UsagePrinter

Modifier and Type	Method	Description
protected UsagePrinter	AbstractPrintedCommandGroupUsageGenerator.createUsagePrinter(java.io.OutputStream out)	Creates a usage printer for the given stream
protected UsagePrinter	AbstractPrintedCommandUsageGenerator.createUsagePrinter(java.io.OutputStream out)	Creates a usage printer for the given stream
protected UsagePrinter	AbstractPrintedGlobalUsageGenerator.createUsagePrinter(java.io.OutputStream out)	Creates a usage printer for the given stream

Methods in com.github.rvesse.airline.help.common with parameters of type UsagePrinter

Modifier and Type	Method	Description
protected abstract void	AbstractPrintedCommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out)	Generate the help and output is using the provided UsagePrinter
abstract <T> void	AbstractPrintedCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)	Generate the help and output it using the provided UsagePrinter
protected abstract void	AbstractPrintedGlobalUsageGenerator.usage(GlobalMetadata<T> global, UsagePrinter out)	Generate the help and output is using the provided UsagePrinter

Uses of UsagePrinter in com.github.rvesse.airline.help.markdown

Methods in com.github.rvesse.airline.help.markdown with parameters of type UsagePrinter

Modifier and Type	Method	Description
<T> void	MarkdownUsageHelper.outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected void	MarkdownUsageHelper.outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option
void	MarkdownUsageHelper.outputArgumentsSynopsis(UsagePrinter printer, ArgumentsMetadata arguments)
void	MarkdownUsageHelper.outputArgumentsTitle(UsagePrinter printer, ArgumentsMetadata arguments)
protected void	MarkdownGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
protected void	MarkdownGlobalUsageGenerator.outputCommandList(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section listing the commands
protected void	MarkdownGlobalUsageGenerator.outputCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)	Outputs the command usages for all groups
protected void	MarkdownGlobalUsageGenerator.outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)	Outputs the command usages for the commands in the default group
protected void	MarkdownMultiPageGlobalUsageGenerator.outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)
protected void	MarkdownCommandUsageGenerator.outputDescription(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a documentation section describing the command
protected void	MarkdownGlobalUsageGenerator.outputDescription(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a description of the CLI
protected void	MarkdownGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
protected void	MarkdownGlobalUsageGenerator.outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)	Outputs the command usages for the commands in the given group
protected void	MarkdownMultiPageGlobalUsageGenerator.outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
void	MarkdownUsageHelper.outputHelpSection(UsagePrinter out, HelpSection section)	Outputs a help section
protected void	MarkdownUsageHelper.outputHint(UsagePrinter out, HelpHint hint, boolean newPara)
protected void	MarkdownUsageHelper.outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint)	Outputs documentation about a restriction on an option
void	MarkdownUsageHelper.outputOptions(UsagePrinter out, java.util.List<OptionMetadata> options)
protected <T> void	MarkdownCommandUsageGenerator.outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, java.util.List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing options and their usages
void	MarkdownUsageHelper.outputOptionsSynopsis(UsagePrinter printer, java.util.List<OptionMetadata> options)
void	MarkdownUsageHelper.outputOptionSynopsis(UsagePrinter printer, OptionMetadata option)
void	MarkdownUsageHelper.outputOptionTitle(UsagePrinter printer, OptionMetadata option)
protected java.util.List<OptionMetadata>	MarkdownCommandUsageGenerator.outputSynopsis(UsagePrinter out, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a documentation section with a synopsis of command usage
protected void	MarkdownGlobalUsageGenerator.outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)	Outputs a documentation section with a synopsis of CLI usage
protected void	MarkdownGlobalUsageGenerator.outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases)
<T> void	MarkdownCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)
protected void	MarkdownGlobalUsageGenerator.usage(GlobalMetadata<T> global, UsagePrinter out)

Uses of UsagePrinter in com.github.rvesse.airline.io.printers

Methods in com.github.rvesse.airline.io.printers that return UsagePrinter

Modifier and Type	Method	Description
UsagePrinter	UsagePrinter.append(java.lang.String value)
UsagePrinter	UsagePrinter.append(java.lang.String value, boolean avoidNewlines)
UsagePrinter	UsagePrinter.appendLines(java.lang.Iterable<java.lang.String> lines)
UsagePrinter	UsagePrinter.appendLines(java.lang.Iterable<java.lang.String> lines, boolean avoidNewlines)
UsagePrinter	UsagePrinter.appendOnOneLine(java.lang.String value)
UsagePrinter	UsagePrinter.appendTable(java.lang.Iterable<? extends java.lang.Iterable<java.lang.String>> table, int rowSpacing)
UsagePrinter	UsagePrinter.appendWords(java.lang.Iterable<java.lang.String> words)
UsagePrinter	UsagePrinter.appendWords(java.lang.Iterable<java.lang.String> words, boolean avoidNewlines)
UsagePrinter	UsagePrinter.appendWords(java.lang.String[] words)
UsagePrinter	UsagePrinter.appendWords(java.lang.String[] words, boolean avoidNewlines)
UsagePrinter	UsagePrinter.newIndentedPrinter(int size)
UsagePrinter	UsagePrinter.newline()
UsagePrinter	UsagePrinter.newPrinterWithHangingIndent(int size)