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

Packages that use CommandGroupMetadata

Package	Description
com.github.rvesse.airline
com.github.rvesse.airline.builder
com.github.rvesse.airline.help
com.github.rvesse.airline.help.cli
com.github.rvesse.airline.help.cli.bash
com.github.rvesse.airline.help.common
com.github.rvesse.airline.help.man
com.github.rvesse.airline.help.markdown
com.github.rvesse.airline.help.suggester
com.github.rvesse.airline.model
com.github.rvesse.airline.parser
com.github.rvesse.airline.utils.predicates.parser

Uses of CommandGroupMetadata in com.github.rvesse.airline

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

Modifier and Type	Field	Description
private CommandGroupMetadata	HelpOption.groupMetadata

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

Modifier and Type	Method	Description
private static java.lang.String[]	HelpOption.toGroupNames(CommandGroupMetadata group)

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

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

Modifier and Type	Method	Description
CommandGroupMetadata	GroupBuilder.build()

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

Fields in com.github.rvesse.airline.help with type parameters of type CommandGroupMetadata

Modifier and Type	Field	Description
static java.util.Comparator<CommandGroupMetadata>	UsageHelper.DEFAULT_COMMAND_GROUP_COMPARATOR

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

Modifier and Type	Method	Description
void	CommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Generate the help and output it on standard out
void	CommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, java.io.OutputStream output)	Generate the help and output it to the stream

Method parameters in com.github.rvesse.airline.help with type arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
static java.lang.String[]	UsageHelper.toGroupNames(java.util.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 CommandGroupMetadata

Modifier and Type	Method	Description
protected void	CliGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command
protected void	CliCommandGroupUsageGenerator.outputDescription(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a description of the group
protected void	CliCommandGroupUsageGenerator.outputOptions(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing the available options and their usages
protected void	CliCommandGroupUsageGenerator.outputSynopsis(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups)	Outputs a documentation section detailing a usage synopsis
protected void	CliCommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out)

Method parameters in com.github.rvesse.airline.help.cli with type arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
protected void	CliGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.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 CommandGroupMetadata

Modifier and Type	Method	Description
private void	BashCompletionGenerator.generateCommandCompletionFunction(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command)
private void	BashCompletionGenerator.generateGroupCompletionFunction(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group)
private void	BashCompletionGenerator.writeCommandCase(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent, boolean isNestedFunction)
private void	BashCompletionGenerator.writeCommandFunctionCall(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, int indent)
private void	BashCompletionGenerator.writeCommandFunctionName(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, CommandMetadata command, boolean declare)
private void	BashCompletionGenerator.writeGroupCase(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent)
private void	BashCompletionGenerator.writeGroupFunctionCall(java.io.Writer writer, GlobalMetadata<T> global, CommandGroupMetadata group, int indent)
private void	BashCompletionGenerator.writeGroupFunctionName(java.io.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 CommandGroupMetadata

Modifier and Type	Field	Description
private java.util.Comparator<? super CommandGroupMetadata>	AbstractGlobalUsageGenerator.commandGroupComparator

Methods in com.github.rvesse.airline.help.common that return types with arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
protected java.util.List<CommandGroupMetadata>	AbstractGlobalUsageGenerator.sortCommandGroups(java.util.List<CommandGroupMetadata> groups)	Sorts the command groups assumign a non-null comparator was provided at instantiation time

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

Modifier and Type	Method	Description
void	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 provided UsagePrinter
void	AbstractPrintedCommandGroupUsageGenerator.usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, java.io.OutputStream out)

Method parameters in com.github.rvesse.airline.help.common with type arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
protected java.util.List<CommandGroupMetadata>	AbstractGlobalUsageGenerator.sortCommandGroups(java.util.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 CommandGroupMetadata

Modifier and Type	Method	Description
protected void	ManGlobalUsageGenerator.outputGroupCommandsList(TroffPrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
protected void	ManGlobalUsageGenerator.outputGroupCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)	Outputs the command usages for the commands in the given group
protected void	ManMultiPageGlobalUsageGenerator.outputGroupCommandUsages(java.io.OutputStream output, TroffPrinter printer, GlobalMetadata<T> global, java.util.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 CommandGroupMetadata

Modifier and Type	Method	Description
protected void	MarkdownGlobalUsageGenerator.outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command)	Outputs the description for a command

Method parameters in com.github.rvesse.airline.help.markdown with type arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
protected void	MarkdownGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)
protected void	MarkdownGlobalUsageGenerator.outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)	Outputs the command usages for the commands in the given group
protected void	MarkdownMultiPageGlobalUsageGenerator.outputGroupCommandUsages(UsagePrinter printer, GlobalMetadata<T> global, java.util.List<CommandGroupMetadata> groups)

Uses of CommandGroupMetadata in com.github.rvesse.airline.help.suggester

Fields in com.github.rvesse.airline.help.suggester declared as CommandGroupMetadata

Modifier and Type	Field	Description
CommandGroupMetadata	GroupSuggester.group

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

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

Modifier and Type	Field	Description
private CommandGroupMetadata	CommandGroupMetadata.parentGroup

Fields in com.github.rvesse.airline.model with type parameters of type CommandGroupMetadata

Modifier and Type	Field	Description
private java.util.List<CommandGroupMetadata>	GlobalMetadata.commandGroups
private java.util.List<CommandGroupMetadata>	CommandGroupMetadata.subGroups

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

Modifier and Type	Method	Description
CommandGroupMetadata	CommandGroupMetadata.getParent()	Gets the parent group which may be null
static CommandGroupMetadata	MetadataLoader.loadCommandGroup(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, java.lang.Iterable<CommandMetadata> commands)	Loads command group meta-data

Methods in com.github.rvesse.airline.model that return types with arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
java.util.List<CommandGroupMetadata>	GlobalMetadata.getCommandGroups()	Gets the command groups for the CLI
java.util.List<CommandGroupMetadata>	CommandGroupMetadata.getSubGroups()	Gets the sub-groups of this group

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

Modifier and Type	Method	Description
void	CommandGroupMetadata.addSubGroup(CommandGroupMetadata subGroup)	Adds a sub-group to the group
private static void	GlobalMetadata.checkForSuppressedCommands(CommandGroupMetadata group, java.lang.String groupPath)
void	CommandGroupMetadata.setParent(CommandGroupMetadata parent)	Sets the parent for a group

Method parameters in com.github.rvesse.airline.model with type arguments of type CommandGroupMetadata

Modifier and Type	Method	Description
protected static void	MetadataLoader.buildGroupsHierarchy(java.util.List<CommandGroupMetadata> commandGroups, java.util.Map<java.lang.String,CommandGroupMetadata> subGroups)
protected static void	MetadataLoader.buildGroupsHierarchy(java.util.List<CommandGroupMetadata> commandGroups, java.util.Map<java.lang.String,CommandGroupMetadata> subGroups)
static CommandGroupMetadata	MetadataLoader.loadCommandGroup(java.lang.String name, java.lang.String description, boolean hidden, java.lang.Iterable<CommandGroupMetadata> subGroups, CommandMetadata defaultCommand, java.lang.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 CommandGroupMetadata

Modifier and Type	Field	Description
private CommandGroupMetadata	ParseState.group

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

Modifier and Type	Method	Description
CommandGroupMetadata	ParseState.getGroup()

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

Modifier and Type	Method	Description
ParseState<T>	ParseState.withGroup(CommandGroupMetadata group)

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

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 CommandGroupMetadata in com.github.rvesse.airline.utils.predicates.parser

Methods in com.github.rvesse.airline.utils.predicates.parser with parameters of type CommandGroupMetadata

Modifier and Type	Method	Description
boolean	GroupFinder.evaluate(CommandGroupMetadata group)
protected boolean	AbbreviatedGroupFinder.isExactNameMatch(java.lang.String value, CommandGroupMetadata item)
protected boolean	AbbreviatedGroupFinder.isPartialNameMatch(java.lang.String value, CommandGroupMetadata item)

Constructor parameters in com.github.rvesse.airline.utils.predicates.parser with type arguments of type CommandGroupMetadata

Constructor	Description
AbbreviatedGroupFinder(java.lang.String cmd, java.util.Collection<CommandGroupMetadata> groups)