org.alicebot.server.core.util
Interface ShellCommandable

All Known Implementing Classes:
AliceIRC

public interface ShellCommandable

Defines the interface for processes that can receive commands from the interactive Shell.

Version:
4.1.4
Author:
Noel Bush

Method Summary
 java.lang.String getShellCommands()
          Returns a list of shell commands that are available.
 java.lang.String getShellDescription()
          Returns a string that describes the listener when getting a listener list in the interactive shell.
 java.lang.String getShellID()
          Returns a string that can be used to send commands to the listener from the interactive shell.
 void processShellCommand(java.lang.String command)
          Sends a command to the shell.
 

Method Detail

getShellID

java.lang.String getShellID()
Returns a string that can be used to send commands to the listener from the interactive shell.

Returns:
a string that can be used to send commands to the listener from the interactive shell

getShellDescription

java.lang.String getShellDescription()
Returns a string that describes the listener when getting a listener list in the interactive shell.

Returns:
a string that describes the listener

getShellCommands

java.lang.String getShellCommands()
Returns a list of shell commands that are available.

Returns:
a list of shell commands that are available

processShellCommand

void processShellCommand(java.lang.String command)
Sends a command to the shell. The ShellCommandable itself is responsible for putting back any output to the shell.

Parameters:
command - the command to send to the shell