com.swath.event

Class ShipDockedAtPort

java.lang.Object

com.swath.event.ShipDockedAtPort

All Implemented Interfaces:

EventIfc

public final class ShipDockedAtPort
extends java.lang.Object

The ShipDockedAtPort event.
Posted: When a ship docks at a port.

Since:

SWATH 1.7

See Also:

ShipLeftSector

Method Summary

Modifier and Type	Method and Description
boolean	atStarDock() Indicates if the ship docked at the StarDock or not.
java.lang.String	getClassName() Gets the event class name.
int	getSector() Gets the sector where the ship docked at the port.
Ship	getShip() Gets the ship that docked.
Trader	getTrader() Gets the trader that docked.
boolean	isEventClass(java.lang.Class eventClass) Indicates if this event matches a given event class.
boolean	isUserDefined() Indicates if this event is user defined or not.

Methods inherited from class java.lang.Object

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

Method Detail

getTrader

public Trader getTrader()

Gets the trader that docked.

Returns:

The trader.

Since:

SWATH 1.7

getShip

public Ship getShip()

Gets the ship that docked.

Returns:

The ship or null if not known.

Since:

SWATH 1.7

getSector

public int getSector()

Gets the sector where the ship docked at the port.

Returns:

The sector number.

Since:

SWATH 1.7

atStarDock

public boolean atStarDock()

Indicates if the ship docked at the StarDock or not.

Returns:

true if docked at StarDock, otherwise false.

Since:

SWATH 1.7

isEventClass

public final boolean isEventClass(java.lang.Class eventClass)

Description copied from interface: EventIfc

Indicates if this event matches a given event class.

Specified by:

isEventClass in interface EventIfc

Parameters:

eventClass - The event class.

Returns:

true if this event is of the same class, otherwise false.

isUserDefined

public final boolean isUserDefined()

Description copied from interface: EventIfc

Indicates if this event is user defined or not.

Specified by:

isUserDefined in interface EventIfc

Returns:

true if user defined, otherwise false.

getClassName

public final java.lang.String getClassName()

Description copied from interface: EventIfc

Gets the event class name.

Specified by:

getClassName in interface EventIfc

Returns:

The class name.