org.crsh.shell
Interface Shell

All Known Implementing Classes:
AsyncShell, CRaSHSession

public interface Shell

A shell, it defines the interactions provided by a shell.

Version:
$Revision$
Author:
Julien Viet

Method Summary
 CommandCompletion complete(String prefix)
          Completion.
 ShellProcess createProcess(String request)
          Process a request.
 String getPrompt()
          Returns the shell prompt.
 String getWelcome()
          Returns the welcome message.
 

Method Detail

getWelcome

String getWelcome()
Returns the welcome message.

Returns:
the welcome message

getPrompt

String getPrompt()
Returns the shell prompt.

Returns:
the shell prompt

createProcess

ShellProcess createProcess(String request)
                           throws IllegalStateException
Process a request.

Parameters:
request - the request to process
Returns:
the process
Throws:
IllegalStateException - if the shell cannot create a process

complete

CommandCompletion complete(String prefix)
Completion.

Parameters:
prefix - the prefix to complete
Returns:
the sorted list of available suffixes


Copyright © 2012 eXo Platform SAS. All Rights Reserved.