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 optionprotected void
CliGlobalUsageGenerator. outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)
Outputs the description for a commandprotected void
CliGlobalUsageGenerator. outputCommandList(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section listing the commandsprotected void
CliGlobalUsageSummaryGenerator. outputCommandList(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section listing the common commands and groupsprotected void
CliCommandGroupUsageGenerator. outputDescription(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)
Outputs a description of the groupprotected 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 commandprotected void
CliGlobalUsageGenerator. outputDescription(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a description of the CLIprotected void
CliGlobalUsageSummaryGenerator. outputFooter(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section detailing how to get more helpprotected void
CliGlobalUsageGenerator. outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
void
CliUsageHelper. outputHelpSection(UsagePrinter out, HelpSection section)
Outputs a help sectionprotected 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 optionprotected void
CliCommandGroupUsageGenerator. outputOptions(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)
Outputs a documentation section detailing the available options and their usagesvoid
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 usagesprotected void
CliCommandGroupUsageGenerator. outputSynopsis(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)
Outputs a documentation section detailing a usage synopsisprotected 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 usageprotected void
CliGlobalUsageGenerator. outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a synopsis of CLI usageprotected void
CliGlobalUsageSummaryGenerator. outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a brief synopsis of usageprotected 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 streamprotected UsagePrinter
AbstractPrintedCommandUsageGenerator. createUsagePrinter(java.io.OutputStream out)
Creates a usage printer for the given streamprotected UsagePrinter
AbstractPrintedGlobalUsageGenerator. createUsagePrinter(java.io.OutputStream out)
Creates a usage printer for the given streamMethods 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 providedUsagePrinter
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 providedUsagePrinter
protected abstract void
AbstractPrintedGlobalUsageGenerator. usage(GlobalMetadata<T> global, UsagePrinter out)
Generate the help and output is using the providedUsagePrinter
-
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 optionvoid
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 commandprotected void
MarkdownGlobalUsageGenerator. outputCommandList(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section listing the commandsprotected void
MarkdownGlobalUsageGenerator. outputCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)
Outputs the command usages for all groupsprotected void
MarkdownGlobalUsageGenerator. outputDefaultGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global)
Outputs the command usages for the commands in the default groupprotected 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 commandprotected void
MarkdownGlobalUsageGenerator. outputDescription(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a description of the CLIprotected 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 groupprotected void
MarkdownMultiPageGlobalUsageGenerator. outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
void
MarkdownUsageHelper. outputHelpSection(UsagePrinter out, HelpSection section)
Outputs a help sectionprotected 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 optionvoid
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 usagesvoid
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 usageprotected void
MarkdownGlobalUsageGenerator. outputSynopsis(UsagePrinter out, GlobalMetadata<T> global)
Outputs a documentation section with a synopsis of CLI usageprotected 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)
-