burlap.shell

Class BurlapShell

java.lang.Object

burlap.shell.BurlapShell

Direct Known Subclasses:

EnvironmentShell, SGWorldShell

public class BurlapShell
extends java.lang.Object

A class for a runtime shell. Takes as input a InputStream and OutputStream for the shell. Shell commands are implemented by objects implementing the ShellCommand interface, and allows a shells set of commands to be customized and trivially extended by adding new commands with the addCommand(burlap.shell.command.ShellCommand) method.

The shell keeps a small set of special reserved commands that new commands cannot replace. These include the help, cmds (lists all known shell commands), quit (stops the shell), alias (allows a custom name to be assigned to a command), and aliases (lists all known aliases).

The shell is started with the start() method, which runs the shell in a separate thread. Beyond the InputStream that is scanned for user input, shell commands may also be executed using the executeCommand(String) method. Other objects can be alerted to command execution completion by implementing the ShellObserver and adding an observer with the addObservers(ShellObserver...) method.

Author:

James MacGlashan.

See Also:

EnvironmentShell

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	aliases
protected java.util.Map<java.lang.String,ShellCommand>	commands
protected Domain	domain
protected java.lang.String	helpText
protected java.io.InputStream	is
protected boolean	kill
protected java.util.List<ShellObserver>	observers
protected java.io.PrintStream	os
protected java.util.Set<java.lang.String>	reserved
protected java.util.Scanner	scanner
protected Visualizer	visualizer
protected java.lang.String	welcomeMessage

Constructor Summary

Constructors

Constructor and Description
BurlapShell(Domain domain, java.io.InputStream is, java.io.PrintStream os)

Method Summary

Modifier and Type	Method and Description
void	addCommand(ShellCommand command)
void	addCommandAs(ShellCommand command, java.lang.String as)
void	addObservers(ShellObserver... observers)
java.lang.String	aliasPointer(java.lang.String alias)
void	executeCommand(java.lang.String input)
protected java.util.Collection<ShellCommand>	generateReserved()
protected java.util.Collection<ShellCommand>	generateStandard()
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	getAliases()
java.util.Set<java.lang.String>	getCommands()
Domain	getDomain()
java.lang.String	getHelpText()
java.io.InputStream	getIs()
java.io.PrintStream	getOs()
Visualizer	getVisualizer()
java.lang.String	getWelcomeMessage()
void	kill()
void	removeAlias(java.lang.String alias)
void	removeCommand(java.lang.String command)
ShellCommand	resolveCommand(java.lang.String commandName)
void	setAlias(java.lang.String commandName, java.lang.String alias)
void	setAlias(java.lang.String commandName, java.lang.String alias, boolean force)
void	setDomain(Domain domain)
void	setHelpText(java.lang.String helpText)
void	setIs(java.io.InputStream is)
void	setOs(java.io.PrintStream os)
void	setVisualizer(Visualizer visualizer)
void	setWelcomeMessage(java.lang.String welcomeMessage)
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

is

protected java.io.InputStream is

os

protected java.io.PrintStream os

scanner

protected java.util.Scanner scanner

domain

protected Domain domain

visualizer

protected Visualizer visualizer

commands

protected java.util.Map<java.lang.String,ShellCommand> commands

aliases

protected java.util.Map<java.lang.String,java.lang.String> aliases

reserved

protected java.util.Set<java.lang.String> reserved

observers

protected java.util.List<ShellObserver> observers

kill

protected volatile boolean kill

welcomeMessage

protected java.lang.String welcomeMessage

helpText

protected java.lang.String helpText

Constructor Detail

BurlapShell

public BurlapShell(Domain domain,
                   java.io.InputStream is,
                   java.io.PrintStream os)

Method Detail

addCommand

public void addCommand(ShellCommand command)

addCommandAs

public void addCommandAs(ShellCommand command,
                         java.lang.String as)

setAlias

public void setAlias(java.lang.String commandName,
                     java.lang.String alias)

setAlias

public void setAlias(java.lang.String commandName,
                     java.lang.String alias,
                     boolean force)

removeAlias

public void removeAlias(java.lang.String alias)

removeCommand

public void removeCommand(java.lang.String command)

getHelpText

public java.lang.String getHelpText()

setHelpText

public void setHelpText(java.lang.String helpText)

getWelcomeMessage

public java.lang.String getWelcomeMessage()

setWelcomeMessage

public void setWelcomeMessage(java.lang.String welcomeMessage)

kill

public void kill()

getIs

public java.io.InputStream getIs()

setIs

public void setIs(java.io.InputStream is)

getOs

public java.io.PrintStream getOs()

setOs

public void setOs(java.io.PrintStream os)

resolveCommand

public ShellCommand resolveCommand(java.lang.String commandName)

aliasPointer

public java.lang.String aliasPointer(java.lang.String alias)

getCommands

public java.util.Set<java.lang.String> getCommands()

getAliases

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> getAliases()

getDomain

public Domain getDomain()

setDomain

public void setDomain(Domain domain)

getVisualizer

public Visualizer getVisualizer()

setVisualizer

public void setVisualizer(Visualizer visualizer)

addObservers

public void addObservers(ShellObserver... observers)

start

public void start()

executeCommand

public void executeCommand(java.lang.String input)

generateReserved

protected java.util.Collection<ShellCommand> generateReserved()

generateStandard

protected java.util.Collection<ShellCommand> generateStandard()