shared.model.map.objects

Class Hex

java.lang.Object

shared.model.map.objects.Hex

All Implemented Interfaces:

java.io.Serializable

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

Used to store information about a Hex.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Coordinate	point
private PortType	port
private static long	serialVersionUID
private HexType	type

Constructor Summary

Constructors

Constructor and Description
Hex(HexType type, Coordinate point) Creates a hex object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Coordinate	getBottomLeftCoordinate() Gets the coordinate of the bottom left point.
Coordinate	getBottomRightCoordinate() Gets the coordinate of the bottom right point.
Coordinate	getLeftCoordinate() Gets the coordinate of the left point.
Coordinate	getPoint()
PortType	getPort()
Coordinate	getRightCoordinate() Gets the coordinate of the right point (opposed to the wrong one?...)
Coordinate	getTopLeftCoordinate() Gets the coordinate of the top left point.
Coordinate	getTopRightCoordinate() Gets the coordinate of the top right point.
HexType	getType()
int	hashCode()
void	setPort(PortType port)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

type

private HexType type

point

private Coordinate point

port

private PortType port

Constructor Detail

Hex

public Hex(HexType type,
           Coordinate point)

Creates a hex object.

Parameters:

type - The resource type of the hex.

point - The coordinate of the hex.

Method Detail

getType

public HexType getType()

Returns:

the type

getPoint

public Coordinate getPoint()

Returns:

the point

getTopLeftCoordinate

public Coordinate getTopLeftCoordinate()

Gets the coordinate of the top left point.

Returns:

The point.

getLeftCoordinate

public Coordinate getLeftCoordinate()

Gets the coordinate of the left point.

Returns:

The point.

getBottomLeftCoordinate

public Coordinate getBottomLeftCoordinate()

Gets the coordinate of the bottom left point.

Returns:

The point.

getTopRightCoordinate

public Coordinate getTopRightCoordinate()

Gets the coordinate of the top right point.

Returns:

The point.

getRightCoordinate

public Coordinate getRightCoordinate()

Gets the coordinate of the right point (opposed to the wrong one?...)

Returns:

The point.

getBottomRightCoordinate

public Coordinate getBottomRightCoordinate()

Gets the coordinate of the bottom right point.

Returns:

The point.

getPort

public PortType getPort()

Returns:

the port

setPort

public void setPort(PortType port)
             throws MapException

Parameters:

port - the port to set

Throws:

MapException - Thrown when a port can't be added to the hex.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object