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
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.
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.

Method Detail

complete

org.crsh.cli.impl.completion.CompletionMatch complete(RuntimeContext context,
                                                    java.lang.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

java.lang.String describe(java.lang.String line,
                        DescriptionFormat mode)
                          throws CommandCreationException

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

Throws:

CommandCreationException

resolveInvoker

CommandInvoker<?,?> resolveInvoker(java.lang.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(java.util.Map<java.lang.String,?> options,
                                 java.lang.String subordinate,
                                 java.util.Map<java.lang.String,?> subordinateOptions,
                                 java.util.List<?> arguments)
                                   throws CommandCreationException

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

Parameters:

options - the base options

subordinate - the subordinate command name, might null

subordinateOptions - the subordinate options

arguments - arguments

Returns:

the command

Throws:

CommandCreationException