public abstract class CommandDescriptor<T> extends Object
| Modifier and Type | Field and Description |
|---|---|
private List<ArgumentDescriptor> |
arguments
.
|
private Description |
description
.
|
private boolean |
listArgument
.
|
private Set<String> |
longOptionNames
.
|
private String |
name
.
|
private Map<String,OptionDescriptor> |
optionMap
.
|
private List<OptionDescriptor> |
options
.
|
private List<ParameterDescriptor> |
parameters
.
|
private Set<String> |
shortOptionNames
.
|
private List<ArgumentDescriptor> |
uArguments
.
|
private Set<String> |
uLongOptionNames
.
|
private Map<String,OptionDescriptor> |
uOptionMap
.
|
private List<OptionDescriptor> |
uOptions
.
|
private List<ParameterDescriptor> |
uParameters
.
|
private Set<String> |
uShortOptionNames
.
|
| Modifier | Constructor and Description |
|---|---|
protected |
CommandDescriptor(String name,
Description description) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addParameter(ParameterDescriptor parameter)
Add a parameter to the command.
|
CompletionMatcher<T> |
completer() |
ArgumentDescriptor |
getArgument(int index)
Returns a a specified argument by its index.
|
List<ArgumentDescriptor> |
getArguments()
Returns a list of the command arguments.
|
int |
getDepth() |
Description |
getDescription()
Returns the command description.
|
abstract CommandInvoker<T,?> |
getInvoker(InvocationMatch<T> match) |
Set<String> |
getLongOptionNames()
Returns the command long option names.
|
String |
getName()
Returns the command name.
|
OptionDescriptor |
getOption(String name)
Returns a command option by its name.
|
Set<String> |
getOptionNames()
Returns the command option names.
|
Collection<OptionDescriptor> |
getOptions()
Returns the command options.
|
abstract CommandDescriptor<T> |
getOwner() |
List<ParameterDescriptor> |
getParameters()
Returns the command parameters, the returned collection contains the command options and
the command arguments.
|
Set<String> |
getShortOptionNames()
Returns the command short option names.
|
CommandDescriptor<T> |
getSubordinate(String name)
Returns a specified subordinate.
|
abstract Map<String,? extends CommandDescriptor<T>> |
getSubordinates() |
String |
getUsage()
Returns the command usage, shortcut for invoking
getDescription().getUsage() on this
object. |
InvocationMatcher<T> |
matcher() |
void |
print(Format format,
Appendable to) |
void |
printMan(Appendable to) |
void |
printUsage(Appendable to) |
OptionDescriptor |
resolveOption(String name)
Find an command option by its name, this will look through the command hierarchy.
|
private final Description description
private final Map<String,OptionDescriptor> optionMap
private final Set<String> shortOptionNames
private final Set<String> longOptionNames
private boolean listArgument
private final List<OptionDescriptor> options
private final List<ArgumentDescriptor> arguments
private final List<ParameterDescriptor> parameters
private final Map<String,OptionDescriptor> uOptionMap
private final Set<String> uShortOptionNames
private final Set<String> uLongOptionNames
private final List<OptionDescriptor> uOptions
private final List<ArgumentDescriptor> uArguments
private final List<ParameterDescriptor> uParameters
protected CommandDescriptor(String name, Description description) throws IntrospectionException
IntrospectionExceptionprotected void addParameter(ParameterDescriptor parameter) throws IntrospectionException, NullPointerException, IllegalArgumentException
parameter - the parameter to addIntrospectionException - any introspection exception that would prevent the parameter to be addedNullPointerException - if the parameter is nullIllegalArgumentException - if the parameter is already associated with another commandpublic abstract CommandDescriptor<T> getOwner()
public final int getDepth()
public final void printUsage(Appendable to) throws IOException
IOExceptionpublic final void printMan(Appendable to) throws IOException
IOExceptionpublic final void print(Format format, Appendable to) throws IOException
IOExceptionpublic abstract Map<String,? extends CommandDescriptor<T>> getSubordinates()
public final CommandDescriptor<T> getSubordinate(String name)
name - the subordinate namepublic final List<ParameterDescriptor> getParameters()
public final Set<String> getOptionNames()
public final Set<String> getShortOptionNames()
public final Set<String> getLongOptionNames()
public final Collection<OptionDescriptor> getOptions()
public final OptionDescriptor getOption(String name)
name - the option namepublic final OptionDescriptor resolveOption(String name)
name - the option namepublic final List<ArgumentDescriptor> getArguments()
public final ArgumentDescriptor getArgument(int index) throws IllegalArgumentException
index - the argument indexIllegalArgumentException - if the index is not within the boundspublic final Description getDescription()
public final String getUsage()
getDescription().getUsage() on this
object.public abstract CommandInvoker<T,?> getInvoker(InvocationMatch<T> match)
public final InvocationMatcher<T> matcher()
public final CompletionMatcher<T> completer()
Copyright © 2015 eXo Platform SAS. All Rights Reserved.