Package ch.sahits.game.openpatrician.event.handler

Class ShipArivalInPortEventListener

java.lang.Object

ch.sahits.game.openpatrician.event.handler.ShipArivalInPortEventListener

Direct Known Subclasses:

WaitTimeForShipArrival

public abstract class ShipArivalInPortEventListener
extends java.lang.Object

Event listener that implements the event listening for the ShipEntersPortEvent for a specific city and then executes execute(). The listener has to be added to the clientServerEventBus by the concrete class.

Author:

Andi Hotz, (c) Sahits GmbH, 2013 Created on Feb 19, 2013

Field Summary

Fields

Modifier and Type	Field	Description
private ICity	city
protected com.google.common.eventbus.AsyncEventBus	clientServerEventBus
private IPlayer	player
private INavigableVessel	ship

Constructor Summary

Constructors

Constructor	Description
ShipArivalInPortEventListener(ICity city, IPlayer player)

Method Summary

Modifier and Type	Method	Description
abstract boolean	execute()	Execute an action.
INavigableVessel	getShip()	The ship that has arrived.
void	handleShipEntersPort(ShipEntersPortEvent event)	Handling the event when a ship enters the port.

Methods inherited from class java.lang.Object

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

Field Detail

city

private final ICity city

player

private final IPlayer player

ship

private INavigableVessel ship

clientServerEventBus

@Autowired
@Qualifier("serverClientEventBus")
protected com.google.common.eventbus.AsyncEventBus clientServerEventBus

Constructor Detail

ShipArivalInPortEventListener

public ShipArivalInPortEventListener(ICity city,
                                     IPlayer player)

Method Detail

handleShipEntersPort

public void handleShipEntersPort(ShipEntersPortEvent event)

Handling the event when a ship enters the port. Subclasses are intended to override this implementation by extension implement the correct logic. This base implementation provides two points:

1. if the player and city that triggered the event match with the ones listed to by this instance the ship is set on this instance
2. Then the execute() method is called and if it returns true this instance is unregistered from the event bus. Otherwise the ship is set to null.

Parameters:

event - for the ship entering the port

execute

public abstract boolean execute()

Execute an action.

Returns:

flag indicating if the execution was successful and therefor the event listener can be removed.

getShip

public INavigableVessel getShip()

The ship that has arrived. The ship value is set in the handleShipEntersPort(ShipEntersPortEvent) method.

Returns:

vessel that arrived.