edu.cmu.sphinx.util

Class CommandInterpreter

java.lang.Object

java.lang.Thread

edu.cmu.sphinx.util.CommandInterpreter

All Implemented Interfaces:

java.lang.Runnable

public class CommandInterpreter
extends java.lang.Thread

This class is a command interpreter. It reads strings from an input stream, parses them into commands and executes them, results are sent back on the output stream.

See Also:

CommandInterpreter

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CommandInterpreter() Creates a command interpreter that won't read a stream.
CommandInterpreter(java.io.BufferedReader in, java.io.PrintWriter out) Creates a command interpreter that reads/writes on the given streams.

Method Summary

Modifier and Type	Method and Description
void	add(java.util.Map<java.lang.String,CommandInterface> newCommands) Add the given set of commands to the list of commands.
void	add(java.lang.String name, CommandInterface command) Adds the given command to the command list.
void	addAlias(java.lang.String command, java.lang.String alias) Adds an alias to the command
void	close()
java.lang.String	execute(java.lang.String cmdString) Execute the given command string.
protected java.lang.String	execute(java.lang.String[] args) Execute the given command.
java.io.PrintWriter	getPrintWriter() Returns the output stream of this CommandInterpreter.
java.lang.String	getPrompt() Gets the prompt for the interpreter
java.net.Socket	getSocket()
boolean	load(java.lang.String filename)
static void	main(java.lang.String[] args)
protected void	onExit() Called when the interpreter is exiting.
protected java.lang.String[]	parseMessage(java.lang.String message) Parses the given message into an array of strings.
void	putResponse(java.lang.String response) Outputs a response to the sender.
void	run()
void	setPrompt(java.lang.String prompt) Sets the prompt for the interpreter
void	setSocket(java.net.Socket skt) Sets the Socket for this CommandInterpreter.
void	setStreams(java.io.BufferedReader in, java.io.PrintWriter out) Sets the I/O streams
void	setTrace(boolean trace) Sets the trace mode of the command interpreter.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandInterpreter

public CommandInterpreter(java.io.BufferedReader in,
                          java.io.PrintWriter out)

Creates a command interpreter that reads/writes on the given streams.

Parameters:

in - the input stream.

out - the output stream.

CommandInterpreter

public CommandInterpreter()

Creates a command interpreter that won't read a stream.

Method Detail

setTrace

public void setTrace(boolean trace)

Sets the trace mode of the command interpreter.

Parameters:

trace - true if tracing.

setStreams

public void setStreams(java.io.BufferedReader in,
                       java.io.PrintWriter out)

Sets the I/O streams

Parameters:

in - the input stream.

out - the output stream.

getSocket

public java.net.Socket getSocket()

Returns:

the Socket this CommandInterpreter uses.

setSocket

public void setSocket(java.net.Socket skt)

Sets the Socket for this CommandInterpreter.

Parameters:

skt - the Socket this CommandInterpreter uses

add

public void add(java.lang.String name,
                CommandInterface command)

Adds the given command to the command list.

Parameters:

name - the name of the command.

command - the command to be executed.

addAlias

public void addAlias(java.lang.String command,
                     java.lang.String alias)

Adds an alias to the command

Parameters:

command - the name of the command.

alias - the new aliase

add

public void add(java.util.Map<java.lang.String,CommandInterface> newCommands)

Add the given set of commands to the list of commands.

Parameters:

newCommands - the new commands to add to this interpreter.

putResponse

public void putResponse(java.lang.String response)

Outputs a response to the sender.

Parameters:

response - the response to send.

onExit

protected void onExit()

Called when the interpreter is exiting. Default behavior is to execute an "on_exit" command.

execute

protected java.lang.String execute(java.lang.String[] args)

Execute the given command.

Parameters:

args - command args, args[0] contains name of cmd.

Returns:

result string

execute

public java.lang.String execute(java.lang.String cmdString)

Execute the given command string.

Parameters:

cmdString - the command string.

Returns:

result string

parseMessage

protected java.lang.String[] parseMessage(java.lang.String message)

Parses the given message into an array of strings.

Parameters:

message - the string to be parsed.

Returns:

the parsed message as an array of strings

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

close

public void close()

load

public boolean load(java.lang.String filename)

setPrompt

public void setPrompt(java.lang.String prompt)

Sets the prompt for the interpreter

Parameters:

prompt - the prompt.

getPrompt

public java.lang.String getPrompt()

Gets the prompt for the interpreter

Returns:

the prompt.

getPrintWriter

public java.io.PrintWriter getPrintWriter()

Returns the output stream of this CommandInterpreter.

Returns:

the output stream

main

public static void main(java.lang.String[] args)