Module com.aoapps.hodgepodge

Package com.aoapps.hodgepodge.util

Class ShellInterpreter

java.lang.Object

com.aoapps.hodgepodge.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShellInterpreter.ParseBuffer	A optional parser buffer to aid performance of repeated parsing.
static class	ShellInterpreter.ParseResult	The result of a parsing pass.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static void	checkRawArgsVersusArgs(String[] rawArgs, String... args)	Performs checks and assertions that rawArgs is consistent with args.
final void	clear(String... args)	Clears the screen.
protected abstract String	getName()
final long	getPid()
final long	getPID()	Deprecated. Please use getPid() instead.
protected abstract String	getPrompt()
protected abstract boolean	handleCommand(String[] rawArgs, String... args)	Processes one command and returns.
protected final boolean	isAlive()
protected final boolean	isInteractive()
final void	jobs(String... args)
protected abstract ShellInterpreter	newShellInterpreter(Reader in, TerminalWriter out, TerminalWriter err, String[] rawArgs, String... args)
static ShellInterpreter.ParseResult	parse(Reader in, Writer promptOut)	Parses a stream of characters into arguments.
static ShellInterpreter.ParseResult	parse(Reader in, Writer promptOut, ShellInterpreter.ParseBuffer buffer)	Parses a stream of characters into arguments.
final 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 Details

in

protected final Reader in

out

protected final TerminalWriter out

err

protected final TerminalWriter err

status

protected String status

Constructor Details

ShellInterpreter

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

ShellInterpreter

protected ShellInterpreter(Reader in,
 TerminalWriter out,
 TerminalWriter err,
 String[] rawArgs,
 String... args)

ShellInterpreter

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

ShellInterpreter

protected ShellInterpreter(Reader in,
 Writer out,
 Writer err,
 String[] rawArgs,
 String... args)

Method Details

checkRawArgsVersusArgs

public static void checkRawArgsVersusArgs(String[] rawArgs,
 String... args)
                                   throws IllegalArgumentException,
AssertionError

Performs checks and assertions that rawArgs is consistent with args.

Throws:

IllegalArgumentException

AssertionError

clear

public final void clear(String... args)
                 throws IOException

Clears the screen.

Throws:

IOException

getName

protected abstract String getName()

getPid

public final long getPid()

getPID

@Deprecated
public final long getPID()

Deprecated.

Please use getPid() instead.

getPrompt

protected abstract String getPrompt()
                             throws IOException,
SQLException

Throws:

IOException

SQLException

handleCommand

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

Processes one command and returns.

Parameters:

rawArgs - The raw args contain the same content as args, but quoting is left intact. Will be null when the arguments were split outside, such as being from the arguments passed to the Java application main method.

args - The args with all shell quoting decoded.

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[] rawArgs,
 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

parse

public static ShellInterpreter.ParseResult parse(Reader in,
 Writer promptOut,
 ShellInterpreter.ParseBuffer buffer)
                                          throws IOException

Parses a stream of characters into arguments. Reads up to the first newline that is not backslash-escaped, or until end of file.

Parameters:

in - the reader to parse

promptOut - the optional output to write prompts

buffer - the optional buffer, may be null

Throws:

IOException

parse

public static ShellInterpreter.ParseResult parse(Reader in,
 Writer promptOut)
                                          throws IOException

Parses a stream of characters into arguments. Reads up to the first newline that is not backslash-escaped, or until end of file.

Parameters:

in - the reader to parse

promptOut - the optional output to write prompts

Throws:

IOException