Package org.bitbrawl.foodfight.controller

Class JavaController

java.lang.Object

org.bitbrawl.foodfight.controller.JavaController

All Implemented Interfaces:

Controller

@ThreadSafe
public abstract class JavaController
extends Object
implements Controller

A competitor-written controller implementation. The only abstract method that a subclass needs to implement is the Controller.playAction(Field, Team, Player) method.

Author:

Finn

Nested Class Summary

Nested classes/interfaces inherited from interface org.bitbrawl.foodfight.controller.Controller

Controller.Action

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaController()	Constructs a JavaController object, setting its logger and clock.

Method Summary

Modifier and Type	Method	Description
Clock	getClock()	Gets the clock that this controller can use to determine how much time it has left to make its moves.
Logger	getLogger()	Gets the logger that this controller can use to log messages.
static JavaController	newInstance(Class<? extends JavaController> clazz, Logger logger, Clock clock)	Deprecated.

Methods inherited from interface org.bitbrawl.foodfight.controller.Controller

playAction

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaController

protected JavaController()

Constructs a JavaController object, setting its logger and clock. This protected constructor can be used by subclasses in their parameterless constructors. This constructor ensures that the logger and clock are set before the subclass constructor runs.

Method Detail

getLogger

public Logger getLogger()

Gets the logger that this controller can use to log messages. A competitor should not use System.out for this purpose, as that could interfere with communication with the game engine.

Returns:

a logger that can be used by this controller to log messages

getClock

public Clock getClock()

Gets the clock that this controller can use to determine how much time it has left to make its moves. Note that use of this method is optional; if a controller's algorithm is not time-intensive, it may not have a need for this method.

Returns:

a clock that can be used by this controller to time itself

newInstance

@Deprecated
public static JavaController newInstance(Class<? extends JavaController> clazz,
                                         Logger logger,
                                         Clock clock)
                                  throws ControllerException

Deprecated.

Constructs a new instance of a JavaController, using the given class, logger, and clock. This method should not be called by controllers; it exists only to be internally called by the game engine. The class passed to this method must not be abstract, and must have a public parameterless constructor.

Parameters:

clazz - the class of the new controller

logger - the logger that the new controller will use

clock - the clock that the new controller will use

Returns:

the newly-constructed controller

Throws:

ControllerException - if there was a problem with the controller class