1 files changed, 102 insertions, 34 deletions

diff --git a/src/esieequest/model/Game.java b/src/esieequest/model/Game.java
index c9d7933..99afa7c 100644
--- a/src/esieequest/model/Game.java
+++ b/src/esieequest/model/Game.java
@@ -1,23 +1,22 @@
 package esieequest.model;
 
 import java.util.HashMap;
-import java.util.Set;
 
 /**
+ * Represents the game.
  * 
  * @author Pacien TRAN-GIRARD
- * @author Benoit LUBRANO DI SBARAGLIONE
- * 
- * @version February 2014
+ * @author Benoît LUBRANO DI SBARAGLIONE
  */
 public class Game {
 
-        private boolean running;
-        private HashMap<String, Room> rooms;
+        private final HashMap<String, Room> rooms;
         private Room currentRoom;
 
+        /**
+         * The default constructor.
+         */
         public Game() {
-                this.running = false;
                 this.rooms = new HashMap<String, Room>();
                 this.currentRoom = null;
 
@@ -27,14 +26,36 @@ public class Game {
                 this.goToRoom("AmphitheaterSeat");
         }
 
-        private void createRoom(String name, String description) {
+        /**
+         * Creates a new room.
+         * 
+         * @param name
+         *            the name of the room
+         * @param description
+         *            the description of the room
+         */
+        private void createRoom(final String name, final String description) {
                 this.rooms.put(name, new Room(description));
         }
 
-        private void setRoomExit(String roomName, String direction, String exitRoomName) {
-                this.rooms.get(roomName).setExit(direction, this.rooms.get(exitRoomName));
+        /**
+         * Sets the exit room of a given room designated by its name.
+         * 
+         * @param roomName
+         *            the name of the room
+         * @param direction
+         *            the direction of the exit
+         * @param exitRoomName
+         *            the name of the exit room
+         */
+        private void setRoomExit(final String roomName, final String direction,
+                        final String exitRoomName) {
+                this.rooms.get(roomName).addExit(direction, this.rooms.get(exitRoomName));
         }
 
+        /**
+         * Creates all the rooms.
+         */
         private void createRooms() {
                 this.createRoom("AmphitheaterSeat", "in the amphitheater");
                 this.createRoom("AmphitheaterStage", "on the amphitheater stage");
@@ -84,6 +105,9 @@ public class Game {
 
         }
 
+        /**
+         * Connects all the rooms.
+         */
         private void linkRooms() {
                 this.setRoomExit("AmphitheaterSeat", "north", "AmphitheaterStage");
                 this.setRoomExit("AmphitheaterStage", "west", "Cafeteria");
@@ -166,73 +190,117 @@ public class Game {
                 this.setRoomExit("OffscriptMovingcharacter", "west", "OffscriptAlea");
         }
 
+        /**
+         * Creates and adds items into rooms.
+         */
         private void createItems() {
                 this.rooms.get("Cafeteria").addItem("Banana", new Item("A yellow banana", 12));
                 this.rooms.get("Cafeteria").addItem("Orange", new Item("An orange orange", 15));
         }
 
-        public void setRunning(boolean state) {
-                this.running = state;
-        }
-
-        public boolean isRunning() {
-                return this.running;
-        }
-
-        public void goToRoom(Room room) {
+        /**
+         * Sets the current room.
+         * 
+         * @param room
+         *            the destination room
+         */
+        public void goToRoom(final Room room) {
                 this.currentRoom = room;
         }
 
-        public void goToRoom(String roomName) {
+        /**
+         * Sets the current room designated by its name.
+         * 
+         * @param roomName
+         *            the destination room name
+         */
+        public void goToRoom(final String roomName) {
                 this.currentRoom = this.rooms.get(roomName);
         }
 
-        public Room getRoomExit(String direction) {
+        /**
+         * Returns the current room's exit located in the given direction.
+         * 
+         * @param direction
+         *            the direction of the exit
+         * 
+         * @return the exit room
+         */
+        public Room getRoomExit(final String direction) {
                 return this.currentRoom.getExit(direction);
         }
 
+        /**
+         * Returns informations about the current room (description, exits and
+         * items).
+         * 
+         * @return the informations about the current room
+         */
         public String getLocationInfo() {
-                return this.currentRoom.getLongDescription();
+                return this.currentRoom.getInformations();
         }
 
+        /**
+         * Returns the current room's image name.
+         * 
+         * @return the current room's image name.
+         */
         public String getLocationImageName() {
                 return this.currentRoom.getImageName();
         }
 
-        public String getItemDescription(String itemName) {
-                return this.currentRoom.getItem(itemName).getDescription();
-        }
-
-        public Set<String> getItemList() {
-                return this.currentRoom.getItemList();
-        }
-
+        /**
+         * Returns the "eat" message.
+         * 
+         * @return the "eat message
+         */
         public String getEatMessage() {
                 return "oNommNommNomm...";
         }
 
+        /**
+         * Returns the welcome message.
+         * 
+         * @return the welcome message
+         */
         public String getWelcomeMessage() {
                 return "Welcome to ESIEEquest! ESIEEquest is a new, amazingly boring adventure game.";
         }
 
+        /**
+         * Returns the help message.
+         * 
+         * @return the help message
+         */
         public String getHelpMessage() {
                 return "Everybody else disappeared. You are alone. You wander around at the ESIEE.";
         }
 
+        /**
+         * Returns the quit message.
+         * 
+         * @return the quit message
+         */
         public String getQuitMessage() {
                 return "Thank you for wasting your time. Good bye.";
         }
 
+        /**
+         * Returns the "no exit" message.
+         * 
+         * @return the "no exit" message
+         */
         public String getNoExitMessage() {
                 return "There is no exit.";
         }