game

Class Edge

java.lang.Object

game.Edge

All Implemented Interfaces:

BoardElement, Colorable, UserData, org.json.JSONString

public class Edge
extends java.lang.Object
implements BoardElement

Class Edge in ShippingGame allows creation of the connections between Nodes along which Trucks can travel. Each Edge is bidirectional and is connected to exactly two Nodes. Functions getFirstExit() and getSecondExit() allow access to these Nodes. Each Edge is weighted (has a length), which is the amount of time (in units that are converted to milliseconds) it takes for a Truck to cross this Edge One useful method to highlight is getOther(Node), which returns the other exit of the Edge given either exit.

Class Edge implements BoardElement and is represented on the threads by an instance of class Line. This implementation requires the creation of the four BoardElement methods, which are relatively unused outside of the graphical representation of this Edge.

There are no public Edge constructors, so classes outside of the game package will not be able to construct additional Edge objects.

Author:

MPatashnik

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_LENGTH Min val an edge can have for length.
static int	DEFAULT_MIN_LENGTH Max val an edge can have for length.
int	length The length (weight) of this Edge.

Fields inherited from interface game.BoardElement

COLOR_TOKEN, DESTINATION_TOKEN, LENGTH_TOKEN, LOCATION_TOKEN, NAME_TOKEN, X_TOKEN, Y_TOKEN

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object e) Return true iff this edge and e are equal.
Board	getBoard() Return the Board to which this Edge belongs.
java.awt.Color	getColor() Return the color of this Edge, as it is painted on the GUI.
Node[]	getExits() Return a copy of the exits of this line, a new length 2 array of Nodes.
Node	getFirstExit() Return the first exit of this Edge.
Line	getLine() Return the Line that represents this edge graphically.
java.lang.String	getMappedName() Return a String to print when this object is drawn on a GUI
Node	getOther(Node n) Return the other exit that is not equal to n.
int	getRelativeX() Return the x location the boardped name of this Edge relative to the top left corner of the line
int	getRelativeY() Returns the y location the boardped name of this Edge relative to the top left corner of the line
Node	getSecondExit() Return the second exit of this Edge.
java.lang.Object	getUserData() Return the userData stored in this edge.
int	hashCode() Return the hash code for this edge.
boolean	isColorSignificant() Return false - the color of Edges is not significant
boolean	isExit(Node node) Return true iff node is one of the exits of this Edge.
boolean	isTruckHere(Truck t) Return true iff t is currently traveling this edge.
void	setUserData(java.lang.Object uData) Set the value of userData to uData.
boolean	sharesExit(Edge r) Return true iff this Edge and r share an exit.
java.lang.String	toJSONString() Return the exits and length for an edge's JSON string
java.lang.String	toString() Return a String representation of this edge: getFirstExit().name + " to " + getSecondExit().name
int	trucksHere() Return the number of trucks currently traveling this edge.
void	updateGUILocation(int x, int y) Repaint the edge (the line).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MIN_LENGTH

public static final int DEFAULT_MIN_LENGTH

Max val an edge can have for length.

See Also:

Constant Field Values

DEFAULT_MAX_LENGTH

public static final int DEFAULT_MAX_LENGTH

Min val an edge can have for length.

See Also:

Constant Field Values

length

public final int length

The length (weight) of this Edge. Uncorrelated with its graphical length on the GUI

Method Detail

getBoard

public Board getBoard()

Return the Board to which this Edge belongs.

Specified by:

getBoard in interface BoardElement

getFirstExit

public Node getFirstExit()

Return the first exit of this Edge. Which node is the first exit has no significance.

getSecondExit

public Node getSecondExit()

Return the second exit of this Edge. Which node is the second exit has no significance.

getExits

public Node[] getExits()

Return a copy of the exits of this line, a new length 2 array of Nodes. Copies the nodes into a new array to prevent interference with the exits of this node. (Setting the values of the return of this method will not alter the Edge object.)

isExit

public boolean isExit(Node node)

Return true iff node is one of the exits of this Edge.

sharesExit

public boolean sharesExit(Edge r)

Return true iff this Edge and r share an exit.

getOther

public Node getOther(Node n)

Return the other exit that is not equal to n. (Return null if n is neither of the nodes in exits.)

getLine

public Line getLine()

Return the Line that represents this edge graphically.

getUserData

public java.lang.Object getUserData()

Return the userData stored in this edge. May be null if the user has not yet given this Node userData.

Specified by:

getUserData in interface UserData

setUserData

public void setUserData(java.lang.Object uData)

Set the value of userData to uData. To erase the current userData use null as the argument.

Specified by:

setUserData in interface UserData

getColor

public java.awt.Color getColor()

Return the color of this Edge, as it is painted on the GUI. Color of edges has no game significance, so this value may be changed during gameplay.

Specified by:

getColor in interface Colorable

isColorSignificant

public boolean isColorSignificant()

Return false - the color of Edges is not significant

Specified by:

isColorSignificant in interface Colorable

equals

public boolean equals(java.lang.Object e)

Return true iff this edge and e are equal. Two Edges are equal if they have the same exits, even if they have different lengths. This ensures that only one edge connects each pair of nodes in duplicate-free collections.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Return the hash code for this edge. The hashCode is equal to the sum of the hashCodes of its first and second exit. getFirstExit().hashCode() + getSecondExit().hashCode(). Notably: This means the ordering of the exits for an edge doesn't matter for hashing

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Return a String representation of this edge: getFirstExit().name + " to " + getSecondExit().name

Overrides:

toString in class java.lang.Object

toJSONString

public java.lang.String toJSONString()

Return the exits and length for an edge's JSON string

Specified by:

toJSONString in interface org.json.JSONString

Returns:

A strictly syntactically correct JSON text.

getMappedName

public java.lang.String getMappedName()

Return a String to print when this object is drawn on a GUI

Specified by:

getMappedName in interface BoardElement

getRelativeX

public int getRelativeX()

Return the x location the boardped name of this Edge relative to the top left corner of the line

Specified by:

getRelativeX in interface BoardElement

getRelativeY

public int getRelativeY()

Returns the y location the boardped name of this Edge relative to the top left corner of the line

Specified by:

getRelativeY in interface BoardElement

isTruckHere

public boolean isTruckHere(Truck t)

Return true iff t is currently traveling this edge.

Specified by:

isTruckHere in interface BoardElement

trucksHere

public int trucksHere()

Return the number of trucks currently traveling this edge.

Specified by:

trucksHere in interface BoardElement

updateGUILocation

public void updateGUILocation(int x,
                     int y)

Repaint the edge (the line). Parameters x and y unused but are included to comply with interface.

Specified by:

updateGUILocation in interface BoardElement