Package pro.gravit.utils.command

Class CommandHandler

java.lang.Object

pro.gravit.utils.command.CommandHandler

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

JLineCommandHandler, StdCommandHandler

public abstract class CommandHandler
extends Object
implements Runnable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
	CommandHandler()
protected	CommandHandler(List<CommandHandler.Category> categories, CommandCategory baseCategory)

Method Summary

Modifier and Type	Method	Description
abstract void	bell()	If supported, sends a bell signal to the console
abstract void	clear()	Cleans the console
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)
abstract String	readLine()	Reads a line from the console
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 java.lang.Object

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

Field Details

categories

protected final List<CommandHandler.Category> categories

baseCategory

protected final CommandCategory baseCategory

Constructor Details

CommandHandler

public CommandHandler()

CommandHandler

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

Method Details

eval

public void eval(String line,
 boolean bell)

evalNative

public void evalNative(String line,
 boolean bell)
                throws Exception

Throws:

Exception

eval

public void eval(String[] args,
 boolean bell)
          throws Exception

Throws:

Exception

lookup

public Command lookup(String name)
               throws CommandException

Throws:

CommandException

findCommand

public Command findCommand(String name)

readLine

public abstract String readLine()
                         throws IOException

Reads a line from the console

Returns:

command line

Throws:

IOException - Internal Error

registerCommand

public void registerCommand(String name,
 Command command)

registerCategory

public void registerCategory(CommandHandler.Category category)

unregisterCategory

public void unregisterCategory(CommandHandler.Category category)

findCategory

public CommandHandler.Category findCategory(String name)

unregisterCommand

public Command unregisterCommand(String name)

run

public void run()

Specified by:

run in interface Runnable

walk

public void walk(CommandHandler.CommandWalk callback)

Walk all categories Categories are sorted in the order they are added. The base category is walked last

Parameters:

callback - your callback

getBaseCategory

public CommandCategory getBaseCategory()

getCategories

public List<CommandHandler.Category> getCategories()

bell

public abstract void bell()

If supported, sends a bell signal to the console

clear

public abstract void clear()
                    throws IOException

Cleans the console

Throws:

IOException - Internal Error