org.crsh.cli.descriptor

Class CommandDescriptor<T>

java.lang.Object

org.crsh.cli.descriptor.CommandDescriptor<T>

public abstract class CommandDescriptor<T>
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
org.crsh.cli.impl.completion.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 org.crsh.cli.impl.invocation.CommandInvoker<T,?>	getInvoker(org.crsh.cli.impl.invocation.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.
org.crsh.cli.impl.invocation.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOwner

public abstract CommandDescriptor<T> getOwner()

getDepth

public final int getDepth()

printUsage

public final void printUsage(Appendable to)
                      throws IOException

Throws:

IOException

printMan

public final void printMan(Appendable to)
                    throws IOException

Throws:

IOException

print

public final void print(Format format,
         Appendable to)
                 throws IOException

Throws:

IOException

getSubordinates

public abstract Map<String,? extends CommandDescriptor<T>> getSubordinates()

Returns:

the command subordinates as a map.

getSubordinate

public final CommandDescriptor<T> getSubordinate(String name)

Returns a specified subordinate.

Parameters:

name - the subordinate name

Returns:

the subordinate command or null

getParameters

public final List<ParameterDescriptor> getParameters()

Returns the command parameters, the returned collection contains the command options and the command arguments.

Returns:

the command parameters

getOptionNames

public final Set<String> getOptionNames()

Returns the command option names.

Returns:

the command option names

getShortOptionNames

public final Set<String> getShortOptionNames()

Returns the command short option names.

Returns:

the command long option names

getLongOptionNames

public final Set<String> getLongOptionNames()

Returns the command long option names.

Returns:

the command long option names

getOptions

public final Collection<OptionDescriptor> getOptions()

Returns the command options.

Returns:

the command options

getOption

public final OptionDescriptor getOption(String name)

Returns a command option by its name.

Parameters:

name - the option name

Returns:

the option

resolveOption

public final OptionDescriptor resolveOption(String name)

Find an command option by its name, this will look through the command hierarchy.

Parameters:

name - the option name

Returns:

the option or null

getArguments

public final List<ArgumentDescriptor> getArguments()

Returns a list of the command arguments.

Returns:

the command arguments

getArgument

public final ArgumentDescriptor getArgument(int index)
                                     throws IllegalArgumentException

Returns a a specified argument by its index.

Parameters:

index - the argument index

Returns:

the command argument

Throws:

IllegalArgumentException - if the index is not within the bounds

getName

public final String getName()

Returns the command name.

Returns:

the command name

getDescription

public final Description getDescription()

Returns the command description.

Returns:

the command description

getUsage

public final String getUsage()

Returns the command usage, shortcut for invoking getDescription().getUsage() on this object.

Returns:

the command usage

getInvoker

public abstract org.crsh.cli.impl.invocation.CommandInvoker<T,?> getInvoker(org.crsh.cli.impl.invocation.InvocationMatch<T> match)

matcher

public final org.crsh.cli.impl.invocation.InvocationMatcher<T> matcher()

completer

public final org.crsh.cli.impl.completion.CompletionMatcher<T> completer()