Parcel

java.lang.Object
- game.Parcel

All Implemented Interfaces:

BoardElement, Colorable, UserData, org.json.JSONString
```
public class Parcel
extends java.lang.Object
implements BoardElement
```
Class Parcel represents a carriable and deliverable package in the game. Each Parcel has a start location and a destination. When dropped off at its desired destination, the parcel disappears from the game and the player is awarded points. If the parcel matches colors with the Truck carrying it, the point award for delivery is higher

Only one truck can carry a parcel at a time, each truck can carry a maximum of one parcel.

Author:

MPatashnik

Field Summary

Fields
Modifier and Type Field and Description

Node destination
The node where this parcel is to be delivered.

Node start
The node on which this this parcel started.
- 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
`Node`	`destination` The node where this parcel is to be delivered.
`Node`	`start` The node on which this this parcel started.

Method Summary

Methods
Modifier and Type	Method and Description
`Board`	`getBoard()` Return the board on which this Parcel belongs.
`Circle`	`getCircle()` Return the circle that represents this Parcel on the GUI
`java.awt.Color`	`getColor()` Return the color of this Parcel.
`Node`	`getLocation()` Return the current location for this Parcel
`java.lang.String`	`getMappedName()` Return an empty string --Parcels do not have mapped names.
`int`	`getRelativeX()` Return 0, since Parcels have no mapped name.
`int`	`getRelativeY()` Return the y coordinate of this Object's string drawing relative to the object.
`java.lang.Object`	`getUserData()` Return the userData stored in this Node (may be null).
`boolean`	`isColorSignificant()` Return true - the color of Parcels is significant
`boolean`	`isHeld()` Returns true iff some truck currently holds this Parcel.
`boolean`	`isTruckHere(Truck t)` Return true iff t currently holds this Parcel.
`void`	`setUserData(java.lang.Object uData)` Set the userData to uData.
`java.lang.String`	`toJSONString()` Return this parcel's start location and its color for JSON string.
`int`	`trucksHere()` Return 1 if a truck is currently holding this Parcel, 0 otherwise
`void`	`updateGUILocation(int x, int y)` Update the circle position to (x, y).

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

- Field Detail
  - start
```
public final Node start
```
    The node on which this this parcel started.
  - destination
```
public final Node destination
```
    The node where this parcel is to be delivered.
- Method Detail
  - getBoard
```
public Board getBoard()
```
    Return the board on which this Parcel belongs.
    
    Specified by:
    
    getBoard in interface BoardElement
  - getLocation
```
public Node getLocation()
```
    Return the current location for this Parcel
  - getColor
```
public java.awt.Color getColor()
```
    Return the color of this Parcel. Because the color of a parcel has game significance, it will not be changed after the game starts running.
    
    Specified by:
    
    getColor in interface Colorable
  - isColorSignificant
```
public boolean isColorSignificant()
```
    Return true - the color of Parcels is significant
    
    Specified by:
    
    isColorSignificant in interface Colorable
  - 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 userData to uData. To erase the current userData, use argument null).
    
    Specified by:
    
    setUserData in interface UserData
  - getCircle
```
public Circle getCircle()
```
    Return the circle that represents this Parcel on the GUI
  - getMappedName
```
public java.lang.String getMappedName()
```
    Return an empty string --Parcels do not have mapped names.
    
    Specified by:
    
    getMappedName in interface BoardElement
  - toJSONString
```
public java.lang.String toJSONString()
```
    Return this parcel's start location and its color for JSON string.
    
    Specified by:
    
    toJSONString in interface org.json.JSONString
    
    Returns:
    A strictly syntactically correct JSON text.
  - getRelativeX
```
public int getRelativeX()
```
    Return 0, since Parcels have no mapped name.
    
    Specified by:
    
    getRelativeX in interface BoardElement
  - getRelativeY
```
public int getRelativeY()
```
    Description copied from interface: BoardElement
    
    Return the y coordinate of this Object's string drawing relative to the object.
    
    Specified by:
    
    getRelativeY in interface BoardElement
  - isTruckHere
```
public boolean isTruckHere(Truck t)
```
    Return true iff t currently holds this Parcel.
    
    Specified by:
    
    isTruckHere in interface BoardElement
  - isHeld
```
public boolean isHeld()
```
    Returns true iff some truck currently holds this Parcel.
  - trucksHere
```
public int trucksHere()
```
    Return 1 if a truck is currently holding this Parcel, 0 otherwise
    
    Specified by:
    
    trucksHere in interface BoardElement
  - updateGUILocation
```
public void updateGUILocation(int x,
                     int y)
```
    Update the circle position to (x, y). Relies on the circle for painting. Parcels have no dependents
    
    Specified by:
    
    updateGUILocation in interface BoardElement

Class Parcel

Field Summary

Fields inherited from interface game.BoardElement

Method Summary

Methods inherited from class java.lang.Object

Field Detail

start

destination

Method Detail

getBoard

getLocation

getColor

isColorSignificant

getUserData

setUserData

getCircle

getMappedName

toJSONString

getRelativeX

getRelativeY

isTruckHere

isHeld

trucksHere

updateGUILocation