Class StdCommandHandler

java.lang.Object

pro.gravit.utils.command.CommandHandler

pro.gravit.utils.command.StdCommandHandler

All Implemented Interfaces:

Runnable

public class StdCommandHandler
extends CommandHandler

Nested Class Summary

Nested classes/interfaces inherited from class CommandHandler

CommandHandler.Category, CommandHandler.CommandWalk

Modifier and Type	Class	Description
static class	CommandHandler.Category
static interface	CommandHandler.CommandWalk

Field Summary

Fields inherited from class CommandHandler

baseCategory, categories

Modifier and Type	Field	Description
protected final CommandCategory	baseCategory
protected final List<CommandHandler.Category>	categories

Constructor Summary

Constructors

Modifier	Constructor	Description
	StdCommandHandler(boolean readCommands)
	StdCommandHandler(BufferedReader reader)
	StdCommandHandler(InputStream stream)
protected	StdCommandHandler(List<CommandHandler.Category> categories, CommandCategory baseCategory, boolean readCommands)
protected	StdCommandHandler(List<CommandHandler.Category> categories, CommandCategory baseCategory, BufferedReader reader)
protected	StdCommandHandler(List<CommandHandler.Category> categories, CommandCategory baseCategory, InputStream stream)

Method Summary

Modifier and Type	Method	Description
void	bell()	If supported, sends a bell signal to the console
void	clear()	Cleans the console
StdCommandHandler	ofHandler(CommandHandler commandHandler, boolean readCommands)
StdCommandHandler	ofHandler(CommandHandler commandHandler, BufferedReader reader)
StdCommandHandler	ofHandler(CommandHandler commandHandler, InputStream stream)
String	readLine()	Reads a line from the console

Methods inherited from class CommandHandler

eval, eval, evalNative, findCategory, findCommand, getBaseCategory, getCategories, lookup, registerCategory, registerCommand, run, unregisterCategory, unregisterCommand, walk

Modifier and Type	Method	Description
void	eval(String[] args, boolean bell)
void	eval(String line, boolean bell)
void	evalNative(String line, boolean bell)
CommandHandler.Category	findCategory(String name)
Command	findCommand(String name)
CommandCategory	getBaseCategory()
List<CommandHandler.Category>	getCategories()
Command	lookup(String name)
void	registerCategory(CommandHandler.Category category)
void	registerCommand(String name, Command command)
void	run()
void	unregisterCategory(CommandHandler.Category category)
Command	unregisterCommand(String name)
void	walk(CommandHandler.CommandWalk callback)	Walk all categories Categories are sorted in the order they are added.

Methods inherited from class Object

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

Constructor Details

StdCommandHandler

public StdCommandHandler(boolean readCommands)

StdCommandHandler

public StdCommandHandler(InputStream stream)

StdCommandHandler

public StdCommandHandler(BufferedReader reader)

StdCommandHandler

protected StdCommandHandler(List<CommandHandler.Category> categories,
 CommandCategory baseCategory,
 boolean readCommands)

StdCommandHandler

protected StdCommandHandler(List<CommandHandler.Category> categories,
 CommandCategory baseCategory,
 InputStream stream)

StdCommandHandler

protected StdCommandHandler(List<CommandHandler.Category> categories,
 CommandCategory baseCategory,
 BufferedReader reader)

Method Details

bell

public void bell()

Description copied from class: CommandHandler

If supported, sends a bell signal to the console

Specified by:

bell in class CommandHandler

clear

public void clear()
           throws IOException

Description copied from class: CommandHandler

Cleans the console

Specified by:

clear in class CommandHandler

Throws:

IOException - Internal Error

readLine

public String readLine()
                throws IOException

Description copied from class: CommandHandler

Reads a line from the console

Specified by:

readLine in class CommandHandler

Returns:

command line

Throws:

IOException - Internal Error

ofHandler

public StdCommandHandler ofHandler(CommandHandler commandHandler,
 boolean readCommands)

ofHandler

public StdCommandHandler ofHandler(CommandHandler commandHandler,
 InputStream stream)

ofHandler

public StdCommandHandler ofHandler(CommandHandler commandHandler,
 BufferedReader reader)