Node

java.lang.Object
- game.Node

All Implemented Interfaces:

BoardElement, Colorable, UserData, org.json.JSONString
```
public class Node
extends java.lang.Object
implements BoardElement
```
A Node (vertex) on the board of the game. Each Node maintains (1) a set of edges that exit it, (2) A hashmap of trucks, mapping to either at this node or not at this node, and (3) a set of Parcels that are on this node (and not loaded on a truck).

All methods that modify these collections are protected, but all getters are public for use by the user. Additionally, convenience methods such as isConnectedTo(Node n) are provided for user use.

Author:

MPatashnik

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String name
The name of this node.
- Fields inherited from interface game.BoardElement
  COLOR_TOKEN, DESTINATION_TOKEN, LENGTH_TOKEN, LOCATION_TOKEN, NAME_TOKEN, X_TOKEN, Y_TOKEN

Fields
Modifier and Type	Field and Description
`java.lang.String`	`name` The name of this node.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object n)` Return true iff n is a Node and is equal to this one.
`Board`	`getBoard()` Return the board on which this Node belongs.
`Circle`	`getCircle()` Return the Circle that represents this node graphically.
`java.awt.Color`	`getColor()` Return the color of this Node.
`Edge`	`getConnect(Node other)` Return the road that this node shares with node other (null if not connected).
`java.util.HashSet<Edge>`	`getExits()` Return a copy of the set of edges leaving this node.
`int`	`getExitsSize()` Return the number of exits from this node.
`java.lang.String`	`getMappedName()` Return the string that is mapped when this Node is drawn.
`java.util.HashMap<Node,java.lang.Integer>`	`getNeighbors()` Return a map of neighboring nodes to the lengths of the edges connecting them to this Node.
`java.util.HashSet<Parcel>`	`getParcels()` Return a copy of set of parcels on this Node (prevents editing the set)
`Edge`	`getRandomExit()` Return a random edge from leaving this node (its exists)
`Parcel`	`getRandomParcel()` Return a random parcel at this node.
`int`	`getRelativeX()` Return the x location that this Node's string is mapped to relative to its top right coordinate.
`int`	`getRelativeY()` Return the y location that this Node's string is mapped to relative to its top right coordinate.
`java.lang.Object`	`getUserData()` Return the userData stored in this Node.
`int`	`hashCode()` Return the hashCode of this node.
`boolean`	`isColorSignificant()` Return false - the color of Nodes is not significant
`boolean`	`isConnectedTo(Node destination)` Return false if destination.equals(this).
`boolean`	`isExit(Edge r)` Return true iff r is connected to this Node.
`boolean`	`isParcelHere()` Return true iff there is at least one parcel on this node
`boolean`	`isParcelHere(Parcel p)` Return true iff p is on this node.
`boolean`	`isTruckHere(Truck t)` Return true iff t is currently at this node.
`boolean`	`isTruckTravelingHere()` Return true iff some truck is traveling toward this node.
`void`	`setCircle(Circle c)` Set the Circle for this Node to c.
`void`	`setUserData(java.lang.Object uData)` Set the value of userData to uData.
`java.lang.String`	`toJSONString()` Return just this' name for the JSONString - relies on JSONs of Edges and parcels to take care of themselves.
`java.lang.String`	`toString()` Return the name of this Node.
`int`	`trucksHere()` Return the number of trucks at this node.
`void`	`updateGUILocation(int x, int y)` Update the circle graphic that represents this truck on the GUI.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public final java.lang.String name
```
    The name of this node. Set during construction
- Method Detail
  - getBoard
```
public Board getBoard()
```
    Return the board on which this Node belongs.
    
    Specified by:
    
    getBoard in interface BoardElement
  - getExits
```
public java.util.HashSet<Edge> getExits()
```
    Return a copy of the set of edges leaving this node. This is to prevent the addition of edges to exits without proper clearance.
  - getNeighbors
```
public java.util.HashMap<Node,java.lang.Integer> getNeighbors()
```
    Return a map of neighboring nodes to the lengths of the edges connecting them to this Node. To iterate over a HashMap, use HashMap.entrySet().
  - getRandomExit
```
public Edge getRandomExit()
```
    Return a random edge from leaving this node (its exists)
  - getExitsSize
```
public int getExitsSize()
```
    Return the number of exits from this node.
  - isExit
```
public boolean isExit(Edge r)
```
    Return true iff r is connected to this Node.
  - getParcels
```
public java.util.HashSet<Parcel> getParcels()
```
    Return a copy of set of parcels on this Node (prevents editing the set)
  - getRandomParcel
```
public Parcel getRandomParcel()
```
    Return a random parcel at this node. Precondition: at least one parcel is at this node.
  - isParcelHere
```
public boolean isParcelHere()
```
    Return true iff there is at least one parcel on this node
  - isParcelHere
```
public boolean isParcelHere(Parcel p)
```
    Return true iff p is on this node.
  - isConnectedTo
```
public boolean isConnectedTo(Node destination)
```
    Return false if destination.equals(this). Otherwise, Return true iff one of the edges in exits leads to Node destination, (this is connected to destination via a single edge).
  - getConnect
```
public Edge getConnect(Node other)
```
    Return the road that this node shares with node other (null if not connected).
  - getUserData
```
public java.lang.Object getUserData()
```
    Return the userData stored in this Node. May be null.
    
    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
  - getCircle
```
public Circle getCircle()
```
    Return the Circle that represents this node graphically.
  - setCircle
```
public void setCircle(Circle c)
```
    Set the Circle for this Node to c.
  - updateGUILocation
```
public void updateGUILocation(int x,
                     int y)
```
    Update the circle graphic that represents this truck on the GUI. Do nothing if threads is null. Also update the location of the load if this truck is carrying one.
    
    Specified by:
    
    updateGUILocation in interface BoardElement
    
    Parameters:
    x - - the new X location of this Truck in the GUI
    y - - the new Y location of this Truck in the GUI
  - equals
```
public boolean equals(java.lang.Object n)
```
    Return true iff n is a Node and is equal to this one. Two Nodes are equal if they have the same name - guaranteed to be unique within the context of a single game
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Return the hashCode of this node. Its hashCode is equal to the hashCode of its name. This is guaranteed to be unique within the context of a single game.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - isTruckHere
```
public boolean isTruckHere(Truck t)
```
    Return true iff t is currently at this node.
    
    Specified by:
    
    isTruckHere in interface BoardElement
  - trucksHere
```
public int trucksHere()
```
    Return the number of trucks at this node.
    
    Specified by:
    
    trucksHere in interface BoardElement
  - isTruckTravelingHere
```
public boolean isTruckTravelingHere()
```
    Return true iff some truck is traveling toward this node.
  - getColor
```
public java.awt.Color getColor()
```
    Return the color of this Node.
    
    Specified by:
    
    getColor in interface Colorable
  - isColorSignificant
```
public boolean isColorSignificant()
```
    Return false - the color of Nodes is not significant
    
    Specified by:
    
    isColorSignificant in interface Colorable
  - toString
```
public java.lang.String toString()
```
    Return the name of this Node.
    
    Overrides:
    
    toString in class java.lang.Object
  - getMappedName
```
public java.lang.String getMappedName()
```
    Return the string that is mapped when this Node is drawn.
    
    Specified by:
    
    getMappedName in interface BoardElement
  - getRelativeX
```
public int getRelativeX()
```
    Return the x location that this Node's string is mapped to relative to its top right coordinate.
    
    Specified by:
    
    getRelativeX in interface BoardElement
  - getRelativeY
```
public int getRelativeY()
```
    Return the y location that this Node's string is mapped to relative to its top right coordinate.
    
    Specified by:
    
    getRelativeY in interface BoardElement
  - toJSONString
```
public java.lang.String toJSONString()
```
    Return just this' name for the JSONString - relies on JSONs of Edges and parcels to take care of themselves.
    
    Specified by:
    
    toJSONString in interface org.json.JSONString
    
    Returns:
    A strictly syntactically correct JSON text.

Class Node

Field Summary

Fields inherited from interface game.BoardElement

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

Method Detail

getBoard

getExits

getNeighbors

getRandomExit

getExitsSize

isExit

getParcels

getRandomParcel

isParcelHere

isParcelHere

isConnectedTo

getConnect

getUserData

setUserData

getCircle

setCircle

updateGUILocation

equals

hashCode

isTruckHere

trucksHere

isTruckTravelingHere

getColor

isColorSignificant

toString

getMappedName

getRelativeX

getRelativeY

toJSONString