Package com.aoindustries.util

Class ShellInterpreter

java.lang.Object

com.aoindustries.util.ShellInterpreter

All Implemented Interfaces:

Runnable

public abstract class ShellInterpreter
extends Object
implements Runnable

AOSH is a Bourne-shell-like command interpreter to control the AOServ Client utilities.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected TerminalWriter	err
protected Reader	in
protected TerminalWriter	out
protected String	status

Constructor Summary

Constructors

Constructor	Description
ShellInterpreter(Reader in, TerminalWriter out, TerminalWriter err)
ShellInterpreter(Reader in, TerminalWriter out, TerminalWriter err, String... args)
ShellInterpreter(Reader in, Writer out, Writer err)
ShellInterpreter(Reader in, Writer out, Writer err, String[] args)

Method Summary

Modifier and Type	Method	Description
void	clear(String[] args)	Clears the screen.
protected abstract String	getName()
long	getPID()
protected abstract String	getPrompt()
protected abstract boolean	handleCommand(String[] args)	Processes one command and returns.
protected boolean	isAlive()
protected boolean	isInteractive()
void	jobs(String[] args)
protected abstract ShellInterpreter	newShellInterpreter(Reader in, TerminalWriter out, TerminalWriter err, String[] args)
void	run()	If arguments were provided, executes that command.

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final Reader in

out

protected final TerminalWriter out

err

protected final TerminalWriter err

status

protected String status

Constructor Detail

ShellInterpreter

public ShellInterpreter(Reader in,
                        TerminalWriter out,
                        TerminalWriter err)

ShellInterpreter

public ShellInterpreter(Reader in,
                        TerminalWriter out,
                        TerminalWriter err,
                        String... args)

ShellInterpreter

public ShellInterpreter(Reader in,
                        Writer out,
                        Writer err)

ShellInterpreter

public ShellInterpreter(Reader in,
                        Writer out,
                        Writer err,
                        String[] args)

Method Detail

clear

public final void clear(String[] args)
                 throws IOException

Clears the screen.

Throws:

IOException

getName

protected abstract String getName()

getPID

public final long getPID()

getPrompt

protected abstract String getPrompt()
                             throws IOException,
                                    SQLException

Throws:

IOException

SQLException

handleCommand

protected abstract boolean handleCommand(String[] args)
                                  throws IOException,
                                         SQLException

Processes one command and returns.

Throws:

IOException

SQLException

isAlive

protected final boolean isAlive()

isInteractive

protected final boolean isInteractive()

jobs

public final void jobs(String[] args)

newShellInterpreter

protected abstract ShellInterpreter newShellInterpreter(Reader in,
                                                        TerminalWriter out,
                                                        TerminalWriter err,
                                                        String[] args)

run

public final void run()

If arguments were provided, executes that command. Otherwise, reads from in until end of file or exit.

Specified by:

run in interface Runnable