Uses of Class
com.github.rvesse.airline.model.CommandMetadata

Packages that use CommandMetadata

Package	Description
com.github.rvesse.airline
com.github.rvesse.airline.examples.userguide.help.sections
com.github.rvesse.airline.help
com.github.rvesse.airline.help.cli
com.github.rvesse.airline.help.cli.bash
com.github.rvesse.airline.help.common
com.github.rvesse.airline.help.html
com.github.rvesse.airline.help.man
com.github.rvesse.airline.help.markdown
com.github.rvesse.airline.help.suggester
com.github.rvesse.airline.model
com.github.rvesse.airline.parser
com.github.rvesse.airline.parser.command
com.github.rvesse.airline.utils.predicates.parser

Uses of CommandMetadata in com.github.rvesse.airline

Fields in com.github.rvesse.airline declared as CommandMetadata

Modifier and Type	Field	Description
private CommandMetadata	HelpOption.commandMetadata
private CommandMetadata	SingleCommand.commandMetadata

Methods in com.github.rvesse.airline that return CommandMetadata

Modifier and Type	Method	Description
CommandMetadata	SingleCommand.getCommandMetadata()	Gets the command metadata

Uses of CommandMetadata in com.github.rvesse.airline.examples.userguide.help.sections

Fields in com.github.rvesse.airline.examples.userguide.help.sections declared as CommandMetadata

Modifier and Type	Field	Description
private CommandMetadata	Discussed.metadata
private CommandMetadata	ExternalHelp.metadata

Uses of CommandMetadata in com.github.rvesse.airline.help

Fields in com.github.rvesse.airline.help with type parameters of type CommandMetadata

Modifier and Type	Field	Description
static java.util.Comparator<CommandMetadata>	UsageHelper.DEFAULT_COMMAND_COMPARATOR	Default comparator for commands

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

Modifier and Type	Method	Description
static void	Help.help(CommandMetadata command)	Displays plain text format help for the given command to standard out
static void	Help.help(CommandMetadata command, boolean includeHidden)	Displays plain text format help for the given command to standard out
static void	Help.help(CommandMetadata command, boolean includeHidden, java.io.OutputStream out)	Displays plain text format help or the given command to the given output stream
static void	Help.help(CommandMetadata command, java.io.OutputStream out)	Displays plain text format help or the given command to the given output stream
<T> void	CommandUsageGenerator.usage(CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)	Generates the help output to the provided output stream
<T> void	CommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig)	Generate the help and output it on standard out
<T> void	CommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)	Generate the help and output it to the stream

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

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

Modifier and Type	Method	Description
protected void	CliGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
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 <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 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
<T> void	CliCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)

Uses of CommandMetadata in com.github.rvesse.airline.help.cli.bash

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

Modifier and Type	Method	Description
private void	BashCompletionGenerator.generateCommandCompletionFunction(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command)
private void	BashCompletionGenerator.writeCommandCase(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent, boolean isNestedFunction)
private void	BashCompletionGenerator.writeCommandFunctionCall(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent)
private void	BashCompletionGenerator.writeCommandFunctionName(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, boolean declare)

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

Fields in com.github.rvesse.airline.help.common with type parameters of type CommandMetadata

Modifier and Type	Field	Description
private java.util.Comparator<? super CommandMetadata>	AbstractUsageGenerator.commandComparator

Methods in com.github.rvesse.airline.help.common that return types with arguments of type CommandMetadata

Modifier and Type	Method	Description
protected java.util.Comparator<? super CommandMetadata>	AbstractUsageGenerator.getCommandComparator()
protected java.util.List<CommandMetadata>	AbstractUsageGenerator.sortCommands(java.util.List<CommandMetadata> commands)	Sorts the commands assuming a non-null comparator was provided at instantiation time

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

Modifier and Type	Method	Description
protected void	AbstractCommandUsageGenerator.findHelpSections(CommandMetadata command, java.util.List<HelpSection> preSections, java.util.List<HelpSection> postSections)	Finds the help sections
<T> void	AbstractCommandUsageGenerator.usage(CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)
<T> void	AbstractCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig)
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
<T> void	AbstractPrintedCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream out)

Method parameters in com.github.rvesse.airline.help.common with type arguments of type CommandMetadata

Modifier and Type	Method	Description
protected java.util.List<CommandMetadata>	AbstractUsageGenerator.sortCommands(java.util.List<CommandMetadata> commands)	Sorts the commands assuming a non-null comparator was provided at instantiation time

Uses of CommandMetadata in com.github.rvesse.airline.help.html

Methods in com.github.rvesse.airline.help.html with parameters of type CommandMetadata

Modifier and Type	Method	Description
protected void	HtmlCommandUsageGenerator.outputDescription(java.io.Writer writer, java.lang.String programName, java.lang.String[] groupNames, CommandMetadata command)	Outputs a documentation section with the name and description of the command
protected void	HtmlCommandUsageGenerator.outputPageHeader(java.io.Writer writer, java.lang.String programName, java.lang.String[] groupNames, CommandMetadata command)	Outputs a page header
protected java.util.List<OptionMetadata>	HtmlCommandUsageGenerator.outputSynopsis(java.io.Writer writer, java.lang.String programName, java.lang.String[] groupNames, CommandMetadata command)	Outputs a documentation section with a synopsis of the command
<T> void	HtmlCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)

Uses of CommandMetadata in com.github.rvesse.airline.help.man

Methods in com.github.rvesse.airline.help.man with parameters of type CommandMetadata

Modifier and Type	Method	Description
protected java.io.FileOutputStream	ManMultiPageGlobalUsageGenerator.createCommandFile(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)
protected java.lang.String	ManGlobalUsageGenerator.getCommandName(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)	Gets the display name for a command
protected <T> void	ManCommandUsageGenerator.outputOptions(TroffPrinter printer, CommandMetadata command, java.util.List<OptionMetadata> options, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing the options and their usages
protected java.util.List<OptionMetadata>	ManCommandUsageGenerator.outputSynopsis(TroffPrinter printer, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a synopsis section for the documentation showing how to use a command
protected void	ManCommandUsageGenerator.outputTitle(TroffPrinter printer, java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command)	Outputs a title section for the document
<T> void	ManCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, java.io.OutputStream output)

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

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

Modifier and Type	Method	Description
protected java.io.FileOutputStream	MarkdownMultiPageGlobalUsageGenerator.createCommandFile(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)
protected java.lang.String	MarkdownMultiPageGlobalUsageGenerator.getCommandName(GlobalMetadata<T> global, java.lang.String[] groupNames, CommandMetadata command)
protected void	MarkdownGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
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 <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
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
<T> void	MarkdownCommandUsageGenerator.usage(java.lang.String programName, java.lang.String[] groupNames, java.lang.String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)

Uses of CommandMetadata in com.github.rvesse.airline.help.suggester

Fields in com.github.rvesse.airline.help.suggester declared as CommandMetadata

Modifier and Type	Field	Description
CommandMetadata	CommandSuggester.command

Uses of CommandMetadata in com.github.rvesse.airline.model

Fields in com.github.rvesse.airline.model declared as CommandMetadata

Modifier and Type	Field	Description
private CommandMetadata	CommandGroupMetadata.defaultCommand
private CommandMetadata	GlobalMetadata.defaultCommand

Fields in com.github.rvesse.airline.model with type parameters of type CommandMetadata

Modifier and Type	Field	Description
private java.util.List<CommandMetadata>	CommandGroupMetadata.commands
private java.util.List<CommandMetadata>	GlobalMetadata.defaultGroupCommands

Methods in com.github.rvesse.airline.model that return CommandMetadata

Modifier and Type	Method	Description
CommandMetadata	CommandGroupMetadata.getDefaultCommand()	Gets the default command for the group
CommandMetadata	GlobalMetadata.getDefaultCommand()	Gets the default command for the CLI
static CommandMetadata	MetadataLoader.loadCommand(java.lang.Class<?> commandType, ParserMetadata<?> parserConfig)	Loads command meta-data
static CommandMetadata	MetadataLoader.loadCommand(java.lang.Class<?> commandType, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)	Loads command meta-data

Methods in com.github.rvesse.airline.model that return types with arguments of type CommandMetadata

Modifier and Type	Method	Description
java.util.List<CommandMetadata>	CommandGroupMetadata.getCommands()	Gets the commands for the group
java.util.List<CommandMetadata>	GlobalMetadata.getDefaultGroupCommands()	Gets the default group of commands for the CLI i.e.
static <T> java.util.List<CommandMetadata>	MetadataLoader.loadCommands(java.lang.Iterable<java.lang.Class<? extends T>> defaultCommands, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)	Loads command meta-data

Methods in com.github.rvesse.airline.model with parameters of type CommandMetadata

Modifier and Type	Method	Description
void	CommandGroupMetadata.addCommand(CommandMetadata command)	Adds a command to the group
private static void	GlobalMetadata.checkForSuppressedCommands(java.util.List<CommandMetadata> commands, CommandMetadata defaultCommand, java.lang.String groupName)
static CommandGroupMetadata	MetadataLoader.loadCommandGroup(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> commands)	Loads command group meta-data
static <C> GlobalMetadata<C>	MetadataLoader.loadGlobal(java.lang.String name, java.lang.String description, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> defaultGroupCommands, java.lang.Iterable<CommandGroupMetadata> groups, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig)	Loads global meta-data
private static void	GlobalMetadata.suppressedCommand(java.lang.Class<?> cls, CommandMetadata cmd, java.lang.String groupName)

Method parameters in com.github.rvesse.airline.model with type arguments of type CommandMetadata

Modifier and Type	Method	Description
private static void	GlobalMetadata.checkForSuppressedCommands(java.util.List<CommandMetadata> commands, CommandMetadata defaultCommand, java.lang.String groupName)
private static void	MetadataLoader.createGroupsFromAnnotations(java.util.List<CommandMetadata> allCommands, java.util.List<CommandMetadata> newCommands, java.util.List<CommandGroupMetadata> commandGroups, java.util.List<CommandMetadata> defaultCommandGroup, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
static void	MetadataLoader.loadCommandsIntoGroupsByAnnotation(java.util.List<CommandMetadata> allCommands, java.util.List<CommandGroupMetadata> commandGroups, java.util.List<CommandMetadata> defaultCommandGroup, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
static <C> GlobalMetadata<C>	MetadataLoader.loadGlobal(java.lang.String name, java.lang.String description, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> defaultGroupCommands, java.lang.Iterable<CommandGroupMetadata> groups, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig)	Loads global meta-data

Constructors in com.github.rvesse.airline.model with parameters of type CommandMetadata

Constructor	Description
CommandGroupMetadata(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<OptionMetadata> options, java.lang.Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> commands)
GlobalMetadata(java.lang.String name, java.lang.String description, java.lang.Iterable<OptionMetadata> options, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> defaultGroupCommands, java.lang.Iterable<CommandGroupMetadata> commandGroups, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<HelpSection> baseHelpSections, ParserMetadata<T> parserConfig)

Uses of CommandMetadata in com.github.rvesse.airline.parser

Fields in com.github.rvesse.airline.parser declared as CommandMetadata

Modifier and Type	Field	Description
private CommandMetadata	ParseState.command

Methods in com.github.rvesse.airline.parser that return CommandMetadata

Modifier and Type	Method	Description
CommandMetadata	ParseState.getCommand()

Methods in com.github.rvesse.airline.parser with parameters of type CommandMetadata

Modifier and Type	Method	Description
protected ParseState<T>	AbstractCommandParser.parseCommandOptionsAndArguments(org.apache.commons.collections4.iterators.PeekingIterator<java.lang.String> tokens, ParseState<T> state, CommandMetadata command)
protected ParseState<T>	AbstractCommandParser.tryParse(ParserMetadata<T> parserConfig, CommandMetadata command, java.lang.Iterable<java.lang.String> args)	Tries to parse the arguments
ParseState<T>	ParseState.withCommand(CommandMetadata command)

Constructors in com.github.rvesse.airline.parser with parameters of type CommandMetadata

Constructor

Description

ParseState(GlobalMetadata<T> global, ParserMetadata<T> parserConfig, CommandGroupMetadata group, CommandMetadata command, java.util.List<org.apache.commons.lang3.tuple.Pair<OptionMetadata,java.lang.Object>> parsedOptions, java.util.Map<OptionMetadata,java.lang.Integer> optionsCount, java.util.List<Context> locationStack, java.util.List<java.lang.Object> parsedArguments, OptionMetadata currentOption, java.util.List<java.lang.String> unparsedInput)

Uses of CommandMetadata in com.github.rvesse.airline.parser.command

Methods in com.github.rvesse.airline.parser.command with parameters of type CommandMetadata

Modifier and Type	Method	Description
T	SingleCommandParser.parse(ParserMetadata<T> parserConfig, CommandMetadata commandMetadata, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<java.lang.String> args)
ParseResult<T>	SingleCommandParser.parseWithResult(ParserMetadata<T> parserConfig, CommandMetadata commandMetadata, java.lang.Iterable<GlobalRestriction> restrictions, java.lang.Iterable<java.lang.String> args)

Uses of CommandMetadata in com.github.rvesse.airline.utils.predicates.parser

Methods in com.github.rvesse.airline.utils.predicates.parser with parameters of type CommandMetadata

Modifier and Type	Method	Description
boolean	CommandFinder.evaluate(CommandMetadata command)
boolean	CommandTypeFinder.evaluate(CommandMetadata command)
protected boolean	AbbreviatedCommandFinder.isExactNameMatch(java.lang.String value, CommandMetadata item)
protected boolean	AbbreviatedCommandFinder.isPartialNameMatch(java.lang.String value, CommandMetadata item)

Constructor parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type CommandMetadata

Constructor	Description
AbbreviatedCommandFinder(java.lang.String cmd, java.util.Collection<CommandMetadata> commands)