net.sf.freecol.client.control

Class InputHandler

java.lang.Object

net.sf.freecol.client.control.InputHandler

All Implemented Interfaces:

MessageHandler

Direct Known Subclasses:

InGameInputHandler, PreGameInputHandler

public abstract class InputHandler
extends java.lang.Object
implements MessageHandler

Provides common methods for input handlers.

Field Summary

Fields

Modifier and Type	Field and Description
private FreeColClient	freeColClient The main FreeCol client object.
private static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
InputHandler(FreeColClient freeColClient) The constructor to use.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Element	disconnect(org.w3c.dom.Element element) Handles a "disconnect"-message.
protected FreeColClient	getFreeColClient() Gets the main freecol client object.
protected Game	getGame() Gets the Game.
protected GUI	getGUI() Gets the GUI.
abstract org.w3c.dom.Element	handle(Connection connection, org.w3c.dom.Element element) Deals with incoming messages that have just been received.
protected org.w3c.dom.Element	unknown(org.w3c.dom.Element element) Handles a message of unknown type.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

freeColClient

private final FreeColClient freeColClient

The main FreeCol client object.

Constructor Detail

InputHandler

public InputHandler(FreeColClient freeColClient)

The constructor to use.

Parameters:

freeColClient - The FreeColClient for the game.

Method Detail

getFreeColClient

protected FreeColClient getFreeColClient()

Gets the main freecol client object.

Returns:

The main freecol client object.

getGUI

protected GUI getGUI()

Gets the GUI.

Returns:

The GUI.

getGame

protected Game getGame()

Gets the Game.

Returns:

The Game.

handle

public abstract org.w3c.dom.Element handle(Connection connection,
                                           org.w3c.dom.Element element)

Deals with incoming messages that have just been received.

Specified by:

handle in interface MessageHandler

Parameters:

connection - The Connection the message was received on.

element - The root Element of the message.

Returns:

The reply.

disconnect

protected org.w3c.dom.Element disconnect(org.w3c.dom.Element element)

Handles a "disconnect"-message.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.

unknown

protected org.w3c.dom.Element unknown(org.w3c.dom.Element element)

Handles a message of unknown type.

Parameters:

element - The element (root element in a DOM-parsed XML tree) that holds all the information.

Returns:

Null.