Merge branch 'zuul-better-v1' into 'master'

Zuul Better V1

6 files changed, 263 insertions, 94 deletions

diff --git a/report/progression.tex b/report/progression.tex
index cef3a50..15709c5 100644
--- a/report/progression.tex
+++ b/report/progression.tex
@@ -10,20 +10,49 @@
 
 \subsection{printLocationInfo}
 
+This code duplication has been previously avoided with the printRoomInfo()
+method.
+It has been renamed to printLocationInfo(), as part of the commit e52a34789, to
+match the exercise.
+
 \subsection{getExit}
 
+The exit attributes have been made private and a getter was added in commit
+53c427ff3. A switch statement has been used instead of multiple if statements.
+
 \subsection{getExitString}
 
+This method has been added as part of commit ca65af2e2.
+
 \subsection{HashMap, setExit}
 
+Room exits are now stored in an HashMap since commit c9d890b9b. The setExits()
+method has been replaced by setExit() which takes advantages of the HashMap.
+
 \subsection{Vertical direction}
 
-\subsection{keySet}
+In commit 4145a5e8c, the getExitString() method has been modified to be able to
+print the availability of the new exits, used in the stairwell at wing 3. Due
+to the architecture of these rooms, the side exits that were previously settled
+to link them have been kept.
+
+\subsection{keySet ?}
+
+The keySet() method of the class HashMap returns a Set of the keys contained in
+the map.
 
 \subsection{getExitString ?}
 
+The getExitString() method returns a String listing the room's exits.
+To achieve that, it iterates through the exits Map's keys, that is a Set of
+Strings, appending each one to the String that it returns.
+
 \subsection{getLongDescription}
 
+The Room class now uses the previously explained getExitString() method and
+includes the getLongDescription() method that returns the full description of
+the room since commit e510b08d0.
+
 \subsection{Object diagram}
 
 \subsubsection{Changes on execution}
diff --git a/src/esieequest/Command.java b/src/esieequest/Command.java
index de6b853..fd05930 100644
--- a/src/esieequest/Command.java
+++ b/src/esieequest/Command.java
@@ -3,6 +3,17 @@ package esieequest;
 /**
  * A text command that triggers an action in the game.
  * 
+ * This class holds information about a command that was issued by the user. A
+ * command currently consists of two strings: a command word and a second word
+ * (for example, if the command was "take map", then the two strings obviously
+ * are "take" and "map").
+ * 
+ * The way this is used is: Commands are already checked for being valid command
+ * words. If the user entered an invalid command (a word that is not known) then
+ * the command word is <null>.
+ * 
+ * If the command had only one word, then the second word is <null>.
+ * 
  * @author Pacien TRAN-GIRARD
  * @author Benoit LUBRANO DI SBARAGLIONE
  * 
@@ -12,23 +23,49 @@ public class Command {
         private String aCommandWord;
         private String aSecondWord;
 
+        /**
+         * Create a command object. First and second word must be supplied, but
+         * either one (or both) can be null.
+         * 
+         * @param firstWord
+         *            The first word of the command. Null if the command was not
+         *            recognised.
+         * @param secondWord
+         *            The second word of the command.
+         */
         public Command(final String pCommandWord, final String pSecondWord) {
                 this.aCommandWord = pCommandWord;
                 this.aSecondWord = pSecondWord;
         }
 
+        /**
+         * Return the command word (the first word) of this command. If the command
+         * was not understood, the result is null.
+         * 
+         * @return The command word.
+         */
         public String getCommandWord() {
                 return this.aCommandWord;
         }
 
+        /**
+         * @return The second word of this command. Returns null if there was no
+         *         second word.
+         */
         public String getSecondWord() {
                 return this.aSecondWord;
         }
 
+        /**
+         * @return true if this command was not understood.
+         */
         public boolean isUnknown() {
                 return this.aCommandWord == null;
         }
 
+        /**
+         * @return true if the command has a second word.
+         */
         public boolean hasSecondWord() {
                 return this.aSecondWord != null;
         }
diff --git a/src/esieequest/Game.java b/src/esieequest/Game.java
index 89b7318..638c9b8 100644
--- a/src/esieequest/Game.java
+++ b/src/esieequest/Game.java
@@ -3,6 +3,10 @@ package esieequest;
 /**
  * The game engine.
  * 
+ * This class creates and initializes all the others: it creates all rooms,
+ * creates the parser and starts the game. It also evaluates and executes the
+ * commands that the parser returns.
+ * 
  * @author Pacien TRAN-GIRARD
  * @author Benoit LUBRANO DI SBARAGLIONE
  * 
@@ -12,13 +16,19 @@ public class Game {
         private Room aCurrentRoom;
         private Parser aParser;
 
+        /**
+         * Create the game and initialize its internal map.
+         */
         public Game() {
                 this.createRooms();
                 this.printWelcome();
-                this.printRoomInfo();
+                this.printLocationInfo();
                 this.play();
         }
 
+        /**
+         * Main play routine. Loops until end of play.
+         */
         private void play() {
                 aParser = new Parser();
                 boolean vFinished = false;
@@ -30,6 +40,9 @@ public class Game {
                 System.out.println("Thank you for playing. Good bye.");
         }
 
+        /**
+         * Create all the rooms and link their exits together.
+         */
         private void createRooms() {
                 // create rooms
                 Room vAmphitheaterSeat = new Room("in the amphitheater");
@@ -78,78 +91,101 @@ public class Game {
                 Room vOffscriptMovingcharacterMo = new Room("in M-O's room");
 
                 // connect rooms (N, W, S, E)
-                vAmphitheaterSeat.setExits(vAmphitheaterStage, null, null, null);
-                vAmphitheaterStage.setExits(null, vCafeteria, null, null);
-
-                vCafeteriaStreet.setExits(null, null, vCafeteria, vEsieespaceStreet);
-                vCafeteria.setExits(vCafeteriaStreet, null, null, vAmphitheaterStage);
-
-                vEsieespaceStreet.setExits(null, vCafeteria, vEsieespaceFront, vEntranceStreet);
-                vEsieespaceFront.setExits(vEsieespaceStreet, null, null, vEsieespaceEntrance);
-                vEsieespaceEntrance.setExits(vEsieespace, vEsieespaceFront, null, null);
-                vEsieespace.setExits(null, null, vEsieespaceEntrance, null);
-
-                vClubnixStreet.setExits(null, vWingStreet, vClubnixFront, null);
-                vClubnixFront.setExits(vClubnixStreet, null, null, vClubnixEntrance);
-                vClubnixEntrance.setExits(vClubnix, vClubnixFront, null, null);
-                vClubnix.setExits(null, null, vClubnixEntrance, null);
-
+                vAmphitheaterSeat.setExit("north", vAmphitheaterStage);
+                vAmphitheaterStage.setExit("west", vCafeteria);
+
+                vCafeteriaStreet.setExit("south", vCafeteria);
+                vCafeteriaStreet.setExit("east", vEsieespaceStreet);
+                vCafeteria.setExit("north", vCafeteriaStreet);
+                vCafeteria.setExit("east", vAmphitheaterStage);
+
+                vEsieespaceStreet.setExit("west", vCafeteria);
+                vEsieespaceStreet.setExit("south", vEsieespaceFront);
+                vEsieespaceStreet.setExit("east", vEntranceStreet);
+                vEsieespaceFront.setExit("north", vEsieespaceStreet);
+                vEsieespaceFront.setExit("east", vEsieespaceEntrance);
+                vEsieespaceEntrance.setExit("north", vEsieespace);
+                vEsieespaceEntrance.setExit("west", vEsieespaceFront);
+                vEsieespace.setExit("south", vEsieespaceEntrance);