diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/DieMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/DieMessage.java index cff6b903..9d9c8708 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/DieMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/DieMessage.java @@ -17,7 +17,7 @@ public class DieMessage extends ServerMessage { /** * Constructor for Dice * - * @param diceEye the eye of the dice + * @param diceEye the eye of the dice */ public DieMessage(int diceEye) { super(); diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/IncorrectRequestMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/IncorrectRequestMessage.java index fca98c98..59429c01 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/IncorrectRequestMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/IncorrectRequestMessage.java @@ -15,6 +15,7 @@ public class IncorrectRequestMessage extends ServerMessage { * @param id as the id of the error message as an Integer. */ public IncorrectRequestMessage(int id) { + super(); this.id = id; } @@ -22,6 +23,7 @@ public IncorrectRequestMessage(int id) { * Constructor. */ public IncorrectRequestMessage() { + super(); this.id = 0; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerJoinedMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerJoinedMessage.java index 1feb0e5a..edcc421f 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerJoinedMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerJoinedMessage.java @@ -42,6 +42,7 @@ public LobbyPlayerJoinedMessage(int id, Player player, boolean host) { * Default constructor for serialization purposes. */ private LobbyPlayerJoinedMessage() { + super(); player = null; id = 0; host = false; @@ -61,7 +62,7 @@ public Player getPlayer() { * * @return the id of the player */ - public int getId(){ + public int getId() { return id; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerLeaveMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerLeaveMessage.java index aac97869..3c6bbba2 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerLeaveMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/LobbyPlayerLeaveMessage.java @@ -16,7 +16,7 @@ public class LobbyPlayerLeaveMessage extends ServerMessage { /** * Constructs a new LobbyPlayerLeave instance with the specified player name and color. * - * @param id the id of the player leaving the lobby. + * @param id the id of the player leaving the lobby. */ public LobbyPlayerLeaveMessage(int id) { super(); @@ -27,6 +27,7 @@ public LobbyPlayerLeaveMessage(int id) { * Default constructor for serialization purposes. */ private LobbyPlayerLeaveMessage() { + super(); id = 0; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/MoveMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/MoveMessage.java index 01e3ff77..769a8152 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/MoveMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/MoveMessage.java @@ -40,6 +40,7 @@ public MoveMessage(UUID identifier, boolean isHomeMove, int targetIndex) { * Default constructor for serialization purposes. */ private MoveMessage() { + super(); pieceUUID = null; targetIndex = 0; isHomeMove = false; @@ -59,7 +60,7 @@ public UUID getIdentifier() { * * @return the target index */ - public int getTargetIndex(){ + public int getTargetIndex() { return targetIndex; } @@ -68,7 +69,7 @@ public int getTargetIndex(){ * * @return the boolean isHomeMove. */ - public boolean isHomeMove(){ + public boolean isHomeMove() { return isHomeMove; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PauseGameMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PauseGameMessage.java index ccb70503..1edafcda 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PauseGameMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PauseGameMessage.java @@ -7,7 +7,6 @@ */ @Serializable public class PauseGameMessage extends ServerMessage { - /** * the id of the player who has disconnected */ diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PlayCardMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PlayCardMessage.java index 66b7e3ed..b81f381d 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PlayCardMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/PlayCardMessage.java @@ -20,15 +20,21 @@ public class PlayCardMessage extends ServerMessage { */ private final UUID ownPieceID; + /** + * The identifier of the enemy piece that should be moved. + */ private final UUID enemyPieceID; + /** + * The modifier of the dice. + */ private final int diceModifier; /** * Constructs a new PlayCard message. * - * @param card the card that should be played - * @param ownPieceID the identifier of the piece that should be moved + * @param card the card that should be played + * @param ownPieceID the identifier of the piece that should be moved * @param enemyPieceID the identifier of the enemy piece that should be moved * @param diceModifier the new modifier of the dice */ @@ -53,7 +59,7 @@ private PlayCardMessage() { /** * Creates a new PlayCard message for the given card and piece identifier. * - * @param ownPieceID the identifier of the piece of the player that should be affected + * @param ownPieceID the identifier of the piece of the player that should be affected * @param enemyPieceID the identifier of the enemy piece that should be affected * @return a new PlayCard message */ @@ -77,7 +83,7 @@ public static PlayCardMessage shield(UUID ownPieceID) { * @param diceModifier the new modifier of the dice * @return newly constructed message */ - public static PlayCardMessage turbo(int diceModifier){ + public static PlayCardMessage turbo(int diceModifier) { return new PlayCardMessage(BonusCard.TURBO, null, null, diceModifier); } @@ -114,7 +120,7 @@ public UUID getPieceIdentifierEnemy() { * * @return the dice modifier as int */ - public int getDiceModifier(){ + public int getDiceModifier() { return diceModifier; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SelectPieceMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SelectPieceMessage.java index 601160a9..d9d57b86 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SelectPieceMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SelectPieceMessage.java @@ -5,21 +5,35 @@ import java.util.List; import java.util.UUID; +/** + * A message sent by the server to the active player to select a piece to move. + */ @Serializable -public class SelectPieceMessage extends ServerMessage{ - +public class SelectPieceMessage extends ServerMessage { + /** + * The list of pieces + */ private final List pieces; + + /** + * The list of booleans of isHomeMove of the pieces + */ private final List isHomeMove; + + /** + * The list of indexes of target nodes of the pieces + */ private final List targetIndex; /** * Constructs a new SelectPiece instance. * - * @param pieces the pieces to be selected - * @param isHomeMove the List of booleans of isHomeMove of the pieces + * @param pieces the pieces to be selected + * @param isHomeMove the List of booleans of isHomeMove of the pieces * @param targetIndex the List of indexes of target nodes of the pieces */ - public SelectPieceMessage(List pieces, List isHomeMove, List targetIndex){ + public SelectPieceMessage(List pieces, List isHomeMove, List targetIndex) { + super(); this.pieces = pieces; this.isHomeMove = isHomeMove; this.targetIndex = targetIndex; @@ -28,7 +42,8 @@ public SelectPieceMessage(List pieces, List isHomeMove, List getPieces(){ + public List getPieces() { return pieces; } @@ -48,7 +63,7 @@ public List getPieces(){ * * @return List of boolean values */ - public List getIsHomeMove(){ + public List getIsHomeMove() { return isHomeMove; } @@ -57,7 +72,7 @@ public List getIsHomeMove(){ * * @return List of integers */ - public List getTargetIndex(){ + public List getTargetIndex() { return targetIndex; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerInterpreter.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerInterpreter.java index edb54c9a..67dcf802 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerInterpreter.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerInterpreter.java @@ -36,7 +36,7 @@ public interface ServerInterpreter { /** * Handles a Die message received from the server. * - * @param msg the Dice message received + * @param msg the Die message received */ void received(DieMessage msg); @@ -55,16 +55,16 @@ public interface ServerInterpreter { void received(DiceNowMessage msg); /** - * Handles an EndOfGame message received from the server. + * Handles an EndOfTurn message received from the server. * - * @param msg the EndOfGame message received + * @param msg the EndOfTurn message received */ void received(EndOfTurnMessage msg); /** - * Handles a GameOver message received from the server. + * Handles a LobbyAccept message received from the server. * - * @param msg the GameOver message received + * @param msg the LobbyAccept message received */ void received(LobbyAcceptMessage msg); @@ -132,9 +132,9 @@ public interface ServerInterpreter { void received(PossiblePieceMessage msg); /** - * Handles a RankingResponce message received from the server. + * Handles a RankingResponse message received from the server. * - * @param msg the RankingResponce message received + * @param msg the RankingResponse message received */ void received(RankingResponseMessage msg); @@ -209,9 +209,9 @@ public interface ServerInterpreter { void received(SelectPieceMessage msg); /** - * Handles a SelectTSK message received from the server. + * Handles a Shutdown message received from the server. * - * @param msg the SelectTSK message received. + * @param msg the Shutdown message received. */ void received(ShutdownMessage msg); diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerStartGameMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerStartGameMessage.java index 7017a89a..522d0284 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerStartGameMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ServerStartGameMessage.java @@ -13,9 +13,13 @@ @Serializable public class ServerStartGameMessage extends ServerMessage { /** - * Create ServerStartGameMessage attributes. + * The list of players. */ private final List players; + + /** + * The board of the game. + */ private final Board board; /** diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ShutdownMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ShutdownMessage.java index ad4aa70a..06ce9c12 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ShutdownMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/ShutdownMessage.java @@ -7,6 +7,13 @@ */ @Serializable public class ShutdownMessage extends ServerMessage { + /** + * Constructs a new Shutdown message. + */ + public ShutdownMessage() { + super(); + } + /** * Accepts a visitor to process this message. * diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SpectatorMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SpectatorMessage.java index 1c7287b4..b7cc8890 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SpectatorMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/SpectatorMessage.java @@ -1,7 +1,7 @@ package pp.mdga.message.server; /** - * + * A message sent by the server to indicate that the client is now a spectator. */ public class SpectatorMessage extends ServerMessage { /** @@ -12,7 +12,6 @@ public SpectatorMessage() { } /** - * * @param interpreter the visitor to process this message */ @Override diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/StartPieceMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/StartPieceMessage.java index c14dd3b8..da62cf47 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/StartPieceMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/StartPieceMessage.java @@ -23,7 +23,7 @@ public class StartPieceMessage extends ServerMessage { * Constructs a new StartPiece instance with the specified piece identifier. * * @param pieceIdentifier the identifier for the piece - * @param targetIndex the index of the targetNode + * @param targetIndex the index of the targetNode */ public StartPieceMessage(UUID pieceIdentifier, int targetIndex) { super(); @@ -54,7 +54,7 @@ public UUID getPieceIdentifier() { * * @return the index of the target node as int. */ - public int getTargetIndex(){ + public int getTargetIndex() { return targetIndex; } diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateReadyMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateReadyMessage.java index 97a8989b..d8b03d23 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateReadyMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateReadyMessage.java @@ -21,7 +21,7 @@ public class UpdateReadyMessage extends ServerMessage { * Constructs a new UpdateReady instance with the specified color and readiness status. * * @param playerId the playerId associated with the update - * @param ready the readiness status + * @param ready the readiness status */ public UpdateReadyMessage(int playerId, boolean ready) { super(); diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateTSKMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateTSKMessage.java index f1038659..83f9773a 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateTSKMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/UpdateTSKMessage.java @@ -18,12 +18,15 @@ public class UpdateTSKMessage extends ServerMessage { */ private final Color color; + /** + * The flag if the TSK is taken. + */ private final boolean isTaken; /** * Constructs a new UpdateTSK instance with the specified id and color. * - * @param id the name associated with the update + * @param id the name associated with the update * @param color the color associated with the update */ public UpdateTSKMessage(int id, Color color, boolean isTaken) { diff --git a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/WaitPieceMessage.java b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/WaitPieceMessage.java index fa425790..d2437a70 100644 --- a/Projekte/mdga/model/src/main/java/pp/mdga/message/server/WaitPieceMessage.java +++ b/Projekte/mdga/model/src/main/java/pp/mdga/message/server/WaitPieceMessage.java @@ -9,7 +9,9 @@ */ @Serializable public class WaitPieceMessage extends ServerMessage { - + /** + * The pieceID of the piece to choose. + */ private final UUID pieceID; /**