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

Zuul Better V2

5 files changed, 210 insertions, 165 deletions

diff --git a/report/progression.tex b/report/progression.tex
index 2f25aea..da5e34e 100644
--- a/report/progression.tex
+++ b/report/progression.tex
@@ -73,16 +73,42 @@ The eat command has been added with the commit 40b9b4816.
 
 \subsection{showAll, showCommands}
 
+This modifications are part of the commit 79d33230b.
+
 \subsection{Adding commands}
 
+Adding new commands would not require modifying the printHelp() method anymore.
+However, adding new commands and related functions would still require editing
+the Game class and its processCommand() method.
+
 \subsection{getCommandList}
 
+The command list is not printed in the CommandWords class anymore. Instead, this
+class returns a String, forwarded by the Parser class, that is then printed in
+the Game class, thanks to commit 5f1d0ada2.
+
 \subsection{Comparison with reference}
 
+The printLocationInfo() method, used only twice, has been trimmed by the commit
+590a932e5 and has been replaced by a call to the getLongDescription() method of
+the Room class.
+
+A missing getter for the Room description has been added as part of the commit
+f84606424.
+
+The loop building the command list String has been modified to use an Iterator
+with the commit 0c5793abf.
+
 \subsection{StringBuilder}
 
+The command list and the exit list are now created using a StringBuilder since
+commit ee5ec33aa. This avoids the creation of a new String object at each
+concatenation, and thus allows better performances.
+
 \subsection{Room objects}
 
+Rooms are now stored in an HashMap since commit f64f1ffb0, so they can be
+passed to any method in any class.
 
 \section{Zuul with images}
 
diff --git a/src/esieequest/CommandWords.java b/src/esieequest/CommandWords.java
index 3d8855d..e2d50f5 100644
--- a/src/esieequest/CommandWords.java
+++ b/src/esieequest/CommandWords.java
@@ -1,25 +1,23 @@
 package esieequest;
 
 /**
- * This class is part of the "World of Zuul" application. "World of Zuul" is a
- * very simple, text based adventure game.
- * 
  * This class holds an enumeration table of all command words known to the game.
- * It is used to recognise commands as they are typed in.
+ * It is used to recognize commands as they are typed in.
+ * 
+ * @author Pacien TRAN-GIRARD
+ * @author Benoit LUBRANO DI SBARAGLIONE
  * 
- * @author Michael Kolling and David J. Barnes + D.Bureau
- * @version 2008.03.30 + 2013.09.15
+ * @version February 2014
  */
 public class CommandWords {
-        // a constant array that holds all valid command words
         private static final String[] sValidCommands = { "go", "quit", "help", "look", "eat" };
 
         /**
-         * Constructor - initialise the command words.
+         * Constructor - initialize the command words.
          */
         public CommandWords() {
-                // nothing to do at the moment...
-        } // CommandWords()
+
+        }
 
         /**
          * Check whether a given String is a valid command word.
@@ -30,8 +28,18 @@ public class CommandWords {
                 for (int i = 0; i < sValidCommands.length; i++) {
                         if (sValidCommands[i].equals(pString))
                                 return true;
-                } // for
-                        // if we get here, the string was not found in the commands
+                }
                 return false;
-        } // isCommand()
-} // CommandWords
+        }
+
+        /**
+         * Print all valid commands to System.out.
+         */
+        public String getCommandList() {
+                StringBuilder vStrBuilder = new StringBuilder();
+                for (String vCommand : sValidCommands) {
+                        vStrBuilder.append(" ").append(vCommand);
+                }
+                return vStrBuilder.toString();
+        }
+}
diff --git a/src/esieequest/Game.java b/src/esieequest/Game.java
index 350fa15..43db8f7 100644
--- a/src/esieequest/Game.java
+++ b/src/esieequest/Game.java
@@ -1,5 +1,7 @@
 package esieequest;
 
+import java.util.HashMap;
+
 /**
  * The game engine.
  * 
@@ -13,6 +15,7 @@ package esieequest;
  * @version February 2014
  */
 public class Game {
+        private HashMap<String, Room> aRooms;
         private Room aCurrentRoom;
         private Parser aParser;
 
@@ -20,9 +23,9 @@ public class Game {
          * Create the game and initialize its internal map.
          */
         public Game() {
+                this.aRooms = new HashMap<String, Room>();
                 this.createRooms();
-                this.printWelcome();
-                this.printLocationInfo();
+                this.aParser = new Parser();
                 this.play();
         }
 
@@ -30,7 +33,7 @@ public class Game {
          * Main play routine. Loops until end of play.
          */
         private void play() {
-                aParser = new Parser();
+                this.printWelcome();
                 boolean vFinished = false;
                 while (!vFinished) {
                         Command vCommand = this.aParser.getCommand();
@@ -45,134 +48,134 @@ public class Game {
          */
         private void createRooms() {
                 // create rooms
-                Room vAmphitheaterSeat = new Room("in the amphitheater");
-                Room vAmphitheaterStage = new Room("on the amphitheater stage");
+                this.aRooms.put("AmphitheaterSeat", new Room("in the amphitheater"));
+                this.aRooms.put("AmphitheaterStage", new Room("on the amphitheater stage"));
 
-                Room vCafeteriaStreet = new Room("in the main corridor, in front of the cafeteria");
-                Room vCafeteria = new Room("at the cafeteria");
+                this.aRooms.put("CafeteriaStreet", new Room("in the main corridor, in front of the cafeteria"));
+                this.aRooms.put("Cafeteria", new Room("at the cafeteria"));
 
-                Room vEsieespaceStreet = new Room("in the main corridor, in front of the ESIEEspace HQ");
-                Room vEsieespaceFront = new Room("in front of the ESIEEspace HQ");
-                Room vEsieespaceEntrance = new Room("at the ESIEEspace HQ entrance");
-                Room vEsieespace = new Room("in the ESIEEspace HQ");
+                this.aRooms.put("EsieespaceStreet", new Room("in the main corridor, in front of the ESIEEspace HQ"));
+                this.aRooms.put("EsieespaceFront", new Room("in front of the ESIEEspace HQ"));
+                this.aRooms.put("EsieespaceEntrance", new Room("at the ESIEEspace HQ entrance"));
+                this.aRooms.put("Esieespace", new Room("in the ESIEEspace HQ"));
 
-                Room vClubnixStreet = new Room("in the main corridor, in front of the Club*Nix");
-                Room vClubnixFront = new Room("in front of the Club*Nix");
-                Room vClubnixEntrance = new Room("at the Club*Nix entrance");
-                Room vClubnix = new Room("in the Club*Nix");
+                this.aRooms.put("ClubnixStreet", new Room("in the main corridor, in front of the Club*Nix"));
+                this.aRooms.put("ClubnixFront", new Room("in front of the Club*Nix"));
+                this.aRooms.put("ClubnixEntrance", new Room("at the Club*Nix entrance"));
+                this.aRooms.put("Clubnix", new Room("in the Club*Nix"));
 
-                Room vEntranceStreet = new Room("in the main corridor, at the reception");
-                Room vEntranceStairs = new Room("on the main entrance stairs");
-                Room vEntranceRoundabout = new Room("on the roundabout");
+                this.aRooms.put("EntranceStreet", new Room("in the main corridor, at the reception"));
+                this.aRooms.put("EntranceStairs", new Room("on the main entrance stairs"));
+                this.aRooms.put("EntranceRoundabout", new Room("on the roundabout"));
 
-                Room vWingStreet = new Room("in font of wing #3");
-                Room vWingCorridorOne = new Room("in the corridor in wing #3, on the ground floor");
-                Room vWingStairsOne = new Room("in the stairwell on the ground floor");
-                Room vWingStairsTwo = new Room("in the stairwell on the first floor");
-                Room vWingCorridorTwo = new Room("in the corridor in wind #3, on the first floor");
-                Room vWingCorridorTwoOffice = new Room("in front of the office #3254");
-                Room vWingOffice = new Room("in the office #3254");
+                this.aRooms.put("WingStreet", new Room("in font of wing #3"));
+                this.aRooms.put("WingCorridorOne", new Room("in the corridor in wing #3, on the ground floor"));
+                this.aRooms.put("WingStairsOne", new Room("in the stairwell on the ground floor"));
+                this.aRooms.put("WingStairsTwo", new Room("in the stairwell on the first floor"));
+                this.aRooms.put("WingCorridorTwo", new Room("in the corridor in wind #3, on the first floor"));
+                this.aRooms.put("WingCorridorTwoOffice", new Room("in front of the office #3254"));
+                this.aRooms.put("WingOffice", new Room("in the office #3254"));