Modifier and Type | Method and Description |
---|---|
CommandGroupMetadata |
GroupBuilder.build() |
Modifier and Type | Field and Description |
---|---|
static Comparator<CommandGroupMetadata> |
UsageHelper.DEFAULT_COMMAND_GROUP_COMPARATOR |
Modifier and Type | Method and 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,
OutputStream output)
Generate the help and output it to the stream
|
Modifier and Type | Method and Description |
---|---|
static String[] |
UsageHelper.toGroupNames(List<CommandGroupMetadata> groupPath) |
Modifier and Type | Method and 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) |
Modifier and Type | Method and Description |
---|---|
protected void |
CliGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out,
GlobalMetadata<T> global,
List<CommandGroupMetadata> groups) |
Constructor and Description |
---|
CliGlobalUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
CliGlobalUsageSummaryGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected List<CommandGroupMetadata> |
AbstractGlobalUsageGenerator.sortCommandGroups(List<CommandGroupMetadata> groups)
Sorts the command groups assumign a non-null comparator was provided at
instantiation time
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractCommandGroupUsageGenerator.usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups) |
void |
AbstractPrintedCommandGroupUsageGenerator.usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
OutputStream out) |
protected abstract void |
AbstractPrintedCommandGroupUsageGenerator.usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
UsagePrinter out)
Generate the help and output is using the provided
UsagePrinter |
Modifier and Type | Method and Description |
---|---|
protected List<CommandGroupMetadata> |
AbstractGlobalUsageGenerator.sortCommandGroups(List<CommandGroupMetadata> groups)
Sorts the command groups assumign a non-null comparator was provided at
instantiation time
|
Constructor and Description |
---|
AbstractGlobalUsageGenerator(Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
AbstractPrintedGlobalUsageGenerator(int columns,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
Comparator<? super CommandGroupMetadata> commandGroupComparator,
boolean includeHidden) |
Modifier and Type | Field and Description |
---|---|
CommandGroupMetadata |
GroupSuggester.group |
Modifier and Type | Method and Description |
---|---|
CommandGroupMetadata |
CommandGroupMetadata.getParent()
Gets the parent group which may be null
|
static CommandGroupMetadata |
MetadataLoader.loadCommandGroup(String name,
String description,
boolean hidden,
Iterable<CommandGroupMetadata> subGroups,
CommandMetadata defaultCommand,
Iterable<CommandMetadata> commands)
Loads command group meta-data
|
Modifier and Type | Method and Description |
---|---|
List<CommandGroupMetadata> |
GlobalMetadata.getCommandGroups() |
List<CommandGroupMetadata> |
CommandGroupMetadata.getSubGroups()
Gets the sub-groups of this group
|
Modifier and Type | Method and Description |
---|---|
void |
CommandGroupMetadata.addSubGroup(CommandGroupMetadata subGroup)
Adds a sub-group to the group
|
void |
CommandGroupMetadata.setParent(CommandGroupMetadata parent)
Sets the parent for a group
|
Modifier and Type | Method and Description |
---|---|
protected 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
|
static void |
MetadataLoader.loadCommandsIntoGroupsByAnnotation(List<CommandMetadata> allCommands,
List<CommandGroupMetadata> commandGroups,
List<CommandMetadata> defaultCommandGroup) |
static <C> GlobalMetadata<C> |
MetadataLoader.loadGlobal(String name,
String description,
CommandMetadata defaultCommand,
Iterable<CommandMetadata> defaultGroupCommands,
Iterable<CommandGroupMetadata> groups,
Iterable<GlobalRestriction> restrictions,
ParserMetadata<C> parserConfig)
Loads global meta-data
|
Constructor and Description |
---|
CommandGroupMetadata(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,
ParserMetadata<T> parserConfig) |
Modifier and Type | Method and Description |
---|---|
CommandGroupMetadata |
ParseState.getGroup() |
Modifier and Type | Method and Description |
---|---|
ParseState<T> |
ParseState.withGroup(CommandGroupMetadata group) |
Modifier and Type | Method and Description |
---|---|
boolean |
GroupFinder.evaluate(CommandGroupMetadata group) |
protected boolean |
AbbreviatedGroupFinder.isExactNameMatch(String value,
CommandGroupMetadata item) |
protected boolean |
AbbreviatedGroupFinder.isPartialNameMatch(String value,
CommandGroupMetadata item) |
Constructor and Description |
---|
AbbreviatedGroupFinder(String cmd,
Collection<CommandGroupMetadata> groups) |
Copyright © 2012–2017. All rights reserved.