shared.model.map.handlers

Class VertexHandler

java.lang.Object

shared.model.map.handlers.VertexHandler

All Implemented Interfaces:

java.io.Serializable

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

Stores and manages the vertices found in a map.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static int	INITIAL_CAPACITY
private static long	serialVersionUID
private java.util.Map<java.lang.Integer,Vertex>	verticies
private static int	Y_SHIFT

Constructor Summary

Constructors

Constructor and Description
VertexHandler() Creates a VertexHandler object.

Method Summary

Modifier and Type	Method and Description
void	ClearVillage(Coordinate point) Removes a city or settlement from the map.
boolean	ContainsVertex(Coordinate point) Determines if there is a vertex associated with the coordinate.
boolean	equals(java.lang.Object obj)
private int	GetKey(Coordinate point)
Vertex	GetVertex(Coordinate point) Gets the vertex at the specified coordinate.
java.util.Iterator<Vertex>	GetVerticies() Gets all the registered verticies.
int	hashCode()
void	SetCity(Coordinate point, CatanColor color) Adds a city to the map.
void	SetSettlement(Coordinate point, CatanColor color) Adds a settlement to the map.

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

Y_SHIFT

private static final int Y_SHIFT

See Also:

Constant Field Values

verticies

private java.util.Map<java.lang.Integer,Vertex> verticies

Constructor Detail

VertexHandler

public VertexHandler()

Creates a VertexHandler object.

Method Detail

ContainsVertex

public boolean ContainsVertex(Coordinate point)

Determines if there is a vertex associated with the coordinate.

Parameters:

point - The coordinate to check.

Returns:

True if one exists, else false.

GetVerticies

public java.util.Iterator<Vertex> GetVerticies()

Gets all the registered verticies.

Returns:

The vertex list.

GetVertex

public Vertex GetVertex(Coordinate point)
                 throws MapException

Gets the vertex at the specified coordinate.

Parameters:

point - The coordinate of the vertex.

Returns:

The assocatied vertex.

Throws:

MapException - Thrown if the vertex doesn't exist.

ClearVillage

public void ClearVillage(Coordinate point)
                  throws MapException

Removes a city or settlement from the map.

Parameters:

point - The coordinate to remove it from.

Throws:

MapException - Why the village couldn't be removed.

SetSettlement

public void SetSettlement(Coordinate point,
                          CatanColor color)
                   throws MapException

Adds a settlement to the map.

Parameters:

point - The point to add the settlement to.

color - The color of the settlement (this sounds a little racist ... don't take it out of context).

Throws:

MapException - Why the settlement couldn't be added.

SetCity

public void SetCity(Coordinate point,
                    CatanColor color)
             throws MapException

Adds a city to the map.

Parameters:

point - The point to add the city to.

color - The color of the city.

Throws:

MapException - Why the city couldn't be added.

GetKey

private int GetKey(Coordinate point)

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