com.sk89q.intake.parametric

Class ParametricBuilder

java.lang.Object

com.sk89q.intake.parametric.ParametricBuilder

public class ParametricBuilder
extends Object

Keeps a mapping of types to bindings and generates commands from classes with appropriate annotations.

Constructor Summary

Constructors

Constructor and Description
ParametricBuilder(Injector injector)

Method Summary

Modifier and Type	Method and Description
void	addExceptionConverter(ExceptionConverter converter) Attach an exception converter to this builder in order to wrap unknown Throwables into known CommandExceptions.
void	addInvokeListener(InvokeListener listener) Attach an invocation listener.
Authorizer	getAuthorizer() Get the authorizer.
ExecutorService	getCommandExecutor() Get the executor service used to invoke the actual command.
CommandCompleter	getDefaultCompleter() Get the default command suggestions provider that will be used if no suggestions are available.
Injector	getInjector()
void	registerMethodsAsCommands(Dispatcher dispatcher, Object object) Build a list of commands from methods specially annotated with Command (and other relevant annotations) and register them all with the given Dispatcher.
void	setAuthorizer(Authorizer authorizer) Set the authorizer.
void	setCommandExecutor(ExecutorService commandExecutor) Set the executor service used to invoke the actual command.
void	setDefaultCompleter(CommandCompleter defaultCompleter) Set the default command suggestions provider that will be used if no suggestions are available.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParametricBuilder

public ParametricBuilder(Injector injector)

Method Detail

getInjector

public Injector getInjector()

addInvokeListener

public void addInvokeListener(InvokeListener listener)

Attach an invocation listener.

Invocation handlers are called in order that their listeners are registered with a ParametricBuilder. It is not guaranteed that a listener may be called, in the case of a CommandException being thrown at any time before the appropriate listener or handler is called.

Parameters:

listener - The listener

See Also:

tThe handler

addExceptionConverter

public void addExceptionConverter(ExceptionConverter converter)

Attach an exception converter to this builder in order to wrap unknown Throwables into known CommandExceptions.

Exception converters are called in order that they are registered.

Parameters:

converter - The converter

See Also:

for an explanation

getCommandExecutor

public ExecutorService getCommandExecutor()

Get the executor service used to invoke the actual command.

Bindings will still be resolved in the thread in which the callable was called.

Returns:

The command executor

setCommandExecutor

public void setCommandExecutor(ExecutorService commandExecutor)

Set the executor service used to invoke the actual command.

Bindings will still be resolved in the thread in which the callable was called.

registerMethodsAsCommands

public void registerMethodsAsCommands(Dispatcher dispatcher,
                                      Object object)
                               throws ParametricException

Build a list of commands from methods specially annotated with Command (and other relevant annotations) and register them all with the given Dispatcher.

Parameters:

dispatcher - The dispatcher to register commands with

object - The object contain the methods

Throws:

ParametricException - thrown if the commands cannot be registered

getAuthorizer

public Authorizer getAuthorizer()

Get the authorizer.

Returns:

The authorizer

setAuthorizer

public void setAuthorizer(Authorizer authorizer)

Set the authorizer.

Parameters:

authorizer - The authorizer

getDefaultCompleter

public CommandCompleter getDefaultCompleter()

Get the default command suggestions provider that will be used if no suggestions are available.

Returns:

The default command completer

setDefaultCompleter

public void setDefaultCompleter(CommandCompleter defaultCompleter)

Set the default command suggestions provider that will be used if no suggestions are available.

Parameters:

defaultCompleter - The default command completer