org.cli4j
Class CliDriver

java.lang.Object
  |
  +--org.cli4j.CliDriver

public class CliDriver

extends java.lang.Object

The CliDriver class is the workhorse of CLI4J. This class controls the interaction between the console user and the commands defined in the command hieararchy.

A main method is provided as a simple entry point to test a command.xml file.

Version:

@(#) $Id: CliDriver.html,v 1.2 2001/12/16 05:14:50 gmcallister Exp $

Author:

Glenn McAllister

Field Summary

static java.lang.String	CLEAR_COMMAND The command the end user executes to clear the console.
static java.lang.String	CLI_CMD_STICKY_KEY
static java.lang.String	HELP_COMMAND The command the end user executes to obtain online help if any is available.
static java.lang.String	QUIT_COMMAND The command the end user executes to leave the CLI immediately.

Constructor Summary

CliDriver(java.io.File configurationFile)

CliDriver(java.io.File configurationFile, boolean debug)

CliDriver(java.io.File configurationFile, java.io.InputStream inStream, java.io.PrintStream outStream)

CliDriver(java.io.File configurationFile, java.io.InputStream inStream, java.io.PrintStream outStream, boolean debug)

Method Summary

Context	getContext()
static void	main(java.lang.String[] args)
void	run()

Methods inherited from class java.lang.Object

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

Field Detail

CLEAR_COMMAND

public static final java.lang.String CLEAR_COMMAND

The command the end user executes to clear the console.

HELP_COMMAND

public static final java.lang.String HELP_COMMAND

The command the end user executes to obtain online help if any is available.

QUIT_COMMAND

public static final java.lang.String QUIT_COMMAND

The command the end user executes to leave the CLI immediately.

CLI_CMD_STICKY_KEY

public static final java.lang.String CLI_CMD_STICKY_KEY

Constructor Detail

CliDriver

public CliDriver(java.io.File configurationFile)
          throws CliException

CliDriver

public CliDriver(java.io.File configurationFile,
                 boolean debug)
          throws CliException

CliDriver

public CliDriver(java.io.File configurationFile,
                 java.io.InputStream inStream,
                 java.io.PrintStream outStream)
          throws CliException

CliDriver

public CliDriver(java.io.File configurationFile,
                 java.io.InputStream inStream,
                 java.io.PrintStream outStream,
                 boolean debug)
          throws CliException

Method Detail

getContext

public Context getContext()

run

public void run()
         throws CliException

main

public static void main(java.lang.String[] args)