Uses of Class
com.github.rvesse.airline.model.ParserMetadata
Packages that use ParserMetadata
Package
Description
-
Uses of ParserMetadata in com.github.rvesse.airline
Fields in com.github.rvesse.airline declared as ParserMetadataMethods in com.github.rvesse.airline that return ParserMetadataModifier and TypeMethodDescriptionSingleCommand.getParserConfiguration()
Gets the parser configurationMethods in com.github.rvesse.airline with parameters of type ParserMetadataModifier and TypeMethodDescriptionstatic <C> SingleCommand
<C> SingleCommand.singleCommand
(Class<C> command, ParserMetadata<C> parserConfig) Creates a new single commandConstructors in com.github.rvesse.airline with parameters of type ParserMetadataModifierConstructorDescriptionCli
(Class<?> cliClass, ParserMetadata<C> parserConfig) Creates a new CLI from a class annotated with theCli
annotationprivate
SingleCommand
(Class<C> command, Iterable<GlobalRestriction> restrictions, ParserMetadata<C> parserConfig) -
Uses of ParserMetadata in com.github.rvesse.airline.builder
Methods in com.github.rvesse.airline.builder that return ParserMetadataModifier and TypeMethodDescriptionParserBuilder.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 ParserMetadataModifier and TypeMethodDescriptionstatic <T extends ExampleRunnable>
voidExampleExecutor.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 ParserMetadataModifier and TypeMethodDescription<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 ParserMetadataModifier and TypeMethodDescription<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 ParserMetadataModifier and TypeMethodDescription<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 providedUsagePrinter
<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 ParserMetadataModifier and TypeMethodDescriptionprotected <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 ParserMetadataModifier and TypeMethodDescription<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 ParserMetadataModifier and TypeMethodDescription<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 ParserMetadataMethods in com.github.rvesse.airline.model that return ParserMetadataModifier and TypeMethodDescriptionGlobalMetadata.getParserConfiguration()
Gets the parser configuration for the CLIprivate 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 ParserMetadataModifier and TypeMethodDescriptionprivate 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-datastatic CommandMetadata
MetadataLoader.loadCommand
(Class<?> commandType, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) Loads command meta-datastatic <T> List
<CommandMetadata> MetadataLoader.loadCommands
(Iterable<Class<? extends T>> defaultCommands, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) Loads command meta-datastatic 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 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-datastatic void
MetadataLoader.loadInjectionMetadata
(Class<?> type, MetadataLoader.InjectionMetadata injectionMetadata, List<Field> fields, ParserMetadata<?> parserConfig) Loads injection meta-dataMetadataLoader.loadInjectionMetadata
(Class<?> type, ParserMetadata<?> parserConfig) Loads injection meta-datastatic SuggesterMetadata
MetadataLoader.loadSuggester
(Class<? extends Suggester> suggesterClass, ParserMetadata<?> parserConfig) Loads suggester meta-dataConstructors in com.github.rvesse.airline.model with parameters of type ParserMetadataModifierConstructorDescriptionGlobalMetadata
(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 ParserMetadataMethods in com.github.rvesse.airline.parser that return ParserMetadataMethods in com.github.rvesse.airline.parser with parameters of type ParserMetadataModifier and TypeMethodDescriptionprotected ParseState
<T> AbstractCommandParser.tryParse
(ParserMetadata<T> parserConfig, CommandMetadata command, Iterable<String> args) Tries to parse the argumentsParseState.withConfiguration
(ParserMetadata<T> parserConfig) Constructors in com.github.rvesse.airline.parser with parameters of type ParserMetadataModifierConstructorDescription(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 ParserMetadataModifier and TypeMethodDescriptionSingleCommandParser.parse
(ParserMetadata<T> parserConfig, CommandMetadata commandMetadata, Iterable<GlobalRestriction> restrictions, Iterable<String> args) SingleCommandParser.parseWithResult
(ParserMetadata<T> parserConfig, CommandMetadata commandMetadata, Iterable<GlobalRestriction> restrictions, Iterable<String> args)