Uses of Class
com.github.rvesse.airline.model.CommandMetadata
Packages that use CommandMetadata
Package
Description
-
Uses of CommandMetadata in com.github.rvesse.airline
Fields in com.github.rvesse.airline declared as CommandMetadataModifier and TypeFieldDescriptionprivate CommandMetadata
HelpOption.commandMetadata
private final CommandMetadata
SingleCommand.commandMetadata
Methods in com.github.rvesse.airline that return CommandMetadata -
Uses of CommandMetadata in com.github.rvesse.airline.examples.userguide.help.sections
Fields in com.github.rvesse.airline.examples.userguide.help.sections declared as CommandMetadataModifier and TypeFieldDescriptionprivate 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 CommandMetadataModifier and TypeFieldDescriptionstatic final Comparator
<CommandMetadata> UsageHelper.DEFAULT_COMMAND_COMPARATOR
Default comparator for commandsMethods in com.github.rvesse.airline.help with parameters of type CommandMetadataModifier and TypeMethodDescriptionstatic void
Help.help
(CommandMetadata command) Displays plain text format help for the given command to standard outstatic void
Help.help
(CommandMetadata command, boolean includeHidden) Displays plain text format help for the given command to standard outstatic void
Help.help
(CommandMetadata command, boolean includeHidden, OutputStream out) Displays plain text format help or the given command to the given output streamstatic void
Help.help
(CommandMetadata command, 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, 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 CommandMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type CommandMetadataModifier and TypeMethodDescriptionprotected void
CliGlobalUsageGenerator.outputCommandDescription
(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) Outputs the description for a commandprotected void
CliCommandUsageGenerator.outputDescription
(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section describing the commandprotected <T> void
CliCommandUsageGenerator.outputOptionsAndArguments
(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing options and their usagesprotected List
<OptionMetadata> CliCommandUsageGenerator.outputSynopsis
(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section with a synopsis of command usage<T> void
CliCommandUsageGenerator.usage
(String programName, String[] groupNames, 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 CommandMetadataModifier and TypeMethodDescriptionprivate void
BashCompletionGenerator.generateCommandCompletionFunction
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command) 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) -
Uses of CommandMetadata in com.github.rvesse.airline.help.common
Fields in com.github.rvesse.airline.help.common with type parameters of type CommandMetadataModifier and TypeFieldDescriptionprivate final Comparator
<? super CommandMetadata> AbstractUsageGenerator.commandComparator
Methods in com.github.rvesse.airline.help.common that return types with arguments of type CommandMetadataModifier and TypeMethodDescriptionprotected final Comparator
<? super CommandMetadata> AbstractUsageGenerator.getCommandComparator()
protected List
<CommandMetadata> AbstractUsageGenerator.sortCommands
(List<CommandMetadata> commands) Sorts the commands assuming a non-null comparator was provided at instantiation timeMethods in com.github.rvesse.airline.help.common with parameters of type CommandMetadataModifier and TypeMethodDescriptionprotected void
AbstractCommandUsageGenerator.findHelpSections
(CommandMetadata command, List<HelpSection> preSections, List<HelpSection> postSections) Finds the help sections<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) Method parameters in com.github.rvesse.airline.help.common with type arguments of type CommandMetadataModifier and TypeMethodDescriptionprotected List
<CommandMetadata> AbstractUsageGenerator.sortCommands
(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 CommandMetadataModifier and TypeMethodDescriptionprotected void
HtmlCommandUsageGenerator.outputDescription
(Writer writer, String programName, String[] groupNames, CommandMetadata command) Outputs a documentation section with the name and description of the commandprotected void
HtmlCommandUsageGenerator.outputPageHeader
(Writer writer, String programName, String[] groupNames, CommandMetadata command) Outputs a page headerprotected List
<OptionMetadata> HtmlCommandUsageGenerator.outputSynopsis
(Writer writer, String programName, String[] groupNames, CommandMetadata command) Outputs a documentation section with a synopsis of the command<T> void
HtmlCommandUsageGenerator.usage
(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output) -
Uses of CommandMetadata in com.github.rvesse.airline.help.man
Methods in com.github.rvesse.airline.help.man with parameters of type CommandMetadataModifier 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 <T> void
ManCommandUsageGenerator.outputOptions
(TroffPrinter printer, CommandMetadata command, List<OptionMetadata> options, ParserMetadata<T> parserConfig) Outputs a documentation section detailing the options and their usagesprotected List
<OptionMetadata> ManCommandUsageGenerator.outputSynopsis
(TroffPrinter printer, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a synopsis section for the documentation showing how to use a commandprotected void
ManCommandUsageGenerator.outputTitle
(TroffPrinter printer, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a title section for the document<T> void
ManCommandUsageGenerator.usage
(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output) -
Uses of CommandMetadata in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type CommandMetadataModifier 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.outputCommandDescription
(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) Outputs the description for a commandprotected void
MarkdownCommandUsageGenerator.outputDescription
(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section describing the commandprotected <T> void
MarkdownCommandUsageGenerator.outputOptionsAndArguments
(UsagePrinter out, CommandMetadata command, List<OptionMetadata> options, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) Outputs a documentation section detailing options and their usagesprotected List
<OptionMetadata> MarkdownCommandUsageGenerator.outputSynopsis
(UsagePrinter out, String programName, String[] groupNames, String commandName, CommandMetadata command) Outputs a documentation section with a synopsis of command usage<T> void
MarkdownCommandUsageGenerator.usage
(String programName, String[] groupNames, 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 -
Uses of CommandMetadata in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model declared as CommandMetadataModifier and TypeFieldDescriptionprivate final CommandMetadata
CommandGroupMetadata.defaultCommand
private final CommandMetadata
GlobalMetadata.defaultCommand
Fields in com.github.rvesse.airline.model with type parameters of type CommandMetadataModifier and TypeFieldDescriptionprivate final List
<CommandMetadata> CommandGroupMetadata.commands
private final List
<CommandMetadata> GlobalMetadata.defaultGroupCommands
Methods in com.github.rvesse.airline.model that return CommandMetadataModifier and TypeMethodDescriptionCommandGroupMetadata.getDefaultCommand()
Gets the default command for the groupGlobalMetadata.getDefaultCommand()
Gets the default command for the CLIstatic 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-dataMethods in com.github.rvesse.airline.model that return types with arguments of type CommandMetadataModifier and TypeMethodDescriptionCommandGroupMetadata.getCommands()
Gets the commands for the groupGlobalMetadata.getDefaultGroupCommands()
Gets the default group of commands for the CLI i.e.static <T> List
<CommandMetadata> MetadataLoader.loadCommands
(Iterable<Class<? extends T>> defaultCommands, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) Loads command meta-dataMethods in com.github.rvesse.airline.model with parameters of type CommandMetadataModifier and TypeMethodDescriptionvoid
CommandGroupMetadata.addCommand
(CommandMetadata command) Adds a command to the groupprivate static void
GlobalMetadata.checkForSuppressedCommands
(List<CommandMetadata> commands, CommandMetadata defaultCommand, String groupName) static CommandGroupMetadata
MetadataLoader.loadCommandGroup
(String name, String description, boolean hidden, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands) Loads command group meta-datastatic <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-dataprivate static void
GlobalMetadata.suppressedCommand
(Class<?> cls, CommandMetadata cmd, String groupName) Method parameters in com.github.rvesse.airline.model with type arguments of type CommandMetadataModifier and TypeMethodDescriptionprivate static void
GlobalMetadata.checkForSuppressedCommands
(List<CommandMetadata> commands, CommandMetadata defaultCommand, String groupName) private static void
MetadataLoader.createGroupsFromAnnotations
(List<CommandMetadata> allCommands, List<CommandMetadata> newCommands, List<CommandGroupMetadata> commandGroups, List<CommandMetadata> defaultCommandGroup, Map<String, HelpSection> baseHelpSections, ParserMetadata<?> parserConfig) 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
(String name, String description, CommandMetadata defaultCommand, Iterable<CommandMetadata> defaultGroupCommands, Iterable<CommandGroupMetadata> groups, Iterable<GlobalRestriction> restrictions, Iterable<HelpSection> baseHelpSections, ParserMetadata<C> parserConfig) Loads global meta-dataConstructors in com.github.rvesse.airline.model with parameters of type CommandMetadataModifierConstructorDescriptionCommandGroupMetadata
(String name, String description, boolean hidden, Iterable<OptionMetadata> options, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands) 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 CommandMetadata in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as CommandMetadataMethods in com.github.rvesse.airline.parser that return CommandMetadataMethods in com.github.rvesse.airline.parser with parameters of type CommandMetadataModifier and TypeMethodDescriptionprotected ParseState
<T> AbstractCommandParser.parseCommandOptionsAndArguments
(org.apache.commons.collections4.iterators.PeekingIterator<String> tokens, ParseState<T> state, CommandMetadata command) protected ParseState
<T> AbstractCommandParser.tryParse
(ParserMetadata<T> parserConfig, CommandMetadata command, Iterable<String> args) Tries to parse the argumentsParseState.withCommand
(CommandMetadata command) Constructors in com.github.rvesse.airline.parser with parameters of type CommandMetadataModifierConstructorDescription(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 CommandMetadata in com.github.rvesse.airline.parser.command
Methods in com.github.rvesse.airline.parser.command with parameters of type CommandMetadataModifier 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) -
Uses of CommandMetadata in com.github.rvesse.airline.utils.predicates.parser
Methods in com.github.rvesse.airline.utils.predicates.parser with parameters of type CommandMetadataModifier and TypeMethodDescriptionboolean
CommandFinder.evaluate
(CommandMetadata command) boolean
CommandTypeFinder.evaluate
(CommandMetadata command) protected boolean
AbbreviatedCommandFinder.isExactNameMatch
(String value, CommandMetadata item) protected boolean
AbbreviatedCommandFinder.isPartialNameMatch
(String value, CommandMetadata item) Constructor parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type CommandMetadataModifierConstructorDescriptionAbbreviatedCommandFinder
(String cmd, Collection<CommandMetadata> commands)