net.grinder.console
Class ConsoleFoundation

java.lang.Object
  net.grinder.console.ConsoleFoundation

public final class ConsoleFoundation
extends Object

This is the entry point of The Grinder console.

Author:

Paco Gomez, Philip Aston

Nested Class Summary

static interface	ConsoleFoundation.UI Contract for user interfaces.
static class	ConsoleFoundation.WireMessageDispatch Factory that wires up the message dispatch.

Constructor Summary

ConsoleFoundation(Resources resources, org.slf4j.Logger logger, boolean headless)
Constructor.

ConsoleFoundation(Resources resources, org.slf4j.Logger logger, boolean headless, Timer timer, ConsoleProperties properties)
Constructor.

Method Summary

void	run() Console message event loop.
void	shutdown() Shut down the console.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleFoundation

public ConsoleFoundation(Resources resources,
                         org.slf4j.Logger logger,
                         boolean headless)
                  throws GrinderException

Constructor. Locates the console properties in the user's home directory.

Parameters:

resources - Console resources

logger - Logger.

headless - true => run with the text UI.

Throws:

GrinderException - If an error occurs.

ConsoleFoundation

public ConsoleFoundation(Resources resources,
                         org.slf4j.Logger logger,
                         boolean headless,
                         Timer timer,
                         ConsoleProperties properties)
                  throws GrinderException

Constructor. Allows properties to be specified.

Parameters:

resources - Console resources

logger - Logger.

headless - true => run with the text UI.

timer - A timer.

properties - The properties.

Throws:

GrinderException - If an error occurs.

Method Detail

run

public void run()

Console message event loop. Dispatches communication messages appropriately. Blocks until we are shutdown().

shutdown

public void shutdown()

Shut down the console.

Once stopped, the instance cannot be restarted.