org.lsst.ccs.shell

Class JLineShell

java.lang.Object

org.lsst.ccs.shell.JLineShell

public class JLineShell
extends Object

A simple shell for playing with the command parsing classes. This class is designed to be run from a terminal and uses JLine to interact with the user. The command shell has some built-in functionality, including the ability to provide help, and the ability to do tab completion.

Author:

tonyj

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JLineShell.BuiltIns The set of built in commands.
static class	JLineShell.SetCommands An enumeration of the arguments to the set command.

Constructor Summary

Constructors

Constructor and Description
JLineShell(CommandSet userCommands) Creates a JLineShell with the given set of user commands.
JLineShell(CommandSet userCommands, jline.console.ConsoleReader reader)
JLineShell(CommandSet userCommands, jline.console.ConsoleReader reader, String prompt)
JLineShell(CommandSet userCommands, String prompt)

Method Summary

Modifier and Type	Method and Description
static void	main(String[] argv) Temporary method waiting for feedback.
void	run() Run the command shell.

Methods inherited from class java.lang.Object

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

Constructor Detail

JLineShell

public JLineShell(CommandSet userCommands)
           throws IOException

Creates a JLineShell with the given set of user commands.

Parameters:

userCommands - The user defined commands which will be merged with the built-in commands provided by the shell itself. The CommandSet passed in can change dynamically (for example if it is in fact a CompositeCommandSet commands can be added and removed dynamically).

Throws:

IOException - If something goes horribly wrong.

JLineShell

public JLineShell(CommandSet userCommands,
                  jline.console.ConsoleReader reader)

JLineShell

public JLineShell(CommandSet userCommands,
                  String prompt)
           throws IOException

Throws:

IOException

JLineShell

public JLineShell(CommandSet userCommands,
                  jline.console.ConsoleReader reader,
                  String prompt)

Method Detail

run

public void run()
         throws IOException

Run the command shell. This method does not return until the user exits from the shell.

Throws:

IOException - If something goes horribly wrong.

main

public static void main(String[] argv)
                 throws Exception

Temporary method waiting for feedback. This main will start the shell by providing a single class name of the object the dictionary should be built of. This object must have an empty constructor.

Parameters:

argv -

Throws:

Exception