shared.model.map.handlers

Class EdgeHandler

java.lang.Object

shared.model.map.handlers.EdgeHandler

All Implemented Interfaces:

java.io.Serializable

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

Stores and manages the edges contained in a map.

Author:

Jonathan Sadler

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EdgeHandler() Creates a EdgeHandler object.

Method Summary

Modifier and Type	Method and Description
void	AddRoad(Coordinate p1, Coordinate p2, CatanColor color) Adds a road to the map.
void	ClearRoad(Coordinate p1, Coordinate p2) Removes a road from the map.
private int	ComputeKey(Coordinate p1, Coordinate p2)
java.lang.Boolean	ContainsEdge(Coordinate p1, Coordinate p2) Determines if an edge exists.
boolean	equals(java.lang.Object obj)
java.util.Iterator<Edge>	GetAllEdges() Returns all the edges
Edge	GetEdge(Coordinate p1, Coordinate p2) Returns the edge between the provided end points.
private int	GetKey(Coordinate p1, Coordinate p2)
int	hashCode()
private boolean	ReverseOrder(Coordinate p1, Coordinate p2)

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

edges

private java.util.Map<java.lang.Integer,Edge> edges

Constructor Detail

EdgeHandler

public EdgeHandler()

Creates a EdgeHandler object.

Method Detail

ContainsEdge

public java.lang.Boolean ContainsEdge(Coordinate p1,
                                      Coordinate p2)

Determines if an edge exists. Point order doesn't matter.

Parameters:

p1 - The coordinate of the first end point.

p2 - The coordinate of the second end point.

Returns:

True if the edge exists, else false.

GetEdge

public Edge GetEdge(Coordinate p1,
                    Coordinate p2)
             throws MapException

Returns the edge between the provided end points. Point order doesn't matter.

Parameters:

p1 - The coordinate of the first end point.

p2 - The coordinate of the second end point.

Returns:

The associated edge.

Throws:

MapException - Thrown if the edge isn't found

GetAllEdges

public java.util.Iterator<Edge> GetAllEdges()

Returns all the edges

Returns:

The edges. 'Nuff said.

AddRoad

public void AddRoad(Coordinate p1,
                    Coordinate p2,
                    CatanColor color)
             throws MapException

Adds a road to the map.

Parameters:

p1 - The start of the road.

p2 - The end of the road.

color - The color of the road.

Throws:

MapException - Why the road couldn't be built.

ClearRoad

public void ClearRoad(Coordinate p1,
                      Coordinate p2)
               throws MapException

Removes a road from the map.

Parameters:

p1 - The start of the road.

p2 - The end of the road.

Throws:

MapException - Why the road couldn't be removed.

GetKey

private int GetKey(Coordinate p1,
                   Coordinate p2)

ReverseOrder

private boolean ReverseOrder(Coordinate p1,
                             Coordinate p2)

ComputeKey

private int ComputeKey(Coordinate p1,
                       Coordinate p2)

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