pro.gravit.utils.command

Class CommandHandler

java.lang.Object

pro.gravit.utils.command.CommandHandler

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

JLineCommandHandler, StdCommandHandler

public abstract class CommandHandler
extends java.lang.Object
implements java.lang.Runnable

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CommandHandler()

Method Summary

Modifier and Type	Method and Description
abstract void	bell() If supported, sends a bell signal to the console
abstract void	clear() Cleans the console
void	eval(java.lang.String[] args, boolean bell)
void	eval(java.lang.String line, boolean bell)
void	evalNative(java.lang.String line, boolean bell)
CommandHandler.Category	findCategory(java.lang.String name)
Command	findCommand(java.lang.String name)
CommandCategory	getBaseCategory()
java.util.List<CommandHandler.Category>	getCategories()
Command	lookup(java.lang.String name)
abstract java.lang.String	readLine() Reads a line from the console
void	registerCategory(CommandHandler.Category category)
void	registerCommand(java.lang.String name, Command command)
void	run()
boolean	unregisterCategory(CommandHandler.Category category)
Command	unregisterCommand(java.lang.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

Constructor Detail

CommandHandler

public CommandHandler()

Method Detail

eval

public void eval(java.lang.String line,
                 boolean bell)

evalNative

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

Throws:

java.lang.Exception

eval

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

Throws:

java.lang.Exception

lookup

public Command lookup(java.lang.String name)
               throws CommandException

Throws:

CommandException

findCommand

public Command findCommand(java.lang.String name)

readLine

public abstract java.lang.String readLine()
                                   throws java.io.IOException

Reads a line from the console

Returns:

command line

Throws:

java.io.IOException - Internal Error

registerCommand

public void registerCommand(java.lang.String name,
                            Command command)

registerCategory

public void registerCategory(CommandHandler.Category category)

unregisterCategory

public boolean unregisterCategory(CommandHandler.Category category)

findCategory

public CommandHandler.Category findCategory(java.lang.String name)

unregisterCommand

public Command unregisterCommand(java.lang.String name)

run

public void run()

Specified by:

run in interface java.lang.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 java.util.List<CommandHandler.Category> getCategories()

bell

public abstract void bell()
                   throws java.io.IOException

If supported, sends a bell signal to the console

Throws:

java.io.IOException - Internal Error

clear

public abstract void clear()
                    throws java.io.IOException

Cleans the console

Throws:

java.io.IOException - Internal Error