Uses of Class
com.github.rvesse.airline.model.GlobalMetadata
Packages that use GlobalMetadata
Package
Description
-
Uses of GlobalMetadata in com.github.rvesse.airline
Fields in com.github.rvesse.airline declared as GlobalMetadataModifier and TypeFieldDescriptionprivate GlobalMetadata
<C> HelpOption.globalMetadata
private final GlobalMetadata
<C> Cli.metadata
Methods in com.github.rvesse.airline that return GlobalMetadataConstructors in com.github.rvesse.airline with parameters of type GlobalMetadata -
Uses of GlobalMetadata in com.github.rvesse.airline.examples.cli.commands
Fields in com.github.rvesse.airline.examples.cli.commands declared as GlobalMetadataModifier and TypeFieldDescriptionprivate GlobalMetadata
<ExampleRunnable> BashCompletion.global
private GlobalMetadata
<ExampleRunnable> Help.global
private GlobalMetadata
<ExampleRunnable> Manuals.global
-
Uses of GlobalMetadata in com.github.rvesse.airline.help
Fields in com.github.rvesse.airline.help declared as GlobalMetadataMethods in com.github.rvesse.airline.help with parameters of type GlobalMetadataModifier and TypeMethodDescriptionstatic <T> void
Help.help
(GlobalMetadata<T> global, List<String> commandNames) Displays plain text format program help to standard outstatic <T> void
Help.help
(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden) Displays plain text format program help to standard outstatic <T> void
Help.help
(GlobalMetadata<T> global, List<String> commandNames, boolean includeHidden, OutputStream out) Displays plain text format program help to the given output streamstatic <T> void
Help.help
(GlobalMetadata<T> global, List<String> commandNames, OutputStream out) Displays plain text format program help to the given output streamvoid
CommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups) Generate the help and output it on standard outvoid
CommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream output) Generate the help and output it to the streamvoid
GlobalUsageGenerator.usage
(GlobalMetadata<T> global) Generate the help and output it on standard outvoid
GlobalUsageGenerator.usage
(GlobalMetadata<T> global, OutputStream output) Generate the help and output it to the stream -
Uses of GlobalMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprotected 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
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, List<CommandGroupMetadata> groups) protected void
CliCommandGroupUsageGenerator.outputOptions
(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) Outputs a documentation section detailing the available options and their usagesprotected void
CliCommandGroupUsageGenerator.outputSynopsis
(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) Outputs a documentation section detailing a usage synopsisprotected 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) protected void
CliGlobalUsageGenerator.usage
(GlobalMetadata<T> global, UsagePrinter out) void
CliGlobalUsageSummaryGenerator.usage
(GlobalMetadata<T> global, UsagePrinter out) -
Uses of GlobalMetadata in com.github.rvesse.airline.help.cli.bash
Methods in com.github.rvesse.airline.help.cli.bash with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprivate void
BashCompletionGenerator.generateCommandCompletionFunction
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command) private void
BashCompletionGenerator.generateCommandFunctions
(GlobalMetadata<T> global, Writer writer) private void
BashCompletionGenerator.generateGroupCompletionFunction
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group) private void
BashCompletionGenerator.generateGroupFunctions
(GlobalMetadata<T> global, Writer writer) void
BashCompletionGenerator.usage
(GlobalMetadata<T> global, OutputStream output) private void
BashCompletionGenerator.writeCommandCase
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent, boolean isNestedFunction) private void
BashCompletionGenerator.writeCommandFunctionCall
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent) private void
BashCompletionGenerator.writeCommandFunctionName
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, boolean declare) private void
BashCompletionGenerator.writeFunctionName
(Writer writer, GlobalMetadata<T> global, boolean declare) private void
BashCompletionGenerator.writeGroupCase
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent) private void
BashCompletionGenerator.writeGroupFunctionCall
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent) private void
BashCompletionGenerator.writeGroupFunctionName
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, boolean declare) -
Uses of GlobalMetadata in com.github.rvesse.airline.help.common
Methods in com.github.rvesse.airline.help.common with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprotected void
AbstractGlobalUsageGenerator.findHelpSections
(GlobalMetadata<T> global, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sectionsvoid
AbstractCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups) void
AbstractGlobalUsageGenerator.usage
(GlobalMetadata<T> global) protected abstract void
AbstractPrintedCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out) Generate the help and output is using the providedUsagePrinter
void
AbstractPrintedCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream out) protected abstract void
AbstractPrintedGlobalUsageGenerator.usage
(GlobalMetadata<T> global, UsagePrinter out) Generate the help and output is using the providedUsagePrinter
void
AbstractPrintedGlobalUsageGenerator.usage
(GlobalMetadata<T> global, OutputStream out) -
Uses of GlobalMetadata in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprotected FileOutputStream
ManMultiPageGlobalUsageGenerator.createCommandFile
(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command) protected String
ManGlobalUsageGenerator.getCommandName
(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command) Gets the display name for a commandprotected void
ManGlobalUsageGenerator.outputCommandList
(TroffPrinter printer, GlobalMetadata<T> global) Outputs a documentation section that lists the available commandsprotected void
ManGlobalUsageGenerator.outputCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) Outputs the command usages for all groupsprotected void
ManMultiPageGlobalUsageGenerator.outputCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) protected void
ManGlobalUsageGenerator.outputDefaultGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) Outputs the command usages for the commands in the default groupprotected void
ManMultiPageGlobalUsageGenerator.outputDefaultGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global) protected void
ManGlobalUsageGenerator.outputGroupCommandsList
(TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) protected void
ManGlobalUsageGenerator.outputGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected void
ManMultiPageGlobalUsageGenerator.outputGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) protected void
ManGlobalUsageGenerator.outputGroupList
(TroffPrinter printer, GlobalMetadata<T> global) Outputs a documentation section that lists the available groups and the commands they containprotected void
ManMultiPageGlobalUsageGenerator.outputReferenceToSuite
(TroffPrinter printer, GlobalMetadata<T> global) protected void
ManGlobalUsageGenerator.outputSynopsis
(TroffPrinter printer, GlobalMetadata<T> global) Outputs a documentation section with a synopsis of how to use the CLIprotected void
ManGlobalUsageGenerator.outputTitle
(GlobalMetadata<T> global, TroffPrinter printer) Outputs the title section for the documentationvoid
ManGlobalUsageGenerator.usage
(GlobalMetadata<T> global, OutputStream output) -
Uses of GlobalMetadata in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprotected FileOutputStream
MarkdownMultiPageGlobalUsageGenerator.createCommandFile
(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command) protected String
MarkdownMultiPageGlobalUsageGenerator.getCommandName
(GlobalMetadata<T> global, String[] groupNames, CommandMetadata command) protected 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
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, List<CommandGroupMetadata> groups) protected void
MarkdownGlobalUsageGenerator.outputGroupCommandUsages
(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected void
MarkdownMultiPageGlobalUsageGenerator.outputGroupCommandUsages
(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) protected void
MarkdownMultiPageGlobalUsageGenerator.outputReferenceToSuite
(OutputStream output, GlobalMetadata<T> global) protected 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) protected void
MarkdownGlobalUsageGenerator.usage
(GlobalMetadata<T> global, UsagePrinter out) -
Uses of GlobalMetadata in com.github.rvesse.airline.help.suggester
Fields in com.github.rvesse.airline.help.suggester declared as GlobalMetadata -
Uses of GlobalMetadata in com.github.rvesse.airline.model
Methods in com.github.rvesse.airline.model that return GlobalMetadataModifier and TypeMethodDescriptionstatic <C> GlobalMetadata
<C> MetadataLoader.loadGlobal
(Class<?> cliClass) static <C> GlobalMetadata
<C> MetadataLoader.loadGlobal
(Class<?> cliClass, ParserMetadata<C> parserConfigOverride) Loads the metadata for a CLIstatic <C> GlobalMetadata
<C> MetadataLoader.loadGlobal
(String name, String description, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> groups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig) Loads global meta-data -
Uses of GlobalMetadata in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as GlobalMetadataMethods in com.github.rvesse.airline.parser that return GlobalMetadataMethods in com.github.rvesse.airline.parser with parameters of type GlobalMetadataModifier and TypeMethodDescriptionprotected ParseState
<T> AbstractCommandParser.tryParse
(GlobalMetadata<T> metadata, Iterable<String> args) Tries to parse the argumentsprotected ParseState
<T> AbstractCommandParser.tryParse
(GlobalMetadata<T> metadata, String... args) Tries to parse the argumentsParseState.withGlobal
(GlobalMetadata<T> global) Constructors in com.github.rvesse.airline.parser with parameters of type GlobalMetadataModifierConstructorDescription(package private)
ParseState
(GlobalMetadata<T> global, ParserMetadata<T> parserConfig, CommandGroupMetadata group, CommandMetadata command, List<org.apache.commons.lang3.tuple.Pair<OptionMetadata, Object>> parsedOptions, Map<OptionMetadata, Integer> optionsCount, List<Context> locationStack, List<Object> parsedArguments, OptionMetadata currentOption, List<String> unparsedInput) -
Uses of GlobalMetadata in com.github.rvesse.airline.parser.command
Methods in com.github.rvesse.airline.parser.command with parameters of type GlobalMetadataModifier and TypeMethodDescriptionCliParser.parse
(GlobalMetadata<T> metadata, Iterable<String> args) CliParser.parseWithResult
(GlobalMetadata<T> metadata, Iterable<String> args) -
Uses of GlobalMetadata in com.github.rvesse.airline.parser.suggester
Methods in com.github.rvesse.airline.parser.suggester with parameters of type GlobalMetadataModifier and TypeMethodDescriptionSuggestionParser.parse
(GlobalMetadata<T> metadata, Iterable<String> args)