com.clearlydecoded.commander

Interface CommandHandlerRegistry

All Known Implementing Classes:

DefaultCommandHandlerRegistry

public interface CommandHandlerRegistry

CommandHandlerRegistry interface defines methods for adding, removing, and retrieving CommandHandlers based on the type of the Command.

Author:

Yaakov Chaikin (yaakov@ClearlyDecoded.com)

Method Summary

Modifier and Type	Method and Description
void	addHandler(CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse> commandHandler) Adds commandHandler to the commandHandler registry.
void	addHandlers(List<? extends CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse>> commandHandlers) Adds commandHandlers to the handler registry.
CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse>	getHandlerFor(String commandType) Retrieves concrete CommandHandler for the type of the command.
List<CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse>>	getHandlers() Retrieve all handlers successfully registered in the command handler registry.
void	removeHandler(String commandType) Removes command handler which handles commandtype type of Command from the handler registry.

Method Detail

addHandler

void addHandler(CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse> commandHandler)

Adds commandHandler to the commandHandler registry.

Parameters:

commandHandler - Handler to add to the commandHandler registry.

addHandlers

void addHandlers(List<? extends CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse>> commandHandlers)

Adds commandHandlers to the handler registry.

Parameters:

commandHandlers - List of commandHandlers to add to the handler registry.

getHandlerFor

CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse> getHandlerFor(String commandType)

Retrieves concrete CommandHandler for the type of the command. If not found, returns null.

Parameters:

commandType - Command type identifier that is unique system-wide.

Returns:

An instance of a concrete implementation of CommandHandler based on the commandType. If no handler is found for the command type, returns null.

removeHandler

void removeHandler(String commandType)

Removes command handler which handles commandtype type of Command from the handler registry.

Parameters:

commandType - Command type identifier that is unique system-wide.

getHandlers

List<CommandHandler<? extends Command<? extends CommandResponse>,? extends CommandResponse>> getHandlers()

Retrieve all handlers successfully registered in the command handler registry.

Returns:

List of successfully discovered and registered command handlers. If none are registered, returns an empty list.