org.jboss.aesh.console

Class ConsoleCommand

java.lang.Object

org.jboss.aesh.console.ConsoleCommand

public abstract class ConsoleCommand
extends Object

A ConsoleCommand is the base of any "external" commands that will run in the foreground of aesh. Call attach() to set a command in the foreground of aesh.

Author:

Ståle W. Pedersen

Field Summary

Fields

Modifier and Type	Field and Description
protected Console	console

Constructor Summary

Constructors

Constructor and Description
ConsoleCommand(Console console)

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterAttach() Called after attach(..) is called.
protected abstract void	afterDetach() Called after detach() is called
void	attach(ConsoleOutput output) Called by creator of the process Calls afterAttach()
void	detach() Mark this process ready to be detached from console.
ConsoleOutput	getConsoleOutput()
boolean	hasRedirectOut()
boolean	isAttached()
abstract void	processOperation(Operation operation) Called after every operation made by the user

Methods inherited from class java.lang.Object

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

Field Detail

console

protected Console console

Constructor Detail

ConsoleCommand

public ConsoleCommand(Console console)

Method Detail

attach

public final void attach(ConsoleOutput output)
                  throws IOException

Called by creator of the process Calls afterAttach()

Throws:

IOException - stream

isAttached

public final boolean isAttached()

Returns:

true if the process is attached to console. eg. its "running".

detach

public final void detach()
                  throws IOException

Mark this process ready to be detached from console. Calls afterDetach

Throws:

IOException - stream

hasRedirectOut

public final boolean hasRedirectOut()

getConsoleOutput

public final ConsoleOutput getConsoleOutput()

afterAttach

protected abstract void afterAttach()
                             throws IOException

Called after attach(..) is called.

Throws:

IOException - stream

afterDetach

protected abstract void afterDetach()
                             throws IOException

Called after detach() is called

Throws:

IOException - stream

processOperation

public abstract void processOperation(Operation operation)
                               throws IOException

Called after every operation made by the user

Parameters:

operation - operation

Throws:

IOException - stream