org.crsh.command

Interface ShellCommand

All Known Implementing Classes:

BaseShellCommand, GroovyScriptShellCommand

public interface ShellCommand

A shell command.

Method Summary

Methods

Modifier and Type	Method and Description
CompletionMatch	complete(RuntimeContext context, String line) Provide completions for the specified arguments.
String	describe(String line, DescriptionFormat mode) Returns a description of the command or null if none can be found.
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.

Method Detail

complete

CompletionMatch complete(RuntimeContext context,
                       String line)
                         throws CommandCreationException

Provide completions for the specified arguments.

Parameters:

context - the command context

line - the original command line arguments

Returns:

the completions

Throws:

CommandCreationException

describe

String describe(String line,
              DescriptionFormat mode)

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

Parameters:

line - the usage line

mode - the description mode

Returns:

the description

resolveInvoker

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

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

Parameters:

line - the command line arguments

Returns:

the command

Throws:

CommandCreationException

resolveInvoker

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

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

Parameters:

name - the command name, might be null

options - the options

args - the arguments

Returns:

the command

Throws:

CommandCreationException