Updated design decision file in doc.

#fix #story[6]

doc/design_decisions.md

@@ -1,2 +1,16 @@
 # Design Decisions
+- Code structure
+
+App creates a race instance which can:
+instantiate a file parser to extract race setting and team information;
+creates and passes legs and teams/boats into event generator to create events;
+runs a race and iterates all events that returned from the generator;
+prints out event details, including time, involved boats and legs.
+
+- Configuration file
+
+We decided to store the team information including team names and boat velocity, as well as race configuration setting in external file.
+
+To read external files, "Json-simple" library has been used to parse information. 
+By using this library, we did not have to write our json parser and benefited from the flexibility of json files.
 

doc/examples/config.json

@@ -1,13 +1,31 @@
 {
   "race-name": "AC35",
-  "time-scale": 1.0,
-  "race-size": 4,
+  "time-scale": 2.0,
+  "race-size": 6,
   "teams": [
-    {"team-name": "Oracle Team USA", "velocity": 20.9},
-    {"team-name": "Artemis Racing", "velocity": 18.3},
-    {"team-name": "Emirates Team New Zealand", "velocity": 21.5},
-    {"team-name": "Groupama Team France","velocity": 19.9},
-    {"team-name": "Land Rover BAR", "velocity": 17.6},
-    {"team-name": "SoftBank Team Japan", "velocity": 16.6}
+    {
+      "team-name": "Oracle Team USA",
+      "velocity": 20.9
+    },
+    {
+      "team-name": "Artemis Racing",
+      "velocity": 18.3
+    },
+    {
+      "team-name": "Emirates Team New Zealand",
+      "velocity": 21.5
+    },
+    {
+      "team-name": "Groupama Team France",
+      "velocity": 19.9
+    },
+    {
+      "team-name": "Land Rover BAR",
+      "velocity": 17.6
+    },
+    {
+      "team-name": "SoftBank Team Japan",
+      "velocity": 16.6
+    }
   ]
 }

doc/user_manual.md

@@ -1 +1,15 @@
-# User Manual
+# User Manual
+
+## Running the application
+
+When you execute the application, it will try to load a configuration file called config.json located in doc/examples/.
+
+You can specify a config file using the using the -f flag, for example 'java -jar app.jar -f doc/examples/config1.json'
+
+## The config file
+
+The teams/boats are specified in the config file under 'teams', each team requires a team name, and a velocity (in meters per second).
+
+The 'time-scale' option lets you change how long the race takes to complete. A time-scale of 1.0 is normal speed, 2.0 is 2x etc.
+
+The 'race-size' option lets you specify how many boats will be selected to compete in each race. There must be at least this many teams defined.

pom.xml

@@ -1,4 +1,4 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>seng302</groupId>
@@ -40,7 +40,8 @@
                 <version>2.4.3</version>
                 <configuration>
                     <transformers>
-                        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                        <transformer
+                                implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                             <manifestEntries>
                                 <Main-Class>seng302.App</Main-Class>
                                 <X-Compile-Source-JDK>${maven.compiler.source}</X-Compile-Source-JDK>

src/main/java/seng302/App.java

@@ -1,87 +1,111 @@
 package seng302;
 
-import java.util.*;
 import java.lang.reflect.Array;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Map;
+import java.util.Random;
+import java.io.FileNotFoundException;
 
-public class App 
-{
-	/**
-	* Builds a race object for the AC35 course
-	*/
-	public static Race createRace() throws Exception{
-		Race race = new Race();
+public class App {
 
-		// Read team names from file
-		FileParser fp = new FileParser("doc/examples/config.json");
-		ArrayList<String> boatNames = new ArrayList<>();
-		ArrayList<Map<String, Object>> teams = fp.getTeams();
+    /**
+     * Builds a race object for the AC35 course
+     *
+     * @return a Race object for the AC35 course
+     */
+    public static Race createRace(String configFile) throws Exception {
+        Race race = new Race();
+        FileParser fp;
 
-		//get race size
-		int numberOfBoats = (int) fp.getRaceSize();
+        // Read team names from file
+        try{
+            fp = new FileParser(configFile);
+        }
+        catch (FileNotFoundException e){
+            System.out.println("Config file does not exist");
+            return null;
+        }
 
-		//get time scale
-		double timeScale = fp.getTimeScale();
-		race.setTimeScale(timeScale);
+        ArrayList<String> boatNames = new ArrayList<>();
+        ArrayList<Map<String, Object>> teams = fp.getTeams();
 
-		for (Map<String, Object> team : teams) {
-			boatNames.add((String) team.get("team-name"));
-		}
+        //get race size
+        int numberOfBoats = (int) fp.getRaceSize();
 
-		// Shuffle team names
-		long seed = System.nanoTime();
-		Collections.shuffle(boatNames, new Random(seed));
+        //get time scale
+        double timeScale = fp.getTimeScale();
+        race.setTimeScale(timeScale);
 
-		if (numberOfBoats > Array.getLength(boatNames.toArray())){
-			return null;
-		}
+        for (Map<String, Object> team : teams) {
+            boatNames.add((String) team.get("team-name"));
+        }
 
-		for (int i = 0; i < numberOfBoats; i++) {
-			race.addBoat(new Boat(boatNames.get(i), (Double)(teams.get(i).get("velocity"))));
-		}
+        // Shuffle team names
+        long seed = System.nanoTime();
+        Collections.shuffle(boatNames, new Random(seed));
 
-		race.addLeg(new Leg(35, 100, "Start"));
-		race.addLeg(new Leg(10, 300, "Marker 1"));
-		race.addLeg(new Leg(350, 400, "Leeward Gate"));
-		race.addLeg(new Leg(10, 400, "Windward Gate"));
+        if (numberOfBoats > Array.getLength(boatNames.toArray())) {
+            return null;
+        }
 
-		Leg finishingLeg = new Leg(10, 400, "Leeward Gate");
-		finishingLeg.setFinishingLeg(true);
+        // Add boats to the race
+        for (int i = 0; i < numberOfBoats; i++) {
+            race.addBoat(new Boat(boatNames.get(i), (Double) (teams.get(i).get("velocity"))));
+        }
 
-		race.addLeg(finishingLeg);
+        race.addLeg(new Leg(35, 100, "Start"));
+        race.addLeg(new Leg(10, 300, "Marker 1"));
+        race.addLeg(new Leg(350, 400, "Leeward Gate"));
+        race.addLeg(new Leg(10, 400, "Windward Gate"));
 
-		return race;
-	}
+        Leg finishingLeg = new Leg(10, 400, "Leeward Gate");
+        finishingLeg.setFinishingLeg(true);
 
-    public static void main( String[] args )
-    {
-    	Race race = null;
+        race.addLeg(finishingLeg);
 
-    	try{
-    		 race = createRace();
-    	}
-    	catch (Exception e){
-    		System.out.println(e);
-    	}
+        return race;
+    }
 
-    	// If race was created
-    	if (race != null){
-    		race.displayStartingBoats();
+    public static void main(String[] args) {
+        Race race = null;
+        String raceConfigFile;
 
-    		System.out.println("\n\n");
-    		System.out.println("######################");
-    		System.out.println("# Live Race Updates   ");
-    		System.out.println("######################");
-    		race.startRace();
+        if (args.length == 2 && args[0].equals("-f")){
+            raceConfigFile = args[1];
+        }
+        else{
+            // Use default config
+            raceConfigFile = "doc/examples/config.json";
+        }
 
-    		System.out.println("\n\n");
-    		System.out.println("######################");
-    		System.out.println("# Race Results   ");
-    		System.out.println("######################");
-    		race.showRaceMarkerResults();
-	    	race.displayFinishingOrder();
-    	}
-    	else{
-    		System.out.println("There was an error creating the race.");
-    	}
+        try {
+            race = createRace(raceConfigFile);
+        } catch (Exception e) {
+            System.out.println("There was an error creating the race.");
+        }
+
+        // If race was created
+        if (race != null) {
+            race.displayStartingBoats();
+
+            System.out.println("\n\n");
+            System.out.println("######################");
+            System.out.println("# Live Race Updates   ");
+            System.out.println("######################");
+
+            race.startRace();
+
+            System.out.println("\n\n");
+            System.out.println("######################");
+            System.out.println("# Race Results   ");
+            System.out.println("######################");
+
+            race.showRaceMarkerResults();
+            race.displayFinishingOrder();
+
+        } else {
+            System.out.println("There was an error creating the race. Exiting.");
+        }
     }
 }

src/main/java/seng302/Boat.java

@@ -1,56 +1,62 @@
 package seng302;
 
 /**
-*	Represents a boat in the race.
-*
-*	@param teamName The name of the team sailing the boat
-*	@param boatVelocity The speed of the boat in meters/second
+* Represents a boat in the race.
 */
-public class Boat
-{
-	
-	private String teamName; // The name of the team, this is also the name of the boat
-	private double velocity; // In meters/second
+public class Boat {
 
-	public Boat(String teamName) {
-		this.teamName = teamName;
-		this.velocity = 10; // Default velocity
-	}
+    private String teamName; // The name of the team, this is also the name of the boat
+    private double velocity; // In meters/second
 
-	public Boat(String teamName, double boatVelocity) {
-		this.teamName = teamName;
-		this.velocity = boatVelocity;
-	}
+    public Boat(String teamName) {
+        this.teamName = teamName;
+        this.velocity = 10; // Default velocity
+    }
 
-	/**
-	*	Returns the name of the team sailing the boat
-	*	@return The name of the team 
-	*/
-	public String getTeamName(){
-		return this.teamName;
-	}
+    /**
+     * Represents a boat in the race.
+     *
+     * @param teamName     The name of the team sailing the boat
+     * @param boatVelocity The speed of the boat in meters/second
+     */
+    public Boat(String teamName, double boatVelocity) {
+        this.teamName = teamName;
+        this.velocity = boatVelocity;
+    }
 
-	/**
-	*	Sets the name of the team sailing the boat
-	*	@param teamName The name of the team
-	*/
-	public void setTeamName(String teamName){
-		this.teamName = teamName;
-	}
+    /**
+     * Returns the name of the team sailing the boat
+     *
+     * @return The name of the team
+     */
+    public String getTeamName() {
+        return this.teamName;
+    }
 
-	/**
-	 * Sets velocity of the boat
-	 * @param velocity The velocity of boat
-	 */
-	public void setVelocity(float velocity) {
-		this.velocity = velocity;
-	}
+    /**
+     * Sets the name of the team sailing the boat
+     *
+     * @param teamName The name of the team
+     */
+    public void setTeamName(String teamName) {
+        this.teamName = teamName;
+    }
 
-	/**
-	 * Gets velocity of the boat
-	 * @return a float number of the boat velocity
-	 */
-	public double getVelocity() {
-		return this.velocity;
-	}
+    /**
+     * Gets velocity of the boat
+     *
+     * @return a float number of the boat velocity
+     */
+    public double getVelocity() {
+        return this.velocity;
+    }
+
+    /**
+     * Sets velocity of the boat
+     *
+     * @param velocity The velocity of boat
+     */
+    public void setVelocity(double velocity) {
+        this.velocity = velocity;
+    }
 }

src/main/java/seng302/Event.java

@@ -4,116 +4,137 @@ import java.text.SimpleDateFormat;
 import java.util.Date;
 
 /**
- * Event class containing the time of specific event, related team/boat, and
- * event location such as leg.
- *
- * @param eventTime, what time the event happens
- * @param eventBoat, the boat that the event belongs to
- * @param eventLeg, the leg the event happens on
- */
+* Event class containing the time of specific event, related team/boat, and
+* event location such as leg.
+*/
 public class Event {
 
-	private long time;
-	private Boat boat;
-	private Leg leg;
-	private boolean isFinishingEvent = false;
+    private long time; // Time the event occurs
+    private Boat boat; 
+    private Leg leg; // Leg of the race the event occurs on
+    private boolean isFinishingEvent = false; // This event occurs when a boat finishes the race
 
-	public Event(long eventTime, Boat eventBoat, Leg eventLeg) {
-		this.time = eventTime;
-		this.boat = eventBoat;
-		this.leg = eventLeg;
-	}
+    /**
+     * Event class containing the time of specific event, related team/boat, and
+     * event location such as leg.
+     *
+     * @param eventTime, what time the event happens
+     * @param eventBoat, the boat that the event belongs to
+     * @param eventLeg,  the leg the event happens on
+     */
+    public Event(long eventTime, Boat eventBoat, Leg eventLeg) {
+        this.time = eventTime;
+        this.boat = eventBoat;
+        this.leg = eventLeg;
+    }
 
-	public Event(long eventTime, Boat eventBoat, Leg eventLeg, boolean isFinishingEvent) {
-		this.time = eventTime;
-		this.boat = eventBoat;
-		this.leg = eventLeg;
-		this.isFinishingEvent = isFinishingEvent;
-	}
+    /**
+     * Event class containing the time of specific event, related team/boat, and
+     * event location such as leg.
+     *
+     * @param eventTime, what time the event happens
+     * @param eventBoat, the boat that the event belongs to
+     * @param eventLeg,  the leg the event happens on
+     * @param isFinishingEvent,  true if this event is the boat crossing the finishing line
+     */
+    public Event(long eventTime, Boat eventBoat, Leg eventLeg, boolean isFinishingEvent) {
+        this.time = eventTime;
+        this.boat = eventBoat;
+        this.leg = eventLeg;
+        this.isFinishingEvent = isFinishingEvent;
+    }
 
-	/**
-	 * Sets the time for the event
-	 * @param eventTime the time for event in millisecond
-	 */
-	public void setTime(long eventTime) {
-		this.time = eventTime;
-	}
+    /**
+     * Gets the time for the event
+     *
+     * @return the time for event in millisecond
+     */
+    public long getTime() {
+        return this.time;
+    }
 
-	/**
-	 * Gets the time for the event
-	 * @return the time for event in millisecond
-	 */
-	public long getTime() {
-		return this.time;
-	}
+    /**
+     * Sets the time for the event
+     *
+     * @param eventTime the time for event in millisecond
+     */
+    public void setTime(long eventTime) {
+        this.time = eventTime;
+    }
 
-	/**
-	 * Gets the time in a formatted string
-	 * @return the string of time
-	 */
-	public String getTimeString() {
-		return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time));
-	}
+    /**
+     * Gets the time in a formatted string
+     *
+     * @return the string of time
+     */
+    public String getTimeString() {
+        return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time));
+    }
 
-	/**
-	 * Sets the involved boat
-	 * @param eventBoat the involved boat
-	 */
-	public void setBoat(Boat eventBoat) {
-		this.boat = eventBoat;
-	}
+    /**
+     * Gets the involved boat
+     *
+     * @return the boat involved in the event
+     */
+    public Boat getBoat() {
+        return this.boat;
+    }
 
-	/**
-	 * Gets the involved boat
-	 * @return the boat involved in the event
-	 */
-	public Boat getBoat() {
-		return this.boat;
-	}
+    /**
+     * Sets the involved boat
+     *
+     * @param eventBoat the involved boat
+     */
+    public void setBoat(Boat eventBoat) {
+        this.boat = eventBoat;
+    }
 
-	/**
-	 * Sets the involved location/leg
-	 * @param eventLeg the involved leg
-	 */
-	public void setLeg(Leg eventLeg) {
-		this.leg = eventLeg;
-	}
+    /**
+     * Gets the involved location/leg
+     *
+     * @return the leg involved in the event
+     */
+    public Leg getLeg() {
+        return this.leg;
+    }
 
-	/**
-	 * Gets the involved location/leg
-	 * @return the leg involved in the event
-	 */
-	public Leg getLeg() {
-		return this.leg;
-	}
+    /**
+     * Sets the involved location/leg
+     *
+     * @param eventLeg the involved leg
+     */
+    public void setLeg(Leg eventLeg) {
+        this.leg = eventLeg;
+    }
 
-	/**
-	* Call when the boat reaches the marker, this will tell the marker the order
-	* in which boats pass it
-	*/
-	public void addBoatToMarker(){
-		this.leg.addBoatToMarker(boat);
-	}
+    /**
+     * Called when the boat in this event passes
+     * the marker.
+     */
+    public void boatPassedMarker() {
+        this.leg.addBoatToMarker(boat);
+    }
 
-	/**
-	* Returns true if this event is the boat finishing the race
-	*
-	*/
-	public boolean getIsFinishingEvent(){
-		return this.isFinishingEvent;
-	}
+    /**
+     * Returns true if this event is the boat finishing the race
+     */
+    public boolean getIsFinishingEvent() {
+        return this.isFinishingEvent;
+    }
 
-	/**
-	* Get a string that contains the timestamp and course information for this event
-	* @return A string that contains the timestamp and course information for this event
-	*/
-	public String getEventString(){
-		String currentHeading = Integer.toString(this.getLeg().getHeading());
+    /**
+     * Get a string that contains the timestamp and course information for this event
+     *
+     * @return A string that details what happened in this event
+     */
+    public String getEventString() {
+        String currentHeading = Integer.toString(this.getLeg().getHeading());
 
-		if (this.isFinishingEvent){
-			return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " finished the race");
-		}
+        // This event is a boat finishing the race
+        if (this.isFinishingEvent) {
+            return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " finished the race");
+        }
 
-		return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " passed " + this.getLeg().getMarkerLabel() + " going heading " + currentHeading + "°");
-	}
+        return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " passed " + this.getLeg().getMarkerLabel() + " going heading " + currentHeading + "°");
+    }
 }

src/main/java/seng302/FileParser.java

@@ -4,9 +4,9 @@ import org.json.simple.JSONObject;
 import org.json.simple.parser.JSONParser;
 import org.json.simple.parser.ParseException;
 
+import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.IOException;
-import java.io.FileNotFoundException;
 import java.util.ArrayList;
 import java.util.Map;
 
@@ -18,108 +18,115 @@ import java.util.Map;
 
 public class FileParser {
 
-	private String filePath;
-	private JSONObject content;
-	/** used to construct an instance of file parser
-	 *
-	 * @param filePath a string like path to show location of desired file to
-	 *                 be parsed
-	 */
-	public FileParser(String filePath) throws Exception {
-		this.filePath = filePath;
-		this.readFile();
-	}
+    private String filePath;
+    private JSONObject content;
 
-	/**
-	 * Reads content from a given file, and return the content as JSONObject.
-	 * Throws FileNotFoundException, if the given file cannot be found.
-	 */
-	private void readFile() throws FileNotFoundException{
-		JSONParser parser = new JSONParser();
-		try {
-			this.content = (JSONObject) parser.parse(new FileReader(filePath));
+    /**
+     * used to construct an instance of file parser
+     *
+     * @param filePath a string like path to show location of desired file to
+     *                 be parsed
+     */
+    public FileParser(String filePath) throws Exception {
+        this.filePath = filePath;
+        this.readFile();
+    }
 
-		} catch (FileNotFoundException e) {
-			throw e;
-		} catch (IOException e) {
-			e.printStackTrace();
-		} catch (ParseException e) {
-			e.printStackTrace();
-		}
-	}
+    /**
+     * Reads content from a given file, and return the content as JSONObject.
+     * Throws FileNotFoundException, if the given file cannot be found.
+     */
+    private void readFile() throws FileNotFoundException {
+        JSONParser parser = new JSONParser();
+        try {
+            this.content = (JSONObject) parser.parse(new FileReader(filePath));
 
-	/**
-	 * Gets time scale setting parameter.
-	 * @return long time scale. -1 if parameter is invalid (eg. scale is
-	 * negative number, or containing non numeric character) or cannot be found.
-	 */
-	@SuppressWarnings("unchecked")
-	public double getTimeScale() {
-		try {
-			double timeScale = (double) this.content.get("time-scale");
-			return timeScale >= 0 ? timeScale : -1;
-		} catch (Exception e) {
-			e.printStackTrace();
-			return 1;
-		}
-	}
+        } catch (FileNotFoundException e) {
+            throw e;
+        } catch (IOException e) {
+            e.printStackTrace();
+        } catch (ParseException e) {
+            e.printStackTrace();
+        }
+    }
 
-	/**
-	 * Gets race name in the setting file.
-	 * @return a string of race name. null if race name is invalid or cannot
-	 * be found.
-	 */
-	@SuppressWarnings("unchecked")
-	public String getRaceName() {
-		try {
-			return (String) this.content.get("race-name");
-		} catch (Exception e) {
-			return null;
-		}
-	}
+    /**
+     * Gets time scale setting parameter.
+     *
+     * @return long time scale. -1 if parameter is invalid (eg. scale is
+     * negative number, or containing non numeric character) or cannot be found.
+     */
+    @SuppressWarnings("unchecked")
+    public double getTimeScale() {
+        try {
+            double timeScale = (double) this.content.get("time-scale");
+            return timeScale >= 0 ? timeScale : -1;
+        } catch (Exception e) {
+            e.printStackTrace();
+            return 1;
+        }
+    }
 
-	/**
-	 * Gets an array of teams who participate the race.
-	 * @return an ArrayList containing strings of team names. null if teams
-	 * setting is invalid or there is no team.
-	 */
-	@SuppressWarnings("unchecked")
-	public ArrayList<Map<String, Object>> getTeams() {
-		try {
-			return (ArrayList<Map<String, Object>>) this.content.get("teams");
-		} catch (Exception e) {
-			return null;
-		}
-	}
+    /**
+     * Gets race name in the setting file.
+     *
+     * @return a string of race name. null if race name is invalid or cannot
+     * be found.
+     */
+    @SuppressWarnings("unchecked")
+    public String getRaceName() {
+        try {
+            return (String) this.content.get("race-name");
+        } catch (Exception e) {
+            return null;
+        }
+    }
 
-	/**
-	 * Gets the total number of teams.
-	 * @return the number of teams. 0 if no teams or anything goes wrong.
-	 */
-	@SuppressWarnings("unchecked")
-	public long getTotalNumberOfTeams() {
-		ArrayList<Map<String, Object>> teams = getTeams();
-		try {
-			return teams.size();
-		} catch (Exception e) {
-			return 0;
-		}
-	}
+    /**
+     * Gets an array of teams who participate the race.
+     *
+     * @return an ArrayList containing strings of team names. null if teams
+     * setting is invalid or there is no team.
+     */
+    @SuppressWarnings("unchecked")
+    public ArrayList<Map<String, Object>> getTeams() {
+        try {
+            return (ArrayList<Map<String, Object>>) this.content.get("teams");
+        } catch (Exception e) {
+            return null;
+        }
+    }
 
-	/**
-	 * Gets the number of boats that would compete during a race. Returns the
-	 * total number of race size if parameter is invalid or cannot be found.
-	 * @return an int of the race size.
-	 */
-	@SuppressWarnings("unchecked")
-	public long getRaceSize() {
-		long totalTeams = this.getTotalNumberOfTeams();
-		try {
-			long raceSize = (long) this.content.get("race-size");
-			return raceSize >= 0 && raceSize <= totalTeams? raceSize : totalTeams;
-		} catch (Exception e) {
-			e.printStackTrace();
-			return totalTeams;
-		}
-	}
+    /**
+     * Gets the total number of teams.
+     *
+     * @return the number of teams. 0 if no teams or anything goes wrong.
+     */
+    @SuppressWarnings("unchecked")
+    public long getTotalNumberOfTeams() {
+        ArrayList<Map<String, Object>> teams = getTeams();
+        try {
+            return teams.size();
+        } catch (Exception e) {
+            return 0;
+        }
+    }
+
+    /**
+     * Gets the number of boats that would compete during a race. Returns the
+     * total number of race size if parameter is invalid or cannot be found.
+     *
+     * @return an int of the race size.
+     */
+    @SuppressWarnings("unchecked")
+    public long getRaceSize() {
+        long totalTeams = this.getTotalNumberOfTeams();
+        try {
+            long raceSize = (long) this.content.get("race-size");
+            return raceSize >= 0 && raceSize <= totalTeams ? raceSize : totalTeams;
+        } catch (Exception e) {
+            e.printStackTrace();
+            return totalTeams;
+        }
+    }
 }

src/main/java/seng302/Leg.java

@@ -1,108 +1,112 @@
 package seng302;
 
+/**
+* Represents the leg of a race.
+*/
 public class Leg {
-	private int heading;
-	private int distance;
-	private boolean isFinishingLeg;
-	private Marker startingMarker;
+    private int heading;
+    private int distance;
+    private boolean isFinishingLeg;
+    private Marker startingMarker;
 
-	/*
-		Create a new leg
+    /**
+     * Create a new leg
+     *
+     * @param heading,  the magnetic heading of this leg
+     * @param distance, the total distance of this leg in meters
+     * @param marker,   the marker this leg starts on
+     */
+    public Leg(int heading, int distance, Marker marker) {
+        this.heading = heading;
+        this.distance = distance;
+        this.startingMarker = marker;
+        this.isFinishingLeg = false;
+    }
 
-		@param heading, the magnetic heading of this leg
-		@param distance, the total distance of this leg in meters
-		@param marker, the marker this leg starts on
-	*/
-	public Leg(int heading, int distance, Marker marker){
-		this.heading = heading;
-		this.distance = distance;
-		this.startingMarker = marker;
-		this.isFinishingLeg = false;
-	}
+    /**
+     * Create a new leg
+     *
+     * @param heading,    the magnetic heading of this leg
+     * @param distance,   the total distance of this leg in meters
+     * @param markerName, the name of the marker this leg starts on
+     */
+    public Leg(int heading, int distance, String markerName) {
+        this.heading = heading;
+        this.distance = distance;
+        this.startingMarker = new Marker(markerName);
+        this.isFinishingLeg = false;
+    }
 
-	/*
-		Create a new leg
+    /**
+     * Get the heading of this leg
+     */
+    public int getHeading() {
+        return this.heading;
+    }
 
-		@param heading, the magnetic heading of this leg
-		@param distance, the total distance of this leg in meters
-		@param markerName, the name of the marker this leg starts on
-	*/
-	public Leg(int heading, int distance, String markerName){
-		this.heading = heading;
-		this.distance = distance;
-		this.startingMarker = new Marker(markerName);
-		this.isFinishingLeg = false;
-	}
+    /**
+     * Set the heading for this leg
+     */
+    public void setHeading(int heading) {
+        this.heading = heading;
+    }
 
-	/*
-		Set the heading for this leg
-	*/
-	public void setHeading(int heading){
-		this.heading = heading;
-	}
+    /**
+     * Get the total distance of this leg in meters
+     */
+    public int getDistance() {
+        return this.distance;
+    }
 
-	/*
-		Get the heading of this leg
-	*/
-	public int getHeading(){
-		return this.heading;
-	}
+    /**
+     * Set the distance of this leg in meters
+     */
+    public void setDistance(int distance) {
+        this.distance = distance;
+    }
 
-	/*
-		Set the distance of this leg in meters
-	*/
-	public void setDistance(int distance){
-		this.distance = distance;
-	}
+    /**
+     * Returns the marker this leg started on
+     */
+    public Marker getMarker() {
+        return this.startingMarker;
+    }
 
-	/* 
-		Get the total distance of this leg in meters
-	*/
-	public int getDistance(){
-		return this.distance;
-	}
+    /**
+     * Set the marker this leg starts on
+     */
+    public void setMarker(Marker marker) {
+        this.startingMarker = marker;
+    }
 
-	/*
-		Set the marker this leg starts on
-	*/
-	public void setMarker(Marker marker){
-		this.startingMarker = marker;
-	}
+    /**
+     * Returns the name of the marker this leg started on
+     */
+    public String getMarkerLabel() {
+        return this.startingMarker.getName();
+    }
 
-	/*
-		Returns the marker this leg started on
-	*/
-	public Marker getMarker(){
-		return this.startingMarker;
-	}
+    /**
+     * Tell the marker that the boat has passed it
+     */
+    public void addBoatToMarker(Boat boat) {
+        this.startingMarker.addBoat(boat);
+    }
 
-	/*
-		Returns the name of the marker this leg started on
-	*/
-	public String getMarkerLabel(){
-		return this.startingMarker.getName();
-	}
+    /**
+     * Specify whether or not the race finishes on this leg
+     *
+     * @param isFinishingLeg whether or not the race finishes on this leg
+     */
+    public void setFinishingLeg(boolean isFinishingLeg) {
+        this.isFinishingLeg = isFinishingLeg;
+    }
 
-	/*
-		Tell the marker that the boat has passed it
-	*/
-	public void addBoatToMarker(Boat boat){
-		this.startingMarker.addBoat(boat);
-	}
-
-	/*
-		Specify whether or not the race finishes on this leg
-
-		@param isFinishingLeg whether or not the race finishes on this leg
-	*/
-	public void setFinishingLeg(boolean isFinishingLeg){
-		this.isFinishingLeg = isFinishingLeg;
-	}
-
-	/*
-		@returns true if this the race finishes after this leg
-	*/
-	public boolean getIsFinishingLeg(){
-		return this.isFinishingLeg;
-	}
+    /**
+     * Returns whether or not the race finishes after this leg
+     * @return true if this the race finishes after this leg
+     */
+    public boolean getIsFinishingLeg() {
+        return this.isFinishingLeg;
+    }
 }

src/main/java/seng302/Marker.java

@@ -2,9 +2,12 @@ package seng302;
 
 import java.util.ArrayList;
 
+/**
+* Represents the marker at the beginning of a leg
+*/
 class Marker{
-	private String name;
-	private ArrayList<Boat> boatOrder;
+    private String name;
+    private ArrayList<Boat> boatOrder;
 
 	/**
 	* Represents the marker at the beginning of a leg

src/main/java/seng302/Race.java

@@ -1,246 +1,249 @@
 package seng302;
 
-import java.util.*;
 import java.lang.reflect.Array;
-import java.util.concurrent.TimeUnit;
+import java.util.*;
 
+/**
+* Race class containing the boats and legs in the race
+*/
 public class Race {
-	private ArrayList<Boat> boats; // The boats in the race
-	private ArrayList<Leg> legs; // The legs in the race
-	private ArrayList<Boat> finishingOrder; // The order in which the boats finish the race
-	private PriorityQueue<Event> events; // The events that occur in the race
-	private int numberOfBoats = 0;
-	private long startTime = 0;
-	private double timeScale = 1;
+    private ArrayList<Boat> boats; // The boats in the race
+    private ArrayList<Leg> legs; // The legs in the race
+    private ArrayList<Boat> finishingOrder; // The order in which the boats finish the race
+    private PriorityQueue<Event> events; // The events that occur in the race
+    private int numberOfBoats = 0;
+    private long startTime = 0;
+    private double timeScale = 1;
 
-	public Race() {
-		this.boats = new ArrayList<Boat>();
-		this.legs = new ArrayList<Leg>();
-		this.finishingOrder = new ArrayList<Boat>();
+    /**
+    * Race class containing the boats and legs in the race
+    */
+    public Race() {
+        this.boats = new ArrayList<Boat>();
+        this.legs = new ArrayList<Leg>();
+        this.finishingOrder = new ArrayList<Boat>();
 
-		// create a priority queue with a custom Comparator to order events
-		this.events = new PriorityQueue<Event>(new Comparator<Event>() {
-			@Override
-			public int compare(Event o1, Event o2) {
-				Long time1 = o1.getTime();
-				Long time2 = o2.getTime();
+        // create a priority queue with a custom Comparator to order events
+        this.events = new PriorityQueue<Event>(new Comparator<Event>() {
+            @Override
+            public int compare(Event o1, Event o2) {
+                Long time1 = o1.getTime();
+                Long time2 = o2.getTime();
 
-				// order event asc. by time. if tie appears, then order team
-				// name alphabetically.
-				if (time1 != time2) {
-					return time1.compareTo(time2);
-				} else {
-					return o1.getBoat().getTeamName().compareTo(o2.getBoat().getTeamName());
-				}
-			}
-		});
-	}
+                // order event asc. by time. if tie appears, then order team
+                // name alphabetically.
+                if (time1 != time2) {
+                    return time1.compareTo(time2);
+                } else {
+                    return o1.getBoat().getTeamName().compareTo(o2.getBoat().getTeamName());
+                }
+            }
+        });
+    }
 
-	/*
-		Add a boat to the race
-		@param boat, the boat to add
-	*/
-	public void addBoat(Boat boat) {
-		boats.add(boat);
-		numberOfBoats += 1;
-	}
+    /**
+     * Add a boat to the race
+     *
+     * @param boat, the boat to add
+     */
+    public void addBoat(Boat boat) {
+        boats.add(boat);
+        numberOfBoats += 1;
+    }
 
-	/*
-		Returns a list of boats in a random order
+    /**
+     * Returns a list of boats in a random order
+     *
+     * @returns a list of boats
+     */
+    public Boat[] getShuffledBoats() {
+        // Shuffle the list of boats
+        long seed = System.nanoTime();
+        Collections.shuffle(this.boats, new Random(seed));
 
-		@returns a list of boats
-	*/
-	public Boat[] getShuffledBoats() {
-		// Shuffle the list of boats
-		long seed = System.nanoTime();
-		Collections.shuffle(this.boats, new Random(seed));
+        return boats.toArray(new Boat[boats.size()]);
+    }
 
-		return boats.toArray(new Boat[boats.size()]);
-	}
+    /**
+     * Returns a list of boats in the order that they
+     * finished the race (position 0 is first place)
+     *
+     * @returns a list of boats
+     */
+    public Boat[] getFinishedBoats() {
+        return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
+    }
 
-	/*
-		Returns a list of boats in the order that they
-		finished the race (position 0 is first place)
+    /**
+     * Returns the number of boats in the race
+     *
+     * @returns the number of boats in the race
+     */
+    public int getNumberOfBoats() {
+        return numberOfBoats;
+    }
 
-		@returns a list of boats
-	*/
-	public Boat[] getFinishedBoats() {
-		return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
-	}
+    /**
+     * Returns a list of boats in the race
+     *
+     * @return a list of the boats competing in the race
+     */
+    public Boat[] getBoats() {
+        return boats.toArray(new Boat[boats.size()]);
+    }
 
-	/*
-		Returns the number of boats in the race
+    /**
+     * Prints the order in which the boats finished the race
+     */
+    public void displayFinishingOrder() {
+        int numberOfBoats = this.getNumberOfBoats();
+        Boat[] boats = this.getFinishedBoats();
 
-		@returns the number of boats in the race
-	*/
-	public int getNumberOfBoats() {
-		return numberOfBoats;
-	}
+        System.out.println("--- Finishing Order ---");
 
-	/*
-		Returns a list of boats in the race
+        for (int i = 0; i < Array.getLength(boats); i++) {
+            System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
+        }
+    }
 
-		@returns a list of the boats competing in the race
-	*/
-	public Boat[] getBoats() {
-		return boats.toArray(new Boat[boats.size()]);
-	}
+    /**
+     * Prints the list of boats competing in the race
+     */
+    public void displayStartingBoats() {
+        int numberOfBoats = this.getNumberOfBoats();
+        Boat[] boats = this.getBoats();
 
-	/*
-		Prints the order in which the boats finished
-	*/
-	public void displayFinishingOrder() {
-		int numberOfBoats = this.getNumberOfBoats();
-		Boat[] boats = this.getFinishedBoats();
+        System.out.println("######################");
+        System.out.println("# Competing Boats    ");
+        System.out.println("######################");
 
-		System.out.println("\n\n");
-    		System.out.println("--- Finishing Order ---");
+        for (int i = 0; i < numberOfBoats; i++) {
+            String velocityKnots = String.format("%1.2f", boats[i].getVelocity() * 1.943844492);
 
-		for (int i = 0; i < Array.getLength(boats); i++) {
-			System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
-		}
-	}
+            System.out.println(boats[i].getTeamName() + " Velocity: " + velocityKnots + " Knots/s");
+        }
+    }
 
-	/*
-		Prints the list of boats competing in the race
-	*/
-	public void displayStartingBoats() {
-		int numberOfBoats = this.getNumberOfBoats();
-		Boat[] boats = this.getBoats();
+    /**
+     * Adds a leg to the race
+     *
+     * @param leg, the leg to add to the race
+     */
+    public void addLeg(Leg leg) {
+        this.legs.add(leg);
+    }
 
-		System.out.println("######################");
-		System.out.println("# Competing Boats    ");
-		System.out.println("######################");
+    /**
+     * Gets legs array
+     *
+     * @return an array of legs
+     */
+    public ArrayList<Leg> getLegs() {
+        return this.legs;
+    }
 
-		for (int i = 0; i < numberOfBoats; i++) {
-			String velocityKnots = String.format("%1.2f", boats[i].getVelocity() * 1.943844492);
+    /**
+     * Sets time scale 
+     *
+     * @param timeScale
+     */
+    public void setTimeScale(double timeScale) {
+        this.timeScale = timeScale;
+    }
 
-			System.out.println(boats[i].getTeamName() + " Velocity: " + velocityKnots + " knots.");
-		}
-	}
+    /**
+     * Generate all events that will happen during the race.
+     */
+    private void generateEvents() {
+        //calculate the time every boat passes each leg, and create an event
+        for (Boat boat : this.boats) {
+            long totalDistance = 0;
+            for (Leg leg : this.legs) {
+                long time = (long) (1000 * totalDistance / boat.getVelocity());
+                Event event = new Event(time, boat, leg);
+                events.add(event);
+                totalDistance += leg.getDistance();
 
-	/*
-		Adds a leg to the race
+                // If finishing leg, add another event for when the boat finishes the race
+                if (leg.getIsFinishingLeg()) {
+                    time = (long) (1000 * totalDistance / boat.getVelocity());
+                    event = new Event(time, boat, leg, true);
+                    events.add(event);
+                }
+            }
+        }
+    }
 
-		@param leg, the leg to add to the race
-	*/
-	public void addLeg(Leg leg) {
-		this.legs.add(leg);
-	}
+    /**
+     * Calculates how far a boat has travelled in meters
+     *
+     * @param velocity the velocity of boat
+     * @return a float number of distance the boat has been travelled
+     */
+    public float getDistanceTravelled(long velocity) {
+        long timeDiff = System.currentTimeMillis() - this.startTime;
+        long timeElapse = (long) (timeDiff / 1000 * this.timeScale);
+        return timeElapse * velocity;
+    }
 
-	/**
-	 * Gets legs array
-	 *
-	 * @return an array of legs
-	 */
-	public ArrayList<Leg> getLegs() {
-		return this.legs;
-	}
+    /**
+     * Iterate over events in the race and print the
+     * event string for each event
+     */
+    public void iterateEvents() {
+        // iterates all events. ends when no event in events.
+        while (!events.isEmpty()) {
+            Event peekEvent = events.peek();
+            long currentTime = (long) ((System.currentTimeMillis() - this.startTime) * this.timeScale);
 
-	/**
-	 * Sets time scale
-	 * @param timeScale
-	 */
-	public void setTimeScale(double timeScale) {
-		this.timeScale = timeScale;
-	}
+            if (currentTime > peekEvent.getTime()) {
+                Event nextEvent = events.poll();
 
-	/**
-	 * Temporary method used to generated all the events.
-	 */
-	private void generateEvents() {
+                // Display a summary of the event
+                System.out.println(nextEvent.getEventString());
+                nextEvent.boatPassedMarker();
 
-		//calculate the time for every boat passes each leg, and create an event
-		for (Boat boat : this.boats) {
-			long totalDistance = 0;
-			for (Leg leg : this.legs) {
-				long time = (long) (1000 * totalDistance / boat.getVelocity());
-				Event event = new Event(time, boat, leg);
-				events.add(event);
-				totalDistance += leg.getDistance();
+                // If event is a boat finishing the race
+                if (nextEvent.getIsFinishingEvent()) {
+                    this.finishingOrder.add(nextEvent.getBoat());
+                }
+            }
 
-				// If finishing leg, add another event for when the boat finishes the race
-				if (leg.getIsFinishingLeg()){
-					time = (long) (1000 * totalDistance / boat.getVelocity());
-					event = new Event(time, boat, leg, true);
-					events.add(event);
-				}
-			}
-		}
-	}
+            // Wait for 100ms to throttle the while loop
+            try {
+                Thread.sleep(100);
+            } catch (java.lang.InterruptedException e) {
+                continue;
+            }
+        }
+    }
 
-	/**
-	 * Note: this function is useless so far
-	 * Calculates how far a boat has travelled in meter
-	 *
-	 * @param velocity the velocity of boat
-	 * @return a float number of distance the boat has been travelled
-	 */
-	public float getDistanceTravelled(long velocity) {
-		long timeDiff = System.currentTimeMillis() - this.startTime;
-		long timeElapse = (long) (timeDiff / 1000 * this.timeScale);
-		return timeElapse * velocity;
-	}
+    /**
+     * Start the race and print each marker with the order
+     * in which the boats passed that marker
+     */
+    public void startRace() {
+        // record start time.
+        generateEvents();
+        this.startTime = System.currentTimeMillis();
+        iterateEvents();
+    }
 
-	/**
-	 * Iterate over events in the race and print the 
-	 * event string for each event
-	 */
-	public void iterateEvents() {
-		// iterates all events. ends when no event in events.
-		while (!events.isEmpty()) {
-			Event peekEvent = events.peek();
-			long currentTime = (long) ((System.currentTimeMillis() - this.startTime) * this.timeScale);
+    /**
+     * Print the order in which the boats passed each marker
+     */
+    public void showRaceMarkerResults() {
+        for (Leg leg : this.legs) {
+            Boat[] boats = leg.getMarker().getBoats();
 
-			if (currentTime > peekEvent.getTime()) {
-				// pull out the event
-				Event nextEvent = events.poll();
+            System.out.println("--- " + leg.getMarkerLabel() + " ---");
 
-				// I just simply print it out for testing
-				System.out.println(nextEvent.getEventString());
-				nextEvent.addBoatToMarker();
+            // Print the order in which the boats passed the marker
+            for (int i = 0; i < this.getNumberOfBoats(); i++) {
+                System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
+            }
 
-				if (nextEvent.getIsFinishingEvent()){
-					this.finishingOrder.add(nextEvent.getBoat());
-				}
-			}
-
-			// Wait for 100ms to slow down the while loop
-			try{
-				Thread.sleep(100);
-			}
-			catch(java.lang.InterruptedException e){
-				continue;
-			}
-		}
-	}
-
-	/*
-		Start the race and print each marker with the order
-		in which the boats passed that marker
-	*/
-	public void startRace() {
-		// record start time.
-		generateEvents();
-		this.startTime = System.currentTimeMillis();
-		iterateEvents();
-	}
-
-	/*
-		Print the order in which the boats passed each marker
-	*/
-	public void showRaceMarkerResults(){
-		for (Leg leg : this.legs) {
-			Boat[] boats = leg.getMarker().getBoats();
-
-			System.out.println("--- " + leg.getMarkerLabel() + " ---");
-
-			// Print the order in which the boats passed the marker
-			for (int i = 0; i < this.getNumberOfBoats(); i++) {
-				System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
-			}
-
-			System.out.println("");
-		}
-	}
+            System.out.println("");
+        }
+    }
 }

src/test/java/seng302/AppTest.java

@@ -1,16 +1,15 @@
 package seng302;
 
 import org.junit.Test;
+
 import static org.junit.Assert.assertTrue;
 
 /**
  * Unit test for simple App.
  */
-public class AppTest 
-{
+public class AppTest {
     @Test
-    public void testApp()
-    {
-        assertTrue( true );
+    public void testApp() {
+        assertTrue(true);
     }
 }

src/test/java/seng302/BoatTest.java

@@ -1,27 +1,34 @@
 package seng302;
 
 import org.junit.Test;
-import static org.junit.Assert.assertTrue;
+
 import static org.junit.Assert.assertEquals;
 
 /**
  * Unit test for the Team class.
  */
-public class BoatTest 
-{
+public class BoatTest {
 
     @Test
-    public void testBoatCreation()
-    {
+    public void testBoatCreation() {
         Boat boat1 = new Boat("Team 1");
         assertEquals(boat1.getTeamName(), "Team 1");
+        assertEquals(boat1.getVelocity(), (double) 10.0, 1e-15);
     }
 
     @Test
-    public void testChangeTeamName()
-    {
-    	Boat boat1 = new Boat("Team 1");
-    	boat1.setTeamName("Team 2");
-    	assertEquals(boat1.getTeamName(), "Team 2");
+    public void testChangeTeamName() {
+        Boat boat1 = new Boat("Team 1");
+        boat1.setTeamName("Team 2");
+        assertEquals(boat1.getTeamName(), "Team 2");
+    }
+
+    @Test
+    public void testSetVelocity() {
+        Boat boat1 = new Boat("Team 1", 29.0);
+        assertEquals(boat1.getVelocity(), (double) 29.0, 1e-15);
+
+        boat1.setVelocity(12.0);
+        assertEquals(boat1.getVelocity(), (double)12.0, 1e-15);
     }
 }

src/test/java/seng302/EventTest.java

@@ -1,9 +1,8 @@
 package seng302;
 
-import org.junit.Before;
 import org.junit.Test;
 
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
 
 /**
  * Test for Event class
@@ -11,11 +10,31 @@ import static org.junit.Assert.*;
  */
 public class EventTest {
 
-	@Test
-	public void getTimeString() throws Exception {
-		Leg leg = new Leg(035, 100, "Start");
-		Boat boat = new Boat("testBoat");
-		Event event = new Event(1231242, boat, leg);
-		assertEquals("20:31:242", event.getTimeString());
-	}
+    @Test
+    public void getTimeString() throws Exception {
+        Leg leg = new Leg(35, 100, "Start");
+        Boat boat = new Boat("testBoat");
+        Event event = new Event(1231242, boat, leg);
+        assertEquals("20:31:242", event.getTimeString());
+    }
+
+    /**
+    * ensure all boats are added as they pass the marker
+    */
+    @Test
+    public void boatOrderTest() throws Exception {
+        Leg leg = new Leg(35, 100, "1");
+
+        Boat boat1 = new Boat("testBoat");
+        Boat boat2 = new Boat("testBoat2");
+
+        Event event1 = new Event(1231242, boat1, leg);
+        Event event2 = new Event(1231242, boat2, leg);
+
+        event1.boatPassedMarker();
+        event2.boatPassedMarker();
+
+        assertEquals(event1.getLeg().getMarker().getBoats()[0].getTeamName(), "testBoat");
+        assertEquals(event2.getLeg().getMarker().getBoats()[1].getTeamName(), "testBoat2");
+    }
 }

src/test/java/seng302/FileParserTest.java

@@ -3,50 +3,50 @@ package seng302;
 import org.junit.Test;
 
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
 
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
 
-/** Unit test for FileParser class
+/**
+ * Unit test for FileParser class
  * Created by Haoming on 5/03/17.
  */
 public class FileParserTest {
 
-	/*
-		test if it fails from reading non existed file
-	 */
-	@Test (expected = FileNotFoundException.class)
-	public void readNonExistedFile() throws Exception {
-		FileParser fileParser = new FileParser("test/java/seng302/non-existed.json");
-	}
+    /**
+     * test if it fails from reading non existed file
+     */
+    @Test(expected = FileNotFoundException.class)
+    public void readNonExistedFile() throws Exception {
+        FileParser fileParser = new FileParser("test/java/seng302/non-existed.json");
+    }
 
-	/*
-		test a valid json file with valid content.
-	 */
-	@Test
-	public void readValidFile() throws Exception{
-		FileParser fileParser = new FileParser("src/test/java/seng302/valid.json");
+    /**
+     * test a valid json file with valid content.
+     */
+    @Test
+    public void readValidFile() throws Exception {
+        FileParser fileParser = new FileParser("src/test/java/seng302/valid.json");
 
-		assertEquals("AC35", fileParser.getRaceName());
+        assertEquals("AC35", fileParser.getRaceName());
 
-		assertEquals("Oracle Team USA", fileParser.getTeams().get(0).get("team-name"));
-		assertEquals(20.9, fileParser.getTeams().get(0).get("velocity"));
-		assertEquals(2, fileParser.getRaceSize());
-		assertEquals(6, fileParser.getTotalNumberOfTeams());
-	}
+        assertEquals("Oracle Team USA", fileParser.getTeams().get(0).get("team-name"));
+        assertEquals(20.9, fileParser.getTeams().get(0).get("velocity"));
+        assertEquals(2, fileParser.getRaceSize());
+        assertEquals(6, fileParser.getTotalNumberOfTeams());
+    }
 
-	/*
-		test an invalid json file within wrong type value and misnamed
-		variable name.
-	 */
-	@Test
-	public void readInvalidFile() throws Exception {
-		FileParser fileParser = new FileParser("src/test/java/seng302/invalid.json");
+    /**
+     * test an invalid json file within wrong type value and misnamed
+     * variable name.
+     */
+    @Test
+    public void readInvalidFile() throws Exception {
+        FileParser fileParser = new FileParser("src/test/java/seng302/invalid.json");
 
-		assertEquals(null, fileParser.getRaceName());
-		assertEquals(null, fileParser.getTeams());
-		//assertEquals(-1, fileParser.getTimeScale());
-		assertEquals(null,fileParser.getTeams());
-	}
+        assertEquals(null, fileParser.getRaceName());
+        assertEquals(null, fileParser.getTeams());
+        //assertEquals(-1, fileParser.getTimeScale());
+        assertEquals(null, fileParser.getTeams());
+    }
 
 }

src/test/java/seng302/LegTest.java

@@ -1,21 +1,20 @@
 package seng302;
 
 import org.junit.Test;
-import static org.junit.Assert.assertTrue;
+
 import static org.junit.Assert.assertEquals;
 
 /**
  * Unit test for the Leg class.
  */
-public class LegTest{
+public class LegTest {
 
-	/*
-		Test creation of the leg by specifying a string
-		for the marker label
-	*/
-	@Test
-	public void testLegCreationUsingMarkerLabel()
-    {
+    /**
+     * Test creation of the leg by specifying a string
+     * for the marker label
+     */
+    @Test
+    public void testLegCreationUsingMarkerLabel() {
         Leg leg = new Leg(010, 100, "Marker");
 
         assertEquals(leg.getHeading(), 010);
@@ -24,13 +23,12 @@ public class LegTest{
         assertEquals(leg.getIsFinishingLeg(), false);
     }
 
-    /*
-		Test creation of the leg by providing a 
-		Marker object
-	*/
+    /**
+     * Test creation of the leg by providing a
+     * Marker object
+     */
     @Test
-	public void testLegCreation()
-    {
+    public void testLegCreation() {
         Leg leg = new Leg(010, 100, new Marker("Marker"));
 
         assertEquals(leg.getHeading(), 010);
@@ -39,13 +37,12 @@ public class LegTest{
         assertEquals(leg.getIsFinishingLeg(), false);
     }
 
-    /*
-		Test changing whether or not a 
-		leg is the finishing leg
-    */
+    /**
+     * Test changing whether or not a
+     * leg is the finishing leg
+     */
     @Test
-	public void testSetFinishLeg()
-    {
+    public void testSetFinishLeg() {
         Leg leg = new Leg(010, 100, "Marker");
 
         leg.setFinishingLeg(true);

src/test/java/seng302/RaceTest.java

@@ -1,20 +1,20 @@
 package seng302;
 
 import org.junit.Test;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.assertEquals;
+
 import java.lang.reflect.Array;
 
+import static org.junit.Assert.assertEquals;
+
 /**
  * Unit test for the Race class.
  */
-public class RaceTest 
-{
-    /*
-        Test that all boats were added to the race
-    */    
+public class RaceTest {
+    /**
+     * Test that all boats were added to the race
+     */
     @Test
-    public void testAddingBoatsToRace(){
+    public void testAddingBoatsToRace() {
         Boat boat1 = new Boat("Team 1");
         Boat boat2 = new Boat("Team 2");
 
@@ -24,4 +24,16 @@ public class RaceTest
 
         assertEquals(Array.getLength(race.getBoats()), 2);
     }
+
+    @Test
+    public void testGetShuffledBoats(){
+        Boat boat1 = new Boat("Team 1");
+        Boat boat2 = new Boat("Team 2");
+
+        Race race = new Race();
+        race.addBoat(boat1);
+        race.addBoat(boat2);
+
+        assertEquals(Array.getLength(race.getShuffledBoats()), 2);
+    }
 }

src/test/java/seng302/invalid.json

@@ -1,5 +1,9 @@
 {
   "time-scale": "abc",
   "race-name": 123,
-  "teams-with-wrong-name":["team1","team2","team3"]
+  "teams-with-wrong-name": [
+    "team1",
+    "team2",
+    "team3"
+  ]
 }

src/test/java/seng302/valid.json

@@ -3,11 +3,29 @@
   "time-scale": 1,
   "race-size": 2,
   "teams": [
-    {"team-name": "Oracle Team USA", "velocity": 20.9},
-    {"team-name": "Artemis Racing", "velocity": 18.3},
-    {"team-name": "Emirates Team New Zealand", "velocity": 21.5},
-    {"team-name": "Groupama Team France","velocity": 19.9},
-    {"team-name": "Land Rover BAR", "velocity": 17.6},
-    {"team-name": "SoftBank Team Japan", "velocity": 16.6}
+    {
+      "team-name": "Oracle Team USA",
+      "velocity": 20.9
+    },
+    {
+      "team-name": "Artemis Racing",
+      "velocity": 18.3
+    },
+    {
+      "team-name": "Emirates Team New Zealand",
+      "velocity": 21.5
+    },
+    {
+      "team-name": "Groupama Team France",
+      "velocity": 19.9
+    },
+    {
+      "team-name": "Land Rover BAR",
+      "velocity": 17.6
+    },
+    {
+      "team-name": "SoftBank Team Japan",
+      "velocity": 16.6
+    }
   ]
 }