Uses of Class
com.github.rvesse.airline.model.ParserMetadata
-
-
Uses of ParserMetadata in com.github.rvesse.airline
Fields in com.github.rvesse.airline declared as ParserMetadata Modifier and Type Field Description private 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 configurationMethods in com.github.rvesse.airline with parameters of type ParserMetadata Modifier and Type Method Description static <C> SingleCommand<C>
SingleCommand. singleCommand(java.lang.Class<C> command, ParserMetadata<C> parserConfig)
Creates a new single commandConstructors in com.github.rvesse.airline with parameters of type ParserMetadata Constructor Description Cli(java.lang.Class<?> cliClass, ParserMetadata<C> parserConfig)
Creates a new CLI from a class annotated with theCli
annotationSingleCommand(java.lang.Class<C> command, java.lang.Iterable<GlobalRestriction> restrictions, ParserMetadata<C> parserConfig)
-
Uses of ParserMetadata in com.github.rvesse.airline.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>
voidExampleExecutor. executeSingleCommand(java.lang.Class<T> cls, ParserMetadata<T> parserConfig, java.lang.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, 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 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, java.util.List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
Outputs a documentation section detailing options and their usages<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 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, 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 providedUsagePrinter
<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)
-
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(java.io.Writer writer, java.util.List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
Outputs a documentation section detailing the options<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 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, java.util.List<OptionMetadata> options, ParserMetadata<T> parserConfig)
Outputs a documentation section detailing the options and their usages<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 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, java.util.List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig)
Outputs a documentation section detailing options and their usages<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 ParserMetadata in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model declared as ParserMetadata Modifier and Type Field Description private 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 CLIprivate static <C> ParserMetadata<C>
MetadataLoader. loadParser(Parser parserConfig)
static <C> ParserMetadata<C>
MetadataLoader. loadParser(java.lang.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, java.lang.reflect.Field field, java.util.List<java.lang.reflect.Field> path, java.lang.String annotationClass, ParserMetadata<?> parserConfig)
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 CommandMetadata
MetadataLoader. loadCommand(java.lang.Class<?> commandType, ParserMetadata<?> parserConfig)
Loads command meta-datastatic CommandMetadata
MetadataLoader. loadCommand(java.lang.Class<?> commandType, java.util.Map<java.lang.String,HelpSection> baseHelpSections, ParserMetadata<?> parserConfig)
Loads command meta-datastatic <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-datastatic 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.Class<?> cliClass, ParserMetadata<C> parserConfigOverride)
Loads the metadata for a CLIstatic <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-datastatic void
MetadataLoader. loadInjectionMetadata(java.lang.Class<?> type, MetadataLoader.InjectionMetadata injectionMetadata, java.util.List<java.lang.reflect.Field> fields, ParserMetadata<?> parserConfig)
Loads injection meta-datastatic MetadataLoader.InjectionMetadata
MetadataLoader. loadInjectionMetadata(java.lang.Class<?> type, ParserMetadata<?> parserConfig)
Loads injection meta-datastatic SuggesterMetadata
MetadataLoader. loadSuggester(java.lang.Class<? extends Suggester> suggesterClass, ParserMetadata<?> parserConfig)
Loads suggester meta-dataConstructors in com.github.rvesse.airline.model with parameters of type ParserMetadata Constructor Description 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 ParserMetadata in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as ParserMetadata Modifier and Type Field Description private 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, java.lang.Iterable<java.lang.String> args)
Tries to parse the argumentsParseState<T>
ParseState. withConfiguration(ParserMetadata<T> parserConfig)
Constructors in com.github.rvesse.airline.parser with parameters of type ParserMetadata 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 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, 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)
-