Refactor deserialization

5 files changed, 440 insertions, 213 deletions

diff --git a/src/ch/epfl/xblast/client/GameState.java b/src/ch/epfl/xblast/client/GameState.java
index 4906094..7652cd5 100644
--- a/src/ch/epfl/xblast/client/GameState.java
+++ b/src/ch/epfl/xblast/client/GameState.java
@@ -1,31 +1,29 @@
 package ch.epfl.xblast.client;
 
+import ch.epfl.xblast.ArgumentChecker;
+import ch.epfl.xblast.Lists;
 import ch.epfl.xblast.PlayerID;
 import ch.epfl.xblast.SubCell;
+import ch.epfl.xblast.client.painter.ScorePainter;
+import ch.epfl.xblast.client.painter.TimeLinePainter;
 
 import java.awt.*;
 import java.util.List;
+import java.util.Objects;
 
 /**
+ * The client representation of a game state.
+ *
  * @author Timothée FLOURE (257420)
+ * @author Pacien TRAN-GIRARD (261948)
  */
 public final class GameState {
-    /**
-     * GameState's parameters.
-     */
-    private final List<Player> players;
-    private final List<Image> board;
-    private final List<Image> explosions;
-    private final List<Image> scores;
-    private final List<Image> ticks;
 
     /**
      * A Player.
      */
     public static final class Player {
-        /**
-         * Player's parameters.
-         */
+
         private final PlayerID id;
         private final int lives;
         private final SubCell position;
@@ -34,16 +32,16 @@ public final class GameState {
         /**
          * Instantiates a new Player.
          *
-         * @param id id of the player
-         * @param lives number of lives of the player
+         * @param id       id of the player
+         * @param lives    number of lives of the player
          * @param position position of the player
-         * @param image image related to the actual state of the player
+         * @param image    image related to the actual state of the player
          */
         public Player(PlayerID id, int lives, SubCell position, Image image) {
             this.id = id;
             this.lives = lives;
-            this.position = position;
-            this.image = image;
+            this.position = Objects.requireNonNull(position);
+            this.image = Objects.requireNonNull(image);
         }
 
         /**
@@ -73,23 +71,42 @@ public final class GameState {
         public Image image() {
             return this.image;
         }
+
+    }
+
+    private final List<Player> players;
+    private final List<Image> board;
+    private final List<Image> explosions;
+    private final List<Image> scores;
+    private final List<Image> ticks;
+
+    /**
+     * Instantiates a new GameState.
+     *
+     * @param players    list containing the players
+     * @param board      list containing all the images composing the board
+     * @param explosions list containing all the images composing the blasts and the bombs
+     * @param scores     list containing all the images composing the actual score
+     * @param ticks      list containing all the images composing the time "line"
+     */
+    public GameState(List<Player> players, List<Image> board, List<Image> explosions, List<Image> scores, List<Image> ticks) {
+        this.players = Lists.immutableList(ArgumentChecker.requireNonEmpty(players));
+        this.board = Lists.immutableList(ArgumentChecker.requireNonEmpty(board));
+        this.explosions = Lists.immutableList(Objects.requireNonNull(explosions));
+        this.scores = Lists.immutableList(ArgumentChecker.requireNonEmpty(scores));
+        this.ticks = Lists.immutableList(ArgumentChecker.requireNonEmpty(ticks));
     }
 
     /**
      * Instantiates a new GameState.
      *
-     * @param players list containing the players
-     * @param board list containing all the images composing the board
+     * @param players    list containing the players
+     * @param board      list containing all the images composing the board
      * @param explosions list containing all the images composing the blasts and the bombs
-     * @param scores list containing all the images composing the actual score
-     * @param ticks list containing all the images composing the time "line"
+     * @param ticks      the ticks
      */
-    public GameState(List<Player> players, List<Image> board, List<Image> explosions, List<Image>  scores, List<Image> ticks) {
-        this.players = players;
-        this.board = board;
-        this.explosions = explosions;
-        this.scores = scores;
-        this.ticks = ticks;
+    public GameState(List<Player> players, List<Image> board, List<Image> explosions, int ticks) {
+        this(players, board, explosions, ScorePainter.buildScorePanel(players), TimeLinePainter.buildTimeLine(ticks));
     }
 
     /**
@@ -126,4 +143,5 @@ public final class GameState {
     public List<Image> ticks() {
         return this.ticks;
     }
+
 }
diff --git a/src/ch/epfl/xblast/client/GameStateDeserializer.java b/src/ch/epfl/xblast/client/GameStateDeserializer.java
index f1327e3..20b44f9 100644
--- a/src/ch/epfl/xblast/client/GameStateDeserializer.java
+++ b/src/ch/epfl/xblast/client/GameStateDeserializer.java
@@ -1,164 +1,170 @@
 package ch.epfl.xblast.client;
 
+import ch.epfl.xblast.Lists;
 import ch.epfl.xblast.PlayerID;
 import ch.epfl.xblast.RunLengthEncoder;
 import ch.epfl.xblast.SubCell;
 import ch.epfl.xblast.client.GameState.Player;
-import ch.epfl.xblast.server.Ticks;
 
-import java.util.ArrayList;
+import java.awt.*;
+import java.util.*;
 import java.util.List;
-import java.awt.Image;
 import java.util.stream.Collectors;
 
 /**
+ * The client game state deserializer.
+ *
+ * @author Pacien TRAN-GIRARD (261948)
  * @author Timothée FLOURE (257420)
  */
 public final class GameStateDeserializer {
-    /**
-     * Image collections folders
-     */
-    private final static String BOARD_IMAGES_FOLDER = "block";
-    private final static String EXPLOSION_IMAGES_FOLDER = "explosion";
-    private final static String PLAYER_IMAGES_FOLDER = "player";
-    private final static String TIME_IMAGES_FOLDER = "score";
-    private final static String SCORE_IMAGES_FOLDER = "score";
 
-    /**
-     * Serialized data chunks
-     */
-    private final static int NUMBER_OF_PLAYERS = 4;
-    private final static int PLAYER_CHUNK_SIZE = 4;
-    private final static int PLAYER_TOTAL_SIZE = NUMBER_OF_PLAYERS * PLAYER_CHUNK_SIZE;
+    private static final int SERIALIZED_PLAYER_LENGTH = 4;
+    private static final int SERIALIZED_PLAYERS_LENGTH = PlayerID.values().length * SERIALIZED_PLAYER_LENGTH;
+    private static final int SERIALIZED_TICKS_LENGTH = 1;
 
     /**
-     * Scores & Time
+     * Represents a length-prefixed chunk of byte-encoded data.
      */
-    private final static int TIME_LINE_SIZE = (Ticks.GAME_DURATION / 2);
-    private final static int SCORE_SEPARATION_SIZE = 8;
+    private static class VariableLengthChunk {
 
-    /**
-     * Images ID
-     */
-    private final static int TIME_LINE_LED_ON_IMAGE_ID = 21;
-    private final static int TIME_LINE_LED_OFF_IMAGE_ID = 20;
-    private final static int SCORE_TEXT_MIDDLE_IMAGE_ID = 10;
-    private final static int SCORE_TEXT_RIGHT_IMAGE_ID = 11;
-    private final static int SCORE_TILE_VOID_IMAGE_ID = 12;
+        private static final int PREFIX_SHIFT = 1;
 
-    /**
-     * Deserialize an encoded chunk of data and link it to images.
-     *
-     * @param data serialized data
+        private final List<Byte> bytes;