org.crsh.command

Class BaseShellCommand<CC extends BaseCommand>

java.lang.Object

org.crsh.command.BaseShellCommand<CC>

All Implemented Interfaces:

ShellCommand

public class BaseShellCommand<CC extends BaseCommand>
extends Object
implements ShellCommand

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
private Class<CC>	clazz .
private CommandDescriptorImpl<CC>	descriptor .

Constructor Summary

Constructors

Constructor and Description
BaseShellCommand(Class<CC> clazz)

Method Summary

Methods

Modifier and Type	Method and Description
CompletionMatch	complete(RuntimeContext context, String line) Provide completions for the specified arguments.
private CC	createCommand()
String	describe(String line, DescriptionFormat mode) Returns a description of the command or null if none can be found.
CommandDescriptor<? extends BaseCommand>	getDescriptor()
private <P> CommandInvoker<Void,P>	getInvoker(CommandInvoker<CC,?> invoker, CC instance, Class<P> _producedType, Resolver resolver)
private <C,P,PC extends PipeCommand<C,P>> CommandInvoker<C,P>	getPipeCommandInvoker(CommandInvoker<CC,PC> invoker, CC instance, Resolver resolver)
CommandInvoker<?,?>	resolveInvoker(InvocationMatch<CC> match)
CommandInvoker<?,?>	resolveInvoker(String line) Provides an invoker for the command line specified as a command line to parse.
CommandInvoker<?,?>	resolveInvoker(String name, Map<String,?> options, List<?> args) Provides an invoker for the command line specified under the form of a command, options and arguments.
private CommandInvoker<?,?>	resolveInvoker2(InvocationMatch<CC> match)

Methods inherited from class java.lang.Object

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

Field Detail

clazz

private final Class<CC extends BaseCommand> clazz

.

descriptor

private final CommandDescriptorImpl<CC extends BaseCommand> descriptor

.

Constructor Detail

BaseShellCommand

public BaseShellCommand(Class<CC> clazz)

Method Detail

getDescriptor

public CommandDescriptor<? extends BaseCommand> getDescriptor()

complete

public final CompletionMatch complete(RuntimeContext context,
                       String line)
                               throws CommandCreationException

Description copied from interface: ShellCommand

Provide completions for the specified arguments.

Specified by:

complete in interface ShellCommand

Parameters:

context - the command context

line - the original command line arguments

Returns:

the completions

Throws:

CommandCreationException

describe

public final String describe(String line,
              DescriptionFormat mode)

Description copied from interface: ShellCommand

Returns a description of the command or null if none can be found.

Specified by:

describe in interface ShellCommand

Parameters:

line - the usage line

mode - the description mode

Returns:

the description

resolveInvoker

public CommandInvoker<?,?> resolveInvoker(String name,
                                 Map<String,?> options,
                                 List<?> args)
                                   throws CommandCreationException

Description copied from interface: ShellCommand

Provides an invoker for the command line specified under the form of a command, options and arguments.

Specified by:

resolveInvoker in interface ShellCommand

Parameters:

name - the command name, might be null

options - the options

args - the arguments

Returns:

the command

Throws:

CommandCreationException

resolveInvoker

public CommandInvoker<?,?> resolveInvoker(String line)
                                   throws CommandCreationException

Description copied from interface: ShellCommand

Provides an invoker for the command line specified as a command line to parse.

Specified by:

resolveInvoker in interface ShellCommand

Parameters:

line - the command line arguments

Returns:

the command

Throws:

CommandCreationException

resolveInvoker

public final CommandInvoker<?,?> resolveInvoker(InvocationMatch<CC> match)
                                         throws CommandCreationException

Throws:

CommandCreationException

resolveInvoker2

private CommandInvoker<?,?> resolveInvoker2(InvocationMatch<CC> match)
                                     throws CommandCreationException

Throws:

CommandCreationException

createCommand

private CC createCommand()
                                      throws CommandCreationException

Throws:

CommandCreationException

getPipeCommandInvoker

private <C,P,PC extends PipeCommand<C,P>> CommandInvoker<C,P> getPipeCommandInvoker(CommandInvoker<CC,PC> invoker,
                                                                          CC instance,
                                                                          Resolver resolver)

getInvoker

private <P> CommandInvoker<Void,P> getInvoker(CommandInvoker<CC,?> invoker,
                                    CC instance,
                                    Class<P> _producedType,
                                    Resolver resolver)