Uses of Class
com.github.rvesse.airline.model.CommandGroupMetadata
Packages that use CommandGroupMetadata
Package
Description
-
Uses of CommandGroupMetadata in com.github.rvesse.airline
Fields in com.github.rvesse.airline declared as CommandGroupMetadataMethods in com.github.rvesse.airline with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionprivate static String[]
HelpOption.toGroupNames
(CommandGroupMetadata group) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.builder
Methods in com.github.rvesse.airline.builder that return CommandGroupMetadata -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help
Fields in com.github.rvesse.airline.help with type parameters of type CommandGroupMetadataModifier and TypeFieldDescriptionstatic final Comparator
<CommandGroupMetadata> UsageHelper.DEFAULT_COMMAND_GROUP_COMPARATOR
Methods in com.github.rvesse.airline.help with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionvoid
CommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups) Generate the help and output it on standard outvoid
CommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream output) Generate the help and output it to the streamMethod parameters in com.github.rvesse.airline.help with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionstatic String[]
UsageHelper.toGroupNames
(List<CommandGroupMetadata> groupPath) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.cli
Methods in com.github.rvesse.airline.help.cli with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected void
CliGlobalUsageGenerator.outputCommandDescription
(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) Outputs the description for a commandprotected void
CliCommandGroupUsageGenerator.outputDescription
(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) Outputs a description of the groupprotected void
CliCommandGroupUsageGenerator.outputOptions
(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) Outputs a documentation section detailing the available options and their usagesprotected void
CliCommandGroupUsageGenerator.outputSynopsis
(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) Outputs a documentation section detailing a usage synopsisprotected void
CliCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out) Method parameters in com.github.rvesse.airline.help.cli with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected void
CliGlobalUsageGenerator.outputGroupCommandsList
(UsagePrinter out, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.cli.bash
Methods in com.github.rvesse.airline.help.cli.bash with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionprivate void
BashCompletionGenerator.generateCommandCompletionFunction
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command) private void
BashCompletionGenerator.generateGroupCompletionFunction
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group) 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) private void
BashCompletionGenerator.writeGroupCase
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent) private void
BashCompletionGenerator.writeGroupFunctionCall
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent) private void
BashCompletionGenerator.writeGroupFunctionName
(Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, boolean declare) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.common
Fields in com.github.rvesse.airline.help.common with type parameters of type CommandGroupMetadataModifier and TypeFieldDescriptionprivate final Comparator
<? super CommandGroupMetadata> AbstractGlobalUsageGenerator.commandGroupComparator
Methods in com.github.rvesse.airline.help.common that return types with arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected List
<CommandGroupMetadata> AbstractGlobalUsageGenerator.sortCommandGroups
(List<CommandGroupMetadata> groups) Sorts the command groups assumign a non-null comparator was provided at instantiation timeMethods in com.github.rvesse.airline.help.common with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionvoid
AbstractCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups) protected abstract void
AbstractPrintedCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out) Generate the help and output is using the providedUsagePrinter
void
AbstractPrintedCommandGroupUsageGenerator.usage
(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream out) Method parameters in com.github.rvesse.airline.help.common with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected List
<CommandGroupMetadata> AbstractGlobalUsageGenerator.sortCommandGroups
(List<CommandGroupMetadata> groups) Sorts the command groups assumign a non-null comparator was provided at instantiation time -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.man
Method parameters in com.github.rvesse.airline.help.man with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected void
ManGlobalUsageGenerator.outputGroupCommandsList
(TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) protected void
ManGlobalUsageGenerator.outputGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected void
ManMultiPageGlobalUsageGenerator.outputGroupCommandUsages
(OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.markdown
Methods in com.github.rvesse.airline.help.markdown with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected void
MarkdownGlobalUsageGenerator.outputCommandDescription
(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) Outputs the description for a commandMethod parameters in com.github.rvesse.airline.help.markdown with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected void
MarkdownGlobalUsageGenerator.outputGroupCommandsList
(UsagePrinter out, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) protected void
MarkdownGlobalUsageGenerator.outputGroupCommandUsages
(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) Outputs the command usages for the commands in the given groupprotected void
MarkdownMultiPageGlobalUsageGenerator.outputGroupCommandUsages
(UsagePrinter printer, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) -
Uses of CommandGroupMetadata in com.github.rvesse.airline.help.suggester
Fields in com.github.rvesse.airline.help.suggester declared as CommandGroupMetadata -
Uses of CommandGroupMetadata in com.github.rvesse.airline.model
Fields in com.github.rvesse.airline.model declared as CommandGroupMetadataFields in com.github.rvesse.airline.model with type parameters of type CommandGroupMetadataModifier and TypeFieldDescriptionprivate final List
<CommandGroupMetadata> GlobalMetadata.commandGroups
private final List
<CommandGroupMetadata> CommandGroupMetadata.subGroups
Methods in com.github.rvesse.airline.model that return CommandGroupMetadataModifier and TypeMethodDescriptionCommandGroupMetadata.getParent()
Gets the parent group which may be nullstatic CommandGroupMetadata
MetadataLoader.loadCommandGroup
(String name, String description, boolean hidden, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands) Loads command group meta-dataMethods in com.github.rvesse.airline.model that return types with arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionGlobalMetadata.getCommandGroups()
Gets the command groups for the CLICommandGroupMetadata.getSubGroups()
Gets the sub-groups of this groupMethods in com.github.rvesse.airline.model with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionvoid
CommandGroupMetadata.addSubGroup
(CommandGroupMetadata subGroup) Adds a sub-group to the groupprivate static void
GlobalMetadata.checkForSuppressedCommands
(CommandGroupMetadata group, String groupPath) void
CommandGroupMetadata.setParent
(CommandGroupMetadata parent) Sets the parent for a groupMethod parameters in com.github.rvesse.airline.model with type arguments of type CommandGroupMetadataModifier and TypeMethodDescriptionprotected static void
MetadataLoader.buildGroupsHierarchy
(List<CommandGroupMetadata> commandGroups, Map<String, CommandGroupMetadata> subGroups) protected static void
MetadataLoader.buildGroupsHierarchy
(List<CommandGroupMetadata> commandGroups, Map<String, CommandGroupMetadata> subGroups) static CommandGroupMetadata
MetadataLoader.loadCommandGroup
(String name, String description, boolean hidden, Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, Iterable<CommandMetadata> commands) Loads command group meta-data -
Uses of CommandGroupMetadata in com.github.rvesse.airline.parser
Fields in com.github.rvesse.airline.parser declared as CommandGroupMetadataMethods in com.github.rvesse.airline.parser that return CommandGroupMetadataMethods in com.github.rvesse.airline.parser with parameters of type CommandGroupMetadataConstructors in com.github.rvesse.airline.parser with parameters of type CommandGroupMetadataModifierConstructorDescription(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 CommandGroupMetadata in com.github.rvesse.airline.utils.predicates.parser
Methods in com.github.rvesse.airline.utils.predicates.parser with parameters of type CommandGroupMetadataModifier and TypeMethodDescriptionboolean
GroupFinder.evaluate
(CommandGroupMetadata group) protected boolean
AbbreviatedGroupFinder.isExactNameMatch
(String value, CommandGroupMetadata item) protected boolean
AbbreviatedGroupFinder.isPartialNameMatch
(String value, CommandGroupMetadata item) Constructor parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type CommandGroupMetadataModifierConstructorDescriptionAbbreviatedGroupFinder
(String cmd, Collection<CommandGroupMetadata> groups)