public abstract class Command<T> extends Object
| Constructor and Description |
|---|
Command() |
| Modifier and Type | Method and Description |
|---|---|
CompletionMatch |
complete(RuntimeContext context,
String line)
Provide completions for the specified arguments.
|
String |
describe(InvocationMatch<T> match,
Format format) |
String |
describe(String line,
Format format)
Returns a description of the command or null if none can be found.
|
protected abstract Completer |
getCompleter(RuntimeContext context)
Returns a completer for this command.
|
abstract CommandDescriptor<T> |
getDescriptor()
Returns the command descriptor.
|
protected abstract CommandMatch<?,?> |
resolve(InvocationMatch<T> match)
Resolve the real match for a specified invocation match.
|
CommandMatch<?,?> |
resolveCommand(Map<String,?> options,
String subordinate,
Map<String,?> subordinateOptions,
List<?> arguments)
Provides an invoker for the command line specified in a detyped manner.
|
CommandMatch<?,?> |
resolveCommand(String line) |
CommandInvoker<?,?> |
resolveInvoker(String line)
Provides an invoker for the command line specified as a command line to parse.
|
public Command()
public abstract CommandDescriptor<T> getDescriptor()
protected abstract Completer getCompleter(RuntimeContext context) throws CommandException
context - the related runtime contextCommandException - anything that would prevent completion to happenprotected abstract CommandMatch<?,?> resolve(InvocationMatch<T> match)
match - the matchpublic final String describe(InvocationMatch<T> match, Format format)
public final CompletionMatch complete(RuntimeContext context, String line) throws CommandException
context - the command contextline - the original command line argumentsCommandExceptionpublic final String describe(String line, Format format) throws CommandException
line - the usage lineformat - the description formatCommandExceptionpublic final CommandInvoker<?,?> resolveInvoker(String line) throws CommandException
line - the command line argumentsCommandExceptionpublic final CommandMatch<?,?> resolveCommand(String line) throws CommandException
CommandExceptionpublic final CommandMatch<?,?> resolveCommand(Map<String,?> options, String subordinate, Map<String,?> subordinateOptions, List<?> arguments) throws CommandException
options - the base optionssubordinate - the subordinate command name, might nullsubordinateOptions - the subordinate optionsarguments - argumentsCommandExceptionCopyright © 2015 eXo Platform SAS. All Rights Reserved.