org.apache.geronimo.gshell.console
Class Console

java.lang.Object
  org.apache.geronimo.gshell.console.Console

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

JLineConsole

public abstract class Console
extends Object
implements Runnable

Provides an abstraction of a console.

Version:

$Rev: 573669 $ $Date: 2007-09-07 11:47:20 -0700 (Fri, 07 Sep 2007) $

Nested Class Summary

static interface	Console.ErrorHandler
static interface	Console.Executor
static interface	Console.Prompter

Field Summary

protected boolean	autoTrim
protected boolean	breakOnNull
protected Console.ErrorHandler	errorHandler
protected Console.Executor	executor
protected boolean	ignoreEmpty
protected org.slf4j.Logger	log
protected Console.Prompter	prompter
protected boolean	running

Constructor Summary

Console(Console.Executor executor)

Method Summary

Console.ErrorHandler	getErrorHandler()
Console.Executor	getExecutor()
Console.Prompter	getPrompter()
boolean	isAutoTrim()
boolean	isBreakOnNull()
boolean	isIgnoreEmpty()
boolean	isRunning()
protected abstract String	readLine(String prompt)
void	run()
void	setAutoTrim(boolean autoTrim)
void	setBreakOnNull(boolean breakOnNull)
void	setErrorHandler(Console.ErrorHandler errorHandler)
void	setExecutor(Console.Executor executor)
void	setIgnoreEmpty(boolean ignoreEmpty)
void	setPrompter(Console.Prompter prompter)
void	setRunning(boolean running)
protected boolean	work()

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

running

protected boolean running

breakOnNull

protected boolean breakOnNull

autoTrim

protected boolean autoTrim

ignoreEmpty

protected boolean ignoreEmpty

prompter

protected Console.Prompter prompter

executor

protected Console.Executor executor

errorHandler

protected Console.ErrorHandler errorHandler

Constructor Detail

Console

public Console(Console.Executor executor)

Method Detail

isRunning

public boolean isRunning()

setRunning

public void setRunning(boolean running)

isBreakOnNull

public boolean isBreakOnNull()

setBreakOnNull

public void setBreakOnNull(boolean breakOnNull)

isAutoTrim

public boolean isAutoTrim()

setAutoTrim

public void setAutoTrim(boolean autoTrim)

isIgnoreEmpty

public boolean isIgnoreEmpty()

setIgnoreEmpty

public void setIgnoreEmpty(boolean ignoreEmpty)

getErrorHandler

public Console.ErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(Console.ErrorHandler errorHandler)

getPrompter

public Console.Prompter getPrompter()

setPrompter

public void setPrompter(Console.Prompter prompter)

getExecutor

public Console.Executor getExecutor()

setExecutor

public void setExecutor(Console.Executor executor)

run

public void run()

Specified by:

run in interface Runnable

work

protected boolean work()
                throws Exception

Throws:

Exception

readLine

protected abstract String readLine(String prompt)
                            throws IOException

Throws:

IOException