shared.model.map.handlers

Class PortHandler

java.lang.Object

shared.model.map.handlers.PortHandler

All Implemented Interfaces:

java.io.Serializable

public class PortHandler
extends java.lang.Object
implements java.io.Serializable

Handles information regarding ports.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<Coordinate,Hex>	cPorts
private java.util.Map<Edge,Hex>	ePorts
private static int	INITIAL_CAPACITY
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PortHandler() Creates a PortHandler object.

Method Summary

Modifier and Type	Method and Description
void	AddPort(PortType type, Edge edge, Hex hex) Adds a port to a hex.
boolean	ContainsPort(Coordinate vertex) Determines if there is a port at the requested vertex.
boolean	equals(java.lang.Object obj)
PortType	GetPort(Coordinate vertex) Gets the port at the specified vertex.
java.util.Iterator<java.util.Map.Entry<Edge,Hex>>	GetPorts() Gets all the available ports.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

INITIAL_CAPACITY

private static final int INITIAL_CAPACITY

See Also:

Constant Field Values

ePorts

private java.util.Map<Edge,Hex> ePorts

cPorts

private java.util.Map<Coordinate,Hex> cPorts

Constructor Detail

PortHandler

public PortHandler()

Creates a PortHandler object.

Method Detail

AddPort

public void AddPort(PortType type,
                    Edge edge,
                    Hex hex)
             throws MapException

Adds a port to a hex. The hex must be a water tile.

Parameters:

type - The type of port being added.

edge - The edge the port is on.

hex - The hex the port is on.

Throws:

MapException - Don't add ports to dry land unless you wan't this exception.

ContainsPort

public boolean ContainsPort(Coordinate vertex)

Determines if there is a port at the requested vertex.

Parameters:

vertex - The vertex coordinate.

Returns:

True if yes, else false.

GetPort

public PortType GetPort(Coordinate vertex)
                 throws MapException

Gets the port at the specified vertex.

Parameters:

vertex - The desired vertex.

Returns:

The port type of the vertex.

Throws:

MapException - Thrown if there isn't a port at the vertex.

GetPorts

public java.util.Iterator<java.util.Map.Entry<Edge,Hex>> GetPorts()

Gets all the available ports.

Returns:

An iterator to the ports.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object