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 java.lang.Object
implements ShellCommand

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
BaseShellCommand(java.lang.Class<CC> clazz)

Method Summary

Methods

Modifier and Type	Method and Description
org.crsh.cli.impl.completion.CompletionMatch	complete(RuntimeContext context, java.lang.String line) Provide completions for the specified arguments.
java.lang.String	describe(java.lang.String line, DescriptionFormat mode) Returns a description of the command or null if none can be found.
CommandDescriptor<? extends BaseCommand>	getDescriptor()
CommandInvoker<?,?>	resolveInvoker(org.crsh.cli.impl.invocation.InvocationMatch<CC> match)
CommandInvoker<?,?>	resolveInvoker(java.util.Map<java.lang.String,?> options, java.lang.String subordinate, java.util.Map<java.lang.String,?> subordinateOptions, java.util.List<?> arguments) Provides an invoker for the command line specified in a detyped manner.
CommandInvoker<?,?>	resolveInvoker(java.lang.String line) Provides an invoker for the command line specified as a command line to parse.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseShellCommand

public BaseShellCommand(java.lang.Class<CC> clazz)

Method Detail

getDescriptor

public CommandDescriptor<? extends BaseCommand> getDescriptor()

complete

public final org.crsh.cli.impl.completion.CompletionMatch complete(RuntimeContext context,
                                                    java.lang.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 java.lang.String describe(java.lang.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(java.util.Map<java.lang.String,?> options,
                                 java.lang.String subordinate,
                                 java.util.Map<java.lang.String,?> subordinateOptions,
                                 java.util.List<?> arguments)
                                   throws CommandCreationException

Description copied from interface: ShellCommand

Provides an invoker for the command line specified in a detyped manner.

Specified by:

resolveInvoker in interface ShellCommand

Parameters:

options - the base options

subordinate - the subordinate command name, might null

subordinateOptions - the subordinate options

arguments - arguments

Returns:

the command

Throws:

CommandCreationException

resolveInvoker

public CommandInvoker<?,?> resolveInvoker(java.lang.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(org.crsh.cli.impl.invocation.InvocationMatch<CC> match)
                                         throws CommandCreationException

Throws:

CommandCreationException