|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crsh.cmdline.CommandDescriptor<T,B>
public abstract class CommandDescriptor<T,B extends TypeBinding>
Describes a command.
Field Summary | |
---|---|
private List<ArgumentDescriptor<B>> |
arguments
. |
private Description |
description
. |
private boolean |
listArgument
. |
private Set<String> |
longOptionNames
. |
private String |
name
. |
private Map<String,OptionDescriptor<B>> |
optionMap
. |
private List<OptionDescriptor<B>> |
options
. |
private List<ParameterDescriptor<B>> |
parameters
. |
private Set<String> |
shortOptionNames
. |
private List<ArgumentDescriptor<B>> |
uArguments
. |
private Set<String> |
uLongOptionNames
. |
private Map<String,OptionDescriptor<B>> |
uOptionMap
. |
private List<OptionDescriptor<B>> |
uOptions
. |
private List<ParameterDescriptor<B>> |
uParameters
. |
private Set<String> |
uShortOptionNames
. |
Constructor Summary | |
---|---|
CommandDescriptor(String name,
Description description)
|
Method Summary | |
---|---|
(package private) void |
addParameter(ParameterDescriptor<B> parameter)
Add a parameter to the command. |
abstract OptionDescriptor<?> |
findOption(String name)
Find an command option by its name. |
ArgumentDescriptor<B> |
getArgument(int index)
Returns a a specified argument by its index. |
List<ArgumentDescriptor<B>> |
getArguments()
Returns a list of the command arguments. |
Description |
getDescription()
Returns the command description. |
Set<String> |
getLongOptionNames()
Returns the command long option names. |
String |
getName()
Returns the command name. |
OptionDescriptor<B> |
getOption(String name)
Returns a command option by its name. |
Set<String> |
getOptionNames()
Returns the command option names. |
Collection<OptionDescriptor<B>> |
getOptions()
Returns the command options. |
Collection<ParameterDescriptor<B>> |
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. |
abstract Map<String,? extends CommandDescriptor<T,?>> |
getSubordinates()
Returns the command subordinates as a map. |
abstract Class<T> |
getType()
|
String |
getUsage()
Returns the command usage, shortcut for invoking getDescription().getUsage() on this
object. |
abstract void |
printMan(Appendable writer)
|
abstract void |
printUsage(Appendable writer)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final String name
private final Description description
private final Map<String,OptionDescriptor<B extends TypeBinding>> optionMap
private final Set<String> shortOptionNames
private final Set<String> longOptionNames
private boolean listArgument
private final List<OptionDescriptor<B extends TypeBinding>> options
private final List<ArgumentDescriptor<B extends TypeBinding>> arguments
private final List<ParameterDescriptor<B extends TypeBinding>> parameters
private final Map<String,OptionDescriptor<B extends TypeBinding>> uOptionMap
private final Set<String> uShortOptionNames
private final Set<String> uLongOptionNames
private final List<OptionDescriptor<B extends TypeBinding>> uOptions
private final List<ArgumentDescriptor<B extends TypeBinding>> uArguments
private final List<ParameterDescriptor<B extends TypeBinding>> uParameters
Constructor Detail |
---|
CommandDescriptor(String name, Description description) throws IntrospectionException
IntrospectionException
Method Detail |
---|
void addParameter(ParameterDescriptor<B> parameter) throws IntrospectionException, NullPointerException, IllegalArgumentException
parameter
- the parameter to add
IntrospectionException
- any introspection exception that would prevent the parameter to be added
NullPointerException
- if the parameter is null
IllegalArgumentException
- if the parameter is already associated with another commandpublic abstract Class<T> getType()
public abstract void printUsage(Appendable writer) throws IOException
IOException
public abstract void printMan(Appendable writer) throws IOException
IOException
public abstract Map<String,? extends CommandDescriptor<T,?>> getSubordinates()
public final Collection<ParameterDescriptor<B>> getParameters()
public final Set<String> getOptionNames()
public final Set<String> getShortOptionNames()
public final Set<String> getLongOptionNames()
public final Collection<OptionDescriptor<B>> getOptions()
public final OptionDescriptor<B> getOption(String name)
name
- the option name
public abstract OptionDescriptor<?> findOption(String name)
name
- the option name
public final List<ArgumentDescriptor<B>> getArguments()
public final ArgumentDescriptor<B> getArgument(int index) throws IllegalArgumentException
index
- the argument index
IllegalArgumentException
- if the index is not within the boundspublic final String getName()
public final Description getDescription()
public final String getUsage()
getDescription().getUsage()
on this
object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |