Modifier and Type | Method and Description |
---|---|
GlobalMetadata<C> |
Cli.getMetadata()
Gets the global meta-data
|
Constructor and Description |
---|
Cli(GlobalMetadata<C> metadata)
Creates a new CLI
|
Modifier and Type | Field and Description |
---|---|
GlobalMetadata<T> |
Help.global |
Modifier and Type | Method and Description |
---|---|
static <T> void |
Help.help(GlobalMetadata<T> global,
List<String> commandNames)
Displays plain text format program help to standard out
|
static <T> void |
Help.help(GlobalMetadata<T> global,
List<String> commandNames,
boolean includeHidden)
Displays plain text format program help to standard out
|
static <T> void |
Help.help(GlobalMetadata<T> global,
List<String> commandNames,
boolean includeHidden,
OutputStream out)
Displays plain text format program help to the given output stream
|
static <T> void |
Help.help(GlobalMetadata<T> global,
List<String> commandNames,
OutputStream out)
Displays plain text format program help to the given output stream
|
void |
GlobalUsageGenerator.usage(GlobalMetadata<T> global)
Generate the help and output it on standard out
|
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
|
void |
GlobalUsageGenerator.usage(GlobalMetadata<T> global,
OutputStream output)
Generate the help and output it to the stream
|
Modifier and Type | Method and Description |
---|---|
protected void |
CliGlobalUsageSummaryGenerator.outputCommandList(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section listing the common commands and groups
|
protected void |
CliGlobalUsageGenerator.outputCommandList(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section listing the commands
|
protected void |
CliGlobalUsageGenerator.outputDescription(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a description of the CLI
|
protected void |
CliCommandGroupUsageGenerator.outputDescription(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a description of the group
|
protected void |
CliGlobalUsageSummaryGenerator.outputFooter(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section detailing how to get more help
|
protected void |
CliGlobalUsageGenerator.outputGroupCommandsList(UsagePrinter out,
GlobalMetadata<T> global,
List<CommandGroupMetadata> groups) |
protected void |
CliCommandGroupUsageGenerator.outputOptions(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a documentation section detailing the available options and their
usages
|
protected void |
CliGlobalUsageSummaryGenerator.outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a brief synopsis of usage
|
protected void |
CliGlobalUsageGenerator.outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a synopsis of CLI usage
|
protected void |
CliCommandGroupUsageGenerator.outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a documentation section detailing a usage synopsis
|
protected void |
CliGlobalUsageGenerator.outputUserAliases(UsagePrinter out,
GlobalMetadata<T> global,
UserAliasesSource<T> userAliases) |
protected void |
CliCommandGroupUsageGenerator.usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
UsagePrinter out) |
void |
CliGlobalUsageSummaryGenerator.usage(GlobalMetadata<T> global,
UsagePrinter out) |
protected void |
CliGlobalUsageGenerator.usage(GlobalMetadata<T> global,
UsagePrinter out) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractGlobalUsageGenerator.usage(GlobalMetadata<T> global) |
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 |
void |
AbstractPrintedGlobalUsageGenerator.usage(GlobalMetadata<T> global,
OutputStream out) |
protected abstract void |
AbstractPrintedGlobalUsageGenerator.usage(GlobalMetadata<T> global,
UsagePrinter out)
Generate the help and output is using the provided
UsagePrinter |
Modifier and Type | Field and Description |
---|---|
GlobalMetadata<T> |
SuggestCommand.metadata |
GlobalMetadata<T> |
GlobalSuggester.metadata |
Modifier and Type | Method and Description |
---|---|
static <C> GlobalMetadata<C> |
MetadataLoader.loadGlobal(Class<?> cliClass) |
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
|
Modifier and Type | Method and Description |
---|---|
GlobalMetadata<T> |
ParseState.getGlobal() |
Modifier and Type | Method and Description |
---|---|
protected ParseState<T> |
AbstractCommandParser.tryParse(GlobalMetadata<T> metadata,
Iterable<String> args)
Tries to parse the arguments
|
protected ParseState<T> |
AbstractCommandParser.tryParse(GlobalMetadata<T> metadata,
String... args)
Tries to parse the arguments
|
ParseState<T> |
ParseState.withGlobal(GlobalMetadata<T> global) |
Modifier and Type | Method and Description |
---|---|
T |
CliParser.parse(GlobalMetadata<T> metadata,
Iterable<String> args) |
ParseResult<T> |
CliParser.parseWithResult(GlobalMetadata<T> metadata,
Iterable<String> args) |
Modifier and Type | Method and Description |
---|---|
ParseState<T> |
SuggestionParser.parse(GlobalMetadata<T> metadata,
Iterable<String> args) |
Copyright © 2012–2017. All rights reserved.