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

Packages that use ParserMetadata

Package	Description
com.github.rvesse.airline
com.github.rvesse.airline.builder
com.github.rvesse.airline.examples
com.github.rvesse.airline.help
com.github.rvesse.airline.help.cli
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.model
com.github.rvesse.airline.parser
com.github.rvesse.airline.parser.command

Uses of ParserMetadata in com.github.rvesse.airline

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

Modifier and Type	Field	Description
private final ParserMetadata<C>	SingleCommand.parserConfig

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

Modifier and Type	Method	Description
ParserMetadata<C>	SingleCommand.getParserConfiguration()	Gets the parser configuration

Methods in com.github.rvesse.airline with parameters of type ParserMetadata

Modifier and Type	Method	Description
static <C> SingleCommand<C>	SingleCommand.singleCommand(Class<C> command, ParserMetadata<C> parserConfig)	Creates a new single command

Constructors in com.github.rvesse.airline with parameters of type ParserMetadata

Modifier	Constructor	Description
	Cli(Class<?> cliClass, ParserMetadata<C> parserConfig)	Creates a new CLI from a class annotated with the Cli annotation
private	SingleCommand(Class<C> command, Iterable<GlobalRestriction> restrictions, ParserMetadata<C> parserConfig)

Uses of ParserMetadata in com.github.rvesse.airline.builder

Subclasses with type arguments of type ParserMetadata in com.github.rvesse.airline.builder

Modifier and Type	Class	Description
class	AliasBuilder<C>	Builds a command alias
class	ParserBuilder<C>	Builder for parser configurations
class	UserAliasSourceBuilder<C>	User alias source builder

Methods in com.github.rvesse.airline.builder that return ParserMetadata

Modifier and Type	Method	Description
ParserMetadata<C>	ParserBuilder.build()
static <T> ParserMetadata<T>	ParserBuilder.defaultConfiguration()	Gets the default configuration

Uses of ParserMetadata in com.github.rvesse.airline.examples

Methods in com.github.rvesse.airline.examples with parameters of type ParserMetadata

Modifier and Type	Method	Description
static <T extends ExampleRunnable> void	ExampleExecutor.executeSingleCommand(Class<T> cls, ParserMetadata<T> parserConfig, String[] args)

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

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

Modifier and Type	Method	Description
<T> void	CommandUsageGenerator.usage(CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output)	Generates the help output to the provided output stream
<T> void	CommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig)	Generate the help and output it on standard out
<T> void	CommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output)	Generate the help and output it to the stream

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

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

Modifier and Type	Method	Description
<T> void	CliUsageHelper.outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected <T> void	CliCommandUsageGenerator.outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing options and their usages
<T> void	CliCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)

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

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

Modifier and Type	Method	Description
<T> void	AbstractCommandUsageGenerator.usage(CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output)
<T> void	AbstractCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig)
abstract <T> void	AbstractPrintedCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)	Generate the help and output it using the provided UsagePrinter
<T> void	AbstractPrintedCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream out)

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

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

Modifier and Type	Method	Description
protected <T> void	HtmlCommandUsageGenerator.outputOptions(Writer writer, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing the options
<T> void	HtmlCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output)

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

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

Modifier and Type	Method	Description
<T> void	ManUsageHelper.outputArguments(TroffPrinter printer, ArgumentsMetadata arguments, boolean startList, ParserMetadata<T> parserConfig)
protected <T> void	ManCommandUsageGenerator.outputOptions(TroffPrinter printer, CommandMetadata command, List<OptionMetadata> options, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing the options and their usages
<T> void	ManCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output)

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

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

Modifier and Type	Method	Description
<T> void	MarkdownUsageHelper.outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
protected <T> void	MarkdownCommandUsageGenerator.outputOptionsAndArguments(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)	Outputs a documentation section detailing options and their usages
<T> void	MarkdownCommandUsageGenerator.usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out)

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

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

Modifier and Type	Field	Description
private final ParserMetadata<T>	GlobalMetadata.parserConfig

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

Modifier and Type	Method	Description
ParserMetadata<T>	GlobalMetadata.getParserConfiguration()	Gets the parser configuration for the CLI
private static <C> ParserMetadata<C>	MetadataLoader.loadParser(Parser parserConfig)
static <C> ParserMetadata<C>	MetadataLoader.loadParser(Class<?> cliClass)

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

Modifier and Type	Method	Description
private static void	MetadataLoader.checkForInjectionAnnotation(MetadataLoader.InjectionMetadata injectionMetadata, Field field, List<Field> path, String annotationClass, ParserMetadata<?> parserConfig)
private static void	MetadataLoader.createGroupsFromAnnotations(List<CommandMetadata> allCommands, List<CommandMetadata> newCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
static CommandMetadata	MetadataLoader.loadCommand(Class<?> commandType, ParserMetadata<?> parserConfig)	Loads command meta-data
static CommandMetadata	MetadataLoader.loadCommand(Class<?> commandType, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)	Loads command meta-data
static <T> List<CommandMetadata>	MetadataLoader.loadCommands(Iterable<Class<? extends T>> defaultCommands, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)	Loads command meta-data
static void	MetadataLoader.loadCommandsIntoGroupsByAnnotation(List<CommandMetadata> allCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
static <C> GlobalMetadata<C>	MetadataLoader.loadGlobal(Class<?> cliClass, ParserMetadata<C> parserConfigOverride)	Loads the metadata for a CLI
static <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
static void	MetadataLoader.loadInjectionMetadata(Class<?> type, MetadataLoader.InjectionMetadata injectionMetadata, List<Field> fields, ParserMetadata<?> parserConfig)	Loads injection meta-data
static MetadataLoader.InjectionMetadata	MetadataLoader.loadInjectionMetadata(Class<?> type, ParserMetadata<?> parserConfig)	Loads injection meta-data
static SuggesterMetadata	MetadataLoader.loadSuggester(Class<? extends Suggester> suggesterClass, ParserMetadata<?> parserConfig)	Loads suggester meta-data

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

Modifier	Constructor	Description
	GlobalMetadata(String name, String description, Iterable<OptionMetadata> options, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> commandGroups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<T> parserConfig)

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

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

Modifier and Type	Field	Description
private final ParserMetadata<T>	ParseState.parserConfig

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

Modifier and Type	Method	Description
ParserMetadata<T>	ParseState.getParserConfiguration()

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

Modifier and Type	Method	Description
protected ParseState<T>	AbstractCommandParser.tryParse(ParserMetadata<T> parserConfig, CommandMetadata command, Iterable<String> args)	Tries to parse the arguments
ParseState<T>	ParseState.withConfiguration(ParserMetadata<T> parserConfig)

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

Modifier	Constructor	Description
(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 ParserMetadata in com.github.rvesse.airline.parser.command

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

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