diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ActivePlayer.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ActivePlayer.java index e7c35daa..6127acff 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ActivePlayer.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ActivePlayer.java @@ -1,30 +1,63 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.Color; +/** + * A message sent by the server to inform the clients about the active player. + */ +@Serializable public class ActivePlayer extends ServerMessage { - private Color color; + /** + * The color of the active player. + */ + private final Color color; - /** Constructor for ActivePlayer + /** + * Constructor for ActivePlayer + * * @param color the color of the active player */ public ActivePlayer(Color color) { + super(); this.color = color; } - /** Getter for the color of the active player + /** + * Getter for the color of the active player + * * @return the color of the active player */ public Color getColor() { return color; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return "ActivePlayer{color=" + color + '}'; + } + + /** + * Returns the key for the informational text associated with this message. + * + * @return the key for the informational text + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/AnyPiece.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/AnyPiece.java index 42e3cec6..eaf69c6d 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/AnyPiece.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/AnyPiece.java @@ -1,36 +1,71 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; + import java.util.ArrayList; +import java.util.List; +/** + * A message sent by the server to the active player containing a list of pieces that the player can move any piece of the list on the board. + */ +@Serializable public class AnyPiece extends ServerMessage { + /** + * The list of pieces + */ + private final ArrayList piece; - private ArrayList piece; - - /** Constructor for AnyPiece + /** + * Constructor for AnyPiece */ public AnyPiece() { + super(); piece = new ArrayList<>(); } - /** Add a piece to the list of pieces + /** + * Add a piece to the list of pieces + * * @param piece the piece to add */ public void addPiece(String piece) { this.piece.add(piece); } - /** Getter for the list of pieces + /** + * Getter for the list of pieces + * * @return the list of pieces */ - public ArrayList getPiece() { + public List getPiece() { return piece; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return "AnyPiece{piece=" + piece + '}'; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Briefing.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Briefing.java index db89d408..86942872 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Briefing.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Briefing.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class Briefing extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the reconnected player to provide a briefing about the current game state. + */ +@Serializable +public class Briefing extends ServerMessage { + /** + * Constructs a new Briefing instance. + */ + public Briefing() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Ceremony.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Ceremony.java index 8a13db46..3bff739c 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Ceremony.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Ceremony.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class Ceremony extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to indicate the beginning of the ceremony. + */ +@Serializable +public class Ceremony extends ServerMessage { + /** + * Constructs a new Ceremony instance. + */ + public Ceremony() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Dice.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Dice.java index 7330505f..255a81b5 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Dice.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/Dice.java @@ -1,22 +1,39 @@ package pp.mdga.message.server; -import java.util.ArrayList; +import com.jme3.network.serializing.Serializable; +import java.util.List; + +/** + * A message sent by the server to the client to inform about the dice roll. + */ +@Serializable public class Dice extends ServerMessage { - + /** + * The eye of the dice + */ private final int diceEye; - private final ArrayList moveablePieces; - /** Constructor for Dice - * @param diceEye the eye of the dice + /** + * The pieces that can be moved + */ + private final List moveablePieces; + + /** + * Constructor for Dice + * + * @param diceEye the eye of the dice * @param moveablePieces the pieces that can be moved */ - public Dice(int diceEye, ArrayList moveablePieces) { + public Dice(int diceEye, List moveablePieces) { + super(); this.diceEye = diceEye; this.moveablePieces = moveablePieces; } - /** Constructor for inactivePlayer + /** + * Constructor for inactivePlayer + * * @param diceEye the eye of the dice * @return a new Dice object */ @@ -24,34 +41,60 @@ public static Dice inactivePlayer(int diceEye) { return new Dice(diceEye, null); } - /** Constructor for activePlayer - * @param diceEye the eye of the dice + /** + * Constructor for activePlayer + * + * @param diceEye the eye of the dice * @param moveablePieces the pieces that can be moved * @return a new Dice object */ - public static Dice activePlayer(int diceEye, ArrayList moveablePieces) { + public static Dice activePlayer(int diceEye, List moveablePieces) { return new Dice(diceEye, moveablePieces); } - /** Getter for the eye of the dice + /** + * Getter for the eye of the dice + * * @return the eye of the dice */ public int getDiceEye() { return diceEye; } - /** Getter for the pieces that can be moved + /** + * Getter for the pieces that can be moved + * * @return the pieces that can be moved */ - public ArrayList getMoveablePieces() { + public List getMoveablePieces() { return moveablePieces; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceAgain.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceAgain.java index ee1798ee..c3402946 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceAgain.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceAgain.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class DiceAgain extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the active player to indicate that they can roll the dice again. + */ +@Serializable +public class DiceAgain extends ServerMessage { + /** + * Constructs a new DiceAgain instance. + */ + public DiceAgain() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceNow.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceNow.java index 3a87ca60..b72f22a7 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceNow.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/DiceNow.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class DiceNow extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the active player to enable the dice now button. + */ +@Serializable +public class DiceNow extends ServerMessage { + /** + * Constructs a new DiceNow instance. + */ + public DiceNow() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/EndOfTurn.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/EndOfTurn.java index 62c33df2..d9ac9cb0 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/EndOfTurn.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/EndOfTurn.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class EndOfTurn extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to indicate the end of the turn of the active player. + */ +@Serializable +public class EndOfTurn extends ServerMessage { + /** + * Constructs a new EndOfTurn instance. + */ + public EndOfTurn() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyAccept.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyAccept.java index 324c69e5..d252148d 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyAccept.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyAccept.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class LobbyAccept extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to indicate that the client has been accepted into the lobby. + */ +@Serializable +public class LobbyAccept extends ServerMessage { + /** + * Constructs a new LobbyAccept instance. + */ + public LobbyAccept() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyDeny.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyDeny.java index 0cbd29f0..0717f814 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyDeny.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyDeny.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class LobbyDeny extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to deny a client's request to join the lobby. + */ +@Serializable +public class LobbyDeny extends ServerMessage { + /** + * Constructs a new LobbyDeny instance. + */ + public LobbyDeny() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerJoin.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerJoin.java index 5d686153..1eb189a0 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerJoin.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerJoin.java @@ -1,22 +1,62 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; + +/** + * A message sent from the server to the client indicating that a player has joined the lobby. + */ +@Serializable public class LobbyPlayerJoin extends ServerMessage { + /** + * The name of the player joining the lobby. + */ private final String name; + /** + * Constructs a new LobbyPlayerJoin instance with the specified player name. + * + * @param name the name of the player joining the lobby + */ public LobbyPlayerJoin(String name) { + super(); this.name = name; } + /** + * Returns the name of the player joining the lobby. + * + * @return the name of the player joining the lobby + */ public String getName() { return name; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerLeave.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerLeave.java index 4f4ab6a3..267a368f 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerLeave.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/LobbyPlayerLeave.java @@ -1,29 +1,78 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.Color; +/** + * A message sent by the server to indicate that a player has left the lobby. + */ +@Serializable public class LobbyPlayerLeave extends ServerMessage { - + /** + * The name of the player leaving the lobby. + */ private final String name; + + /** + * The color associated with the player leaving the lobby. + */ private final Color color; + /** + * Constructs a new LobbyPlayerLeave instance with the specified player name and color. + * + * @param name the name of the player leaving the lobby + * @param color the color associated with the player leaving the lobby + */ public LobbyPlayerLeave(String name, Color color) { + super(); this.name = name; this.color = color; } + /** + * Returns the name of the player leaving the lobby. + * + * @return the name of the player leaving the lobby + */ public String getName() { return name; } + /** + * Returns the color associated with the player leaving the lobby. + * + * @return the color associated with the player leaving the lobby + */ public Color getColor() { return color; } + + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; 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 4a7a3a39..d3df9f6c 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 @@ -1,17 +1,30 @@ package pp.mdga.message.server; -public class MoveMessage extends ServerMessage { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the client to move a piece on the board. + */ +@Serializable +public class MoveMessage extends ServerMessage { + /** + * The identifier of the piece that should be moved. + */ private final String pieceIdentifier; /** + * Constructs a new MoveMessage instance. + * * @param identifier the identifier of the piece that should be moved */ public MoveMessage(String identifier) { + super(); this.pieceIdentifier = identifier; } /** + * Returns the identifier of the piece that should be moved. + * * @return the identifier of the piece that should be moved */ public String getIdentifier() { @@ -19,13 +32,30 @@ public String getIdentifier() { } /** - * @return the identifier of the piece that should be moved + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/NoTurn.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/NoTurn.java index c1b1f436..8a412de4 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/NoTurn.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/NoTurn.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class NoTurn extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the active player to indicate that he has no valid moves. + */ +@Serializable +public class NoTurn extends ServerMessage { + /** + * Constructs a new NoTurn instance. + */ + public NoTurn() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PauseGame.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PauseGame.java index d9416c30..19c95651 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PauseGame.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PauseGame.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class PauseGame extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to indicate that the game is paused. + */ +@Serializable +public class PauseGame extends ServerMessage { + /** + * Constructs a new PauseGame instance. + */ + public PauseGame() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PlayCard.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PlayCard.java index 4b5f61ae..4d027172 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PlayCard.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PlayCard.java @@ -1,22 +1,38 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.BonusCard; +/** + * A message sent by the server to the active player to play a card. + */ +@Serializable public class PlayCard extends ServerMessage { - + /** + * The card that should be played. + */ private final BonusCard card; + + /** + * The identifier of the piece that should be moved. + */ private final String pieceIdentifier; /** - * @param card the card that should be played + * Constructs a new PlayCard message. + * + * @param card the card that should be played * @param pieceIdentifier the identifier of the piece that should be moved */ public PlayCard(BonusCard card, String pieceIdentifier) { + super(); this.card = card; this.pieceIdentifier = pieceIdentifier; } /** + * Returns the card that should be played. + * * @return the card that should be played */ public BonusCard getCard() { @@ -24,16 +40,39 @@ public BonusCard getCard() { } /** + * Returns the identifier of the piece that should be moved. + * * @return the identifier of the piece that should be moved */ public String getPieceIdentifier() { return pieceIdentifier; } + + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossibleCard.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossibleCard.java index d543b3c6..35df9bef 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossibleCard.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossibleCard.java @@ -1,38 +1,72 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.BonusCard; import java.util.ArrayList; +import java.util.List; +/** + * A message sent by the server to the client to indicate the possible cards that can be chosen. + */ +@Serializable public class PossibleCard extends ServerMessage { + /** + * The list of possible cards. + */ + private final List possibleCards; - private ArrayList possibleCards; - - /** Constructor for PossibleCard + /** + * Constructor for a PossibleCard instance. */ public PossibleCard() { + super(); possibleCards = new ArrayList<>(); } - /** Add a possible card to the list of possible cards + /** + * Add a possible card to the list of possible cards + * * @param card the possible card to add */ public void addPossibleCard(BonusCard card) { this.possibleCards.add(card); } - /** Getter for the list of possible cards + /** + * Getter for the list of possible cards + * * @return the list of possible cards */ - public ArrayList getPossibleCards() { + public List getPossibleCards() { return possibleCards; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossiblePiece.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossiblePiece.java index d85b9453..4755b9c8 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossiblePiece.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/PossiblePiece.java @@ -1,27 +1,46 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; + import java.util.ArrayList; +import java.util.List; +/** + * A message sent by the server to the active player to give all possible pieces to choose from. + */ +@Serializable public class PossiblePiece extends ServerMessage { + /** + * The list of possible own pieces + */ + private final List possibleOwnPieces; - private final ArrayList possibleOwnPieces; - private final ArrayList possibleEnemyPieces; + /** + * The list of possible enemy pieces + */ + private final List possibleEnemyPieces; - /** Constructor for PossiblePiece + /** + * Constructor for PossiblePiece */ public PossiblePiece() { + super(); possibleOwnPieces = new ArrayList<>(); possibleEnemyPieces = new ArrayList<>(); } - /** Add a piece to the list of possible pieces + /** + * Add a piece to the list of possible pieces + * * @param piece the piece to add */ public void addOwnPossiblePiece(String piece) { this.possibleOwnPieces.add(piece); } - /** Add a piece to the list of possible enemy pieces + /** + * Add a piece to the list of possible enemy pieces + * * @param piece the piece to add */ public void addEnemyPossiblePiece(String piece) { @@ -31,15 +50,35 @@ public void addEnemyPossiblePiece(String piece) { /** Getter for the list of possible pieces * @return the list of possible pieces */ - public ArrayList getPossiblePieces() { + public List getPossiblePieces() { return possibleOwnPieces; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponce.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponce.java deleted file mode 100644 index 4464bf2c..00000000 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponce.java +++ /dev/null @@ -1,13 +0,0 @@ -package pp.mdga.message.server; - -public class RankingResponce extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { - - } - - @Override - public String getInfoTextKey() { - return ""; - } -} diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponse.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponse.java new file mode 100644 index 00000000..9b5eda2f --- /dev/null +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingResponse.java @@ -0,0 +1,46 @@ +package pp.mdga.message.server; + +import com.jme3.network.serializing.Serializable; + +/** + * A message sent by the server to all client to inform them about the current ranking. (only in DetermineStartPlayer) + */ +@Serializable +public class RankingResponse extends ServerMessage { + /** + * Constructs a new RankingResponse instance. + */ + public RankingResponse() { + super(); + } + + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ + @Override + public String getInfoTextKey() { + return ""; + } +} diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingRollAgain.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingRollAgain.java index a1c200f9..eaf06392 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingRollAgain.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/RankingRollAgain.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class RankingRollAgain extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the clients to indicate that the ranking shall be rolled again. (only in DetermineStartPlayer) + */ +@Serializable +public class RankingRollAgain extends ServerMessage { + /** + * Constructs a new RankingRollAgain instance. + */ + public RankingRollAgain() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ReconnectBriefing.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ReconnectBriefing.java index 7910e2c2..08f93d52 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ReconnectBriefing.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ReconnectBriefing.java @@ -1,23 +1,60 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.Game; +/** + * A message sent by the server to a client that has reconnected to the game. (give the last saved model) + */ +@Serializable public class ReconnectBriefing extends ServerMessage { - + /** + * The game. + */ private final Game game; + /** + * Constructs a new ReconnectBriefing message. + */ public ReconnectBriefing(Game game) { + super(); this.game = game; } + /** + * Returns the game. + * + * @return the game + */ public Game getGame() { return game; } + + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ResumeGame.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ResumeGame.java index 764dbb52..1ebfd673 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ResumeGame.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ResumeGame.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class ResumeGame extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to resume the game. + */ +@Serializable +public class ResumeGame extends ServerMessage { + /** + * Constructs a new ResumeGame instance. + */ + public ResumeGame() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; 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 d8f068cc..e9dde28a 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 @@ -1,4 +1,196 @@ package pp.mdga.message.server; +/** + * An interface for processing server messages. + * Implementations of this interface can be used to handle different types of server messages. + */ public interface ServerInterpreter { + /** + * Handles an ActivePlayer message received from the server. + * + * @param msg the ActivePlayer message received + */ + void received(ActivePlayer msg); + + /** + * Handles an AnyPiece message received from the server. + * + * @param msg the AnyPiece message received + */ + void received(AnyPiece msg); + + /** + * Handles a Briefing message received from the server. + * + * @param msg the Briefing message received + */ + void received(Briefing msg); + + /** + * Handles a Ceremony message received from the server. + * + * @param msg the Ceremony message received + */ + void received(Ceremony msg); + + /** + * Handles a Dice message received from the server. + * + * @param msg the Dice message received + */ + void received(Dice msg); + + /** + * Handles a DiceAgain message received from the server. + * + * @param msg the DiceAgain message received + */ + void received(DiceAgain msg); + + /** + * Handles a DiceNow message received from the server. + * + * @param msg the DiceNow message received + */ + void received(DiceNow msg); + + /** + * Handles an EndOfGame message received from the server. + * + * @param msg the EndOfGame message received + */ + void received(EndOfTurn msg); + + /** + * Handles a GameOver message received from the server. + * + * @param msg the GameOver message received + */ + void received(LobbyAccept msg); + + /** + * Handles a LobbyDeny message received from the server. + * + * @param msg the LobbyDeny message received + */ + void received(LobbyDeny msg); + + /** + * Handles a LobbyPlayerJoin message received from the server. + * + * @param msg the LobbyPlayerJoin message received + */ + void received(LobbyPlayerJoin msg); + + /** + * Handles a LobbyPlayerLeave message received from the server. + * + * @param msg the LobbyPlayerLeave message received + */ + void received(LobbyPlayerLeave msg); + + /** + * Handles a MoveMessage message received from the server. + * + * @param msg the MoveMessage message received + */ + void received(MoveMessage msg); + + /** + * Handles a NoTurn message received from the server. + * + * @param msg the NoTurn message received + */ + void received(NoTurn msg); + + /** + * Handles a PauseGame message received from the server. + * + * @param msg the PauseGame message received + */ + void received(PauseGame msg); + + /** + * Handles a PlayCard message received from the server. + * + * @param msg the PlayCard message received + */ + void received(PlayCard msg); + + /** + * Handles a PossibleCard message received from the server. + * + * @param msg the PossibleCard message received + */ + void received(PossibleCard msg); + + /** + * Handles a PossiblePiece message received from the server. + * + * @param msg the PossiblePiece message received + */ + void received(PossiblePiece msg); + + /** + * Handles a RankingResponce message received from the server. + * + * @param msg the RankingResponce message received + */ + void received(RankingResponse msg); + + /** + * Handles a RankingRollAgain message received from the server. + * + * @param msg the RankingRollAgain message received + */ + void received(RankingRollAgain msg); + + /** + * Handles a ReconnectBriefing message received from the server. + * + * @param msg the ReconnectBriefing message received + */ + void received(ReconnectBriefing msg); + + /** + * Handles a ResumeGame message received from the server. + * + * @param msg the ResumeGame message received + */ + void received(ResumeGame msg); + + /** + * Handles a ServerStartGame message received from the server. + * + * @param msg the ServerStartGame message received + */ + void received(ServerStartGame msg); + + /** + * Handles a StartPiece message received from the server. + * + * @param msg the StartPiece message received + */ + void received(StartPiece msg); + + /** + * Handles a UpdateReady message received from the server. + * + * @param msg the UpdateReady message received + */ + void received(UpdateReady msg); + + /** + * Handles a UpdateTSK message received from the server. + * + * @param msg the UpdateTSK message received + */ + void received(UpdateTSK msg); + + /** + * Handles a WaitPiece message received from the server. + * + * @param msg the WaitPiece message received + */ + void received(WaitPiece msg); } diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerMessage.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerMessage.java index b97aec1a..bc1d6b7d 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerMessage.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerMessage.java @@ -2,12 +2,30 @@ import com.jme3.network.AbstractMessage; +/** + * An abstract base class for server messages used in network transfer. + * It extends the AbstractMessage class provided by the jme3-network library. + */ public abstract class ServerMessage extends AbstractMessage { + /** + * Constructs a new ServerMessage instance. + */ protected ServerMessage() { super(true); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ public abstract void accept(ServerInterpreter interpreter); + /** + * Gets the bundle key of the informational text to be shown at the client. + * This key is used to retrieve the appropriate localized text for display. + * + * @return the bundle key of the informational text + */ public abstract String getInfoTextKey(); } diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerStartGame.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerStartGame.java index 5a684bb8..d6ec553d 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerStartGame.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/ServerStartGame.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; -public class ServerStartGame extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { +import com.jme3.network.serializing.Serializable; +/** + * A message indicating that the game shall start. + */ +@Serializable +public class ServerStartGame extends ServerMessage { + /** + * Constructs a new ServerStartGame instance. + */ + public ServerStartGame() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/StartPiece.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/StartPiece.java index 902c467b..37baf781 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/StartPiece.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/StartPiece.java @@ -1,22 +1,61 @@ package pp.mdga.message.server; -public class StartPiece extends ServerMessage { +import com.jme3.network.serializing.Serializable; +/** + * A message sent by the server to the active player that he has to move a start piece. + */ +@Serializable +public class StartPiece extends ServerMessage { + /** + * The identifier for the piece. + */ private final String pieceIdentifier; + /** + * Constructs a new StartPiece instance with the specified piece identifier. + * + * @param pieceIdentifier the identifier for the piece + */ public StartPiece(String pieceIdentifier) { + super(); this.pieceIdentifier = pieceIdentifier; } + /** + * Gets the identifier for the piece. + * + * @return the piece identifier + */ public String getPieceIdentifier() { return pieceIdentifier; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateReady.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateReady.java index c7ad2593..cd728468 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateReady.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateReady.java @@ -1,29 +1,78 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.Color; +/** + * A message sent by the server to every client to update the readiness status of a player. + */ +@Serializable public class UpdateReady extends ServerMessage { - + /** + * The color associated with the update. + */ private final Color color; + + /** + * Indicates whether the player is ready. + */ private final boolean ready; + /** + * Constructs a new UpdateReady instance with the specified color and readiness status. + * + * @param color the color associated with the update + * @param ready the readiness status + */ public UpdateReady(Color color, boolean ready) { + super(); this.color = color; this.ready = ready; } + /** + * Gets the color associated with the update. + * + * @return the color + */ public Color getColor() { return color; } + /** + * Checks if the player is ready. + * + * @return true if the player is ready, false otherwise + */ public boolean isReady() { return ready; } + + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateTSK.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateTSK.java index e3280085..f8caa21f 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateTSK.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/UpdateTSK.java @@ -1,30 +1,77 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; import pp.mdga.game.Color; +/** + * A message sent by the server to every client to update the TSK. + */ +@Serializable public class UpdateTSK extends ServerMessage { - + /** + * The name associated with the update. + */ private final String name; + + /** + * The color associated with the update. + */ private final Color color; + /** + * Constructs a new UpdateTSK instance with the specified name and color. + * + * @param name the name associated with the update + * @param color the color associated with the update + */ public UpdateTSK(String name, Color color) { this.name = name; this.color = color; } + /** + * Gets the name associated with the update. + * + * @return the name + */ public String getName() { return name; } + /** + * Gets the color associated with the update. + * + * @return the color + */ public Color getColor() { return color; } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ @Override public void accept(ServerInterpreter interpreter) { - + interpreter.received(this); } + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return ""; diff --git a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/WaitPiece.java b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/WaitPiece.java index 41cd1151..5e32338a 100644 --- a/Projekte/mdga/model/src/main/java/pp.mdga/message/server/WaitPiece.java +++ b/Projekte/mdga/model/src/main/java/pp.mdga/message/server/WaitPiece.java @@ -1,11 +1,44 @@ package pp.mdga.message.server; +import com.jme3.network.serializing.Serializable; + +/** + * A message sent by the server to the active player to choose a piece from the waiting area. + */ +@Serializable public class WaitPiece extends ServerMessage { - @Override - public void accept(ServerInterpreter interpreter) { - + /** + * Constructs a new WaitPiece instance. + */ + public WaitPiece() { + super(); } + /** + * Accepts a visitor to process this message. + * + * @param interpreter the visitor to process this message + */ + @Override + public void accept(ServerInterpreter interpreter) { + interpreter.received(this); + } + + /** + * Returns a string representation of this message. + * + * @return a string representation of this message + */ + @Override + public String toString() { + return ""; + } + + /** + * Returns the key for the info text of this message. + * + * @return the key for the info text of this message + */ @Override public String getInfoTextKey() { return "";