Aleandro/Progetto-ingegneria-del-software
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #116 from rubenpirreram/Javadoc-fixed

Browse Source 
Javadoc fixed
This commit is contained in:
rubenpirreram
2026-05-20 19:23:46 +02:00
committed by GitHub
parent 28a4f7e17c b01ffd62b8
commit 1de5e74398
26 changed files with 361 additions and 267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/it/polimi/ingsw/gc14/Controller/ClientController.java
+80 -75
View File
@@ -1,42 +1,39 @@
package it.polimi.ingsw.gc14.Controller;
import it.polimi.ingsw.gc14.Model.*;
import it.polimi.ingsw.gc14.Model.GamePackage.Board;
import it.polimi.ingsw.gc14.Model.GamePackage.CurrentState;
import it.polimi.ingsw.gc14.Model.MiniModel;
import it.polimi.ingsw.gc14.Network.IClient;
import it.polimi.ingsw.gc14.Network.NetworkEvents.*;
import it.polimi.ingsw.gc14.View.IView;
import java.rmi.RemoteException;
import java.util.Map;
import java.util.Objects;
/**
* Controller class that holds all the components of the client, such as view, network client and Game Controller.
* It provides methods to set the client components and to execute requested actions.
* Controller responsible for coordinating the client-side components,
* including the view, the network client and the local mini model.
*
* <p>It receives user actions from the view, performs basic client-side
* checks and forwards valid requests to the network client.
*/
public class ClientController {
/** Game Controller of the client */
/** Local mini model representing the client-side game state. */
public MiniModel miniModel;
/** View of the client */
/** View of the client. */
public IView view;
/** Network client (either TCP or RMI) */
/** Network client, either TCP or RMI. */
private IClient client;
/**
* The username of the client associated with this event.
*/
/** Username associated with this client. */
public String myUsername;
/**
* Constructs the ClientController.
* Initializes all attributes.
* @param view the client view (either TUI or GUI)
* Constructs a client controller with the specified view.
*
* <p>The network client is initially unset and an empty local mini model
* is created.
*
* @param view the client view, either TUI or GUI.
*/
public ClientController(IView view) {
this.view = view;
@@ -44,19 +41,19 @@ public class ClientController {
this.miniModel = new MiniModel();
}
/**
* Sets the network client.
* @param client the client to set (either TCP or RMI)
*
* @param client the client to set, either TCP or RMI.
*/
public void setClient(IClient client) {
this.client = client;
}
/**
* Sets the model in the GameController and updates the view.
* @param model the model to set
* Sets the local mini model and updates the view accordingly.
*
* @param model the mini model to set.
*/
public void setModel(MiniModel model) {
this.miniModel = model;
@@ -64,7 +61,7 @@ public class ClientController {
}
/**
* Sets the username of the client associated with this event.
* Sets the username associated with this client.
*
* @param username the username to set.
*/
@@ -72,103 +69,112 @@ public class ClientController {
this.myUsername = username;
}
/**
* Displays an error message in the view.
* @param message the error message to display
*
* @param message the error message to display.
*/
public void onError(String message) {
view.showError(message);
}
/**
* Requests to draw a tribe card from the upper list.
* Creates a NetworkEvent and sends it through the network client.
* @param playerUsername the name of the player performing the action
* @param pos the index of the card to draw
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
* @param pos the index of the card to draw.
*/
public void drawUpperTribeCard(String playerUsername, int pos) {
if(!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName()))
{
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
}
else
{
} else {
client.drawUpperTribeCard(playerUsername, pos);
}
}
/**
* Requests to draw a tribe card from the lower list.
* Creates a NetworkEvent and sends it through the network client.
* @param playerUsername the name of the player performing the action
* @param pos the index of the card to draw
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
* @param pos the index of the card to draw.
*/
public void drawLowerTribeCard(String playerUsername, int pos) {
if(!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else
} else {
client.drawLowerTribeCard(playerUsername, pos);
}
}
/**
* Requests to draw a building card from the upper list.
* Creates a NetworkEvent and sends it through the network client.
* @param playerUsername the name of the player performing the action
* @param pos the index of the card to draw
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
* @param pos the index of the card to draw.
*/
public void drawUpperBuildingCard(String playerUsername, int pos) {
if(!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else {
} else {
client.drawUpperBuildingCard(playerUsername, pos);
}
}
/**
* Requests to draw a building card from the lower list.
* Creates a NetworkEvent and sends it through the network client.
* @param playerUsername the name of the player performing the action
* @param pos the index of the card to draw
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
* @param pos the index of the card to draw.
*/
public void drawLowerBuildingCard(String playerUsername, int pos) {
if(!Objects.equals(playerUsername,miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else {
} else {
client.drawLowerBuildingCard(playerUsername, pos);
}
}
/**
* Requests to skip turn .
* This action is available only when the player cannot draw any tribe card.
* @param playerUsername the name of the player performing the action
* Requests to skip the current turn.
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
*/
public void skipTurn(String playerUsername) {
if(!Objects.equals(playerUsername,miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else {
} else {
client.skipTurn(playerUsername);
}
}
/**
* Used to perform the slot choice action for the specified player at the specified position.
* @param playerUsername the name of the player performing the action
* @param pos the index of the selected slot
* Requests the selection of a slot by the specified player.
*
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the request is forwarded to the network client.
*
* @param playerUsername the username of the player performing the action.
* @param pos the index of the selected slot.
*/
public void slotChoice(String playerUsername, int pos) {
if(!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else {
} else {
client.slotChoice(playerUsername, pos);
}
}
@@ -176,19 +182,18 @@ public class ClientController {
/**
* Handles the selection of a totem by the specified player.
*
* <p>If the player is not the current one, an error message is shown.
* Otherwise, the selected totem is retrieved from the available totems
* and the choice is forwarded to the client.
* <p>If the specified player is not the current player, an error message
* is shown. Otherwise, the selected totem is retrieved from the available
* totems list and the choice is forwarded to the network client.
*
* @param playerUsername the username of the player making the choice.
* @param pos the position of the selected totem in the available totems list.
* @param pos the index of the selected totem in the available totems list.
*/
public void totemChoice(String playerUsername, int pos) {
if(!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName()))
if (!Objects.equals(playerUsername, miniModel.currentState.getCurrentPlayer().getUserName())) {
view.showError("It's not your turn!");
else {
} else {
client.totemChoice(playerUsername, String.valueOf(miniModel.availableTotems.get(pos)));
}
}
}
src/main/java/it/polimi/ingsw/gc14/Controller/GameController.java
+35 -25
View File
@@ -5,9 +5,10 @@ import it.polimi.ingsw.gc14.Model.Player;
import it.polimi.ingsw.gc14.Model.Totems;
/**
* Controller class that manages interactions between the client-side logic
* and the {@link Game} model.
* It provides methods to add players and to perform game actions by delegating them to the model.
* Controller responsible for managing interactions with the {@link Game} model.
*
* <p>It provides methods to update the game state by delegating player-related
* actions and game actions to the underlying model.
*/
public class GameController {
@@ -36,7 +37,8 @@ public class GameController {
*
* @param username the username of the player who disconnected.
* @return {@code true} if the disconnection is handled successfully,
* {@code false} if no player with the specified username exists.
* {@code false} if no player with the specified username exists
* or if the operation fails.
*/
public boolean DisconnectedPlayer(String username)
{
@@ -51,7 +53,8 @@ public class GameController {
*
* @param username the username of the player who reconnected.
* @return {@code true} if the reconnection is handled successfully,
* {@code false} if no player with the specified username exists.
* {@code false} if no player with the specified username exists
* or if the operation fails.
*/
public boolean ReconnectPlayer(String username)
{
@@ -83,19 +86,21 @@ public class GameController {
* Attempts to add a new player with the specified username to the game model.
*
* @param username the username of the player to add.
* @return {@code true} if the player is successfully added, {@code false} otherwise.
* @return {@code true} if the player is successfully added,
* {@code false} otherwise.
*/
public boolean addPlayer(String username) {
return model.addPlayer(new Player(username));
}
/**
* Attempts to draw an upper tribe card for the specified player from the specified position.
* Attempts to draw an upper tribe card for the specified player
* from the specified position.
*
* @param playerUsername the username of the player performing the action.
* @param pos the position of the upper tribe card to draw.
* @return {@code true} if the action succeeds, {@code false} if the player does not exist
* or if the draw operation fails.
* @return {@code true} if the action succeeds,
* {@code false} if the player does not exist or if the draw operation fails.
*/
public boolean drawUpperTribeCard(String playerUsername,int pos) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -105,12 +110,13 @@ public class GameController {
}
/**
* Attempts to draw a lower tribe card for the specified player from the specified position.
* Attempts to draw a lower tribe card for the specified player
* from the specified position.
*
* @param playerUsername the username of the player performing the action.
* @param pos the position of the lower tribe card to draw.
* @return {@code true} if the action succeeds, {@code false} if the player does not exist
* or if the draw operation fails.
* @return {@code true} if the action succeeds,
* {@code false} if the player does not exist or if the draw operation fails.
*/
public boolean drawLowerTribeCard(String playerUsername,int pos) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -120,12 +126,13 @@ public class GameController {
}
/**
* Attempts to draw an upper building card for the specified player from the specified position.
* Attempts to draw an upper building card for the specified player
* from the specified position.
*
* @param playerUsername the username of the player performing the action.
* @param pos the position of the upper building card to draw.
* @return {@code true} if the action succeeds, {@code false} if the player does not exist
* or if the draw operation fails.
* @return {@code true} if the action succeeds,
* {@code false} if the player does not exist or if the draw operation fails.
*/
public boolean drawUpperBuildingCard(String playerUsername,int pos) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -135,12 +142,13 @@ public class GameController {
}
/**
* Attempts to draw a lower building card for the specified player from the specified position.
* Attempts to draw a lower building card for the specified player
* from the specified position.
*
* @param playerUsername the username of the player performing the action.
* @param pos the position of the lower building card to draw.
* @return {@code true} if the action succeeds, {@code false} if the player does not exist
* or if the draw operation fails.
* @return {@code true} if the action succeeds,
* {@code false} if the player does not exist or if the draw operation fails.
*/
public boolean drawLowerBuildingCard(String playerUsername,int pos) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -153,9 +161,9 @@ public class GameController {
/**
* Skips the card drawing action for the specified player.
*
* @param playerUsername the username of the player who wants to skip the turn action.
* @return {@code true} if the skip action is valid and successfully performed;
* {@code false} if the player does not exist or the action is not valid.
* @param playerUsername the username of the player performing the action.
* @return {@code true} if the skip action is valid and successfully performed,
* {@code false} if the player does not exist or if the action is not valid.
*/
public boolean SkipTurn(String playerUsername) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -167,12 +175,13 @@ public class GameController {
/**
* Attempts to perform the slot choice action for the specified player at the specified position.
* Attempts to perform the slot choice action for the specified player
* at the specified position.
*
* @param playerUsername the username of the player performing the action.
* @param pos the position of the chosen slot.
* @return {@code true} if the action succeeds, {@code false} if the player does not exist
* or if the slot choice operation fails.
* @return {@code true} if the action succeeds,
* {@code false} if the player does not exist or if the slot choice operation fails.
*/
public boolean slotChoice(String playerUsername,int pos) {
Player player= model.getPlayerByUsername(playerUsername);
@@ -187,7 +196,8 @@ public class GameController {
* @param playerUsername the username of the player making the choice.
* @param totem the name of the selected totem.
* @return {@code true} if the choice is handled successfully,
* {@code false} if no player with the specified username exists.
* {@code false} if no player with the specified username exists
* or if the choice operation fails.
*/
public boolean TotemChoice(String playerUsername,String totem) {
Player player= model.getPlayerByUsername(playerUsername);
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building0.java
+44 -22
View File
@@ -8,28 +8,34 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
/**
* From the moment you buy this building, every time you complete a set of 6 different characters, you gain 5 food.
* Note: sets of characters already present before purchasing the building do not count.
* Building effect that grants 5 food for each new complete set of
* 6 different character types obtained after purchasing this building.
*
* <p>Character sets already completed before the building is purchased
* are stored during initialization and do not provide food.
*/
public class Building0 extends BuildingCard {
/**
* The purchased attribute is used to indicate whether the card has already been initialized.
* Indicates whether the building effect has already been initialized
* after purchase.
*/
boolean purchased ;
/**
* The numSet attribute indicates how many complete sets the player has.
* Number of complete character sets already counted by this building effect.
*/
private int numSet;
/**
* Constructor of the building.
* Creates a building with the specified image identifier, era, price
* and prestige value.
*
* @param idImage the image identifier of the building.
* @param era the game era of the building.
* @param price the price in food of the building.
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game.
* @param prestigeValue the number of Prestige Points granted by this building
* at the end of the game.
*/
public Building0(String idImage,int era,int price,int prestigeValue) {
super(idImage,era,price,prestigeValue);
@@ -40,10 +46,12 @@ public class Building0 extends BuildingCard {
}
/**
* Constructor of the building
* @param era The game era of the building.
* @param price The price (in food) of the building.
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
* Creates a building with the specified era, price and prestige value.
*
* @param era the game era of the building.
* @param price the price in food of the building.
* @param prestigeValue the number of Prestige Points granted by this building
* at the end of the game.
*/
public Building0(int era,int price,int prestigeValue) {
super(era,price,prestigeValue);
@@ -54,9 +62,12 @@ public class Building0 extends BuildingCard {
}
/**
* Method used to purchase the building. It also handles its initialization.
* @param player The player who buys the building.
* @return The outcome of the operation.
* Attempts to purchase the building and initializes its effect if the
* purchase succeeds.
*
* @param player the player who attempts to buy the building.
* @return {@code true} if the building is successfully purchased and initialized,
* {@code false} otherwise.
*/
@Override
public boolean buy(Player player)
@@ -68,9 +79,12 @@ public class Building0 extends BuildingCard {
}
/**
* Initializes the building by counting the number of complete sets at the moment of purchase.
* The building can only be initialized once.
* @param player The player who owns the building, whose cards are counted to determine the number of sets.
* Initializes the building effect by storing the number of complete
* character sets already owned by the player at the moment of purchase.
*
* <p>The initialization is performed only once.
*
* @param player the player who owns the building.
*/
public void initialize(Player player)
{
@@ -88,8 +102,13 @@ public class Building0 extends BuildingCard {
}
/**
* Method to clone the building: it creates an exact copy.
* @return The new copy of the building
* Creates a new building instance with the same configuration values
* as this card.
*
* <p>The runtime state of the effect, such as initialization status and
* counted character sets, is not copied.
*
* @return a new building card with the same base properties.
*/
@Override
public BuildingCard clone() {
@@ -97,10 +116,13 @@ public class Building0 extends BuildingCard {
}
/**
* Calculates the current number of card sets and subtracts the previous value (i.e., the number of newly obtained sets).
* The player gains an amount of food equal to 5 times this result.
* @param player The player who owns the building.
* @throws IllegalArgumentException thrown if the specified player does not own this card.
* Applies the building effect to the specified player.
*
* <p>The method counts the complete character sets currently owned by the player
* and grants 5 food for each set completed since the last stored value.
*
* @param player the player who owns the building.
* @throws IllegalArgumentException if the specified player does not own this card.
*/
@Override
public void applyEffect(Player player) throws IllegalArgumentException {
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java
+23 -20
View File
@@ -5,27 +5,31 @@ import it.polimi.ingsw.gc14.Model.Cards.BuildingCard;
import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
/**
* During the Sustenance Event, you have a discount of 1 food token on the total you
* would have to pay, for each of the indicated characters in your tribe.
* Building effect that grants a discount of 1 food during the Sustenance Event
* for each character of the indicated type present in the player's tribe.
*/
public class Building1 extends BuildingCard {
/**
* The icon attribute indicates the character type involved in the building effect.
* Character type involved in the building effect.
*/
private CharacterType icon ;
/**
* @return The character type associated with this building effect.
* Returns the character type associated with this building effect.
*
* @return the character type associated with this building effect.
*/
public CharacterType getIcon() {return icon;}
/**
* Constructor of the building.
* @param era The game era of the building.
* @param price The price (in food) of the building.
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
* @param icon The character type used by the building effect.
* Creates a building with the specified era, price, prestige value
* and character type involved in its effect.
*
* @param era the game era of the building.
* @param price the price in food of the building.
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game.
* @param icon the character type used by the building effect.
*/
public Building1(int era, int price,int prestigeValue, CharacterType icon) {
super(era,price,prestigeValue);
@@ -35,7 +39,8 @@ public class Building1 extends BuildingCard {
}
/**
* Constructor of the building.
* Creates a building with the specified image identifier, era, price,
* prestige value and character type involved in its effect.
*
* @param idIMG the image identifier of the building.
* @param era the game era of the building.
@@ -51,8 +56,10 @@ public class Building1 extends BuildingCard {
}
/**
* Method to clone the building: it creates an exact copy.
* @return The new copy of the building.
* Creates a new building instance with the same configuration values
* as this card.
*
* @return a new building card with the same base properties and icon.
*/
@Override
public BuildingCard clone() {
@@ -60,14 +67,10 @@ public class Building1 extends BuildingCard {
}
/**
* Prints a string representation of this {@code Building1}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* <p>includes:
* <li>{@link #icon Icon}
* </p>
* @return {@code String} - a string representation of this {@code Building1}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
* Returns a string representation of this building, including the character
* type associated with its effect.
*
* @return a string representation of this building.
*/
@Override
public String toString() {
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building10.java
+6 -4
View File
@@ -8,9 +8,10 @@ import it.polimi.ingsw.gc14.Model.Player;
import java.util.HashMap;
/**
* Represents the building card number 10.
* At the end of the game, the player gains 6 Prestige Points
* for each complete set of character types in their tribe.
*
* <p>This class defines the specific behavior and effects of building card 10.
* <p>A complete set contains one character card of each {@link CharacterType}.
*/
public class Building10 extends BuildingCard {
@@ -53,8 +54,9 @@ public class Building10 extends BuildingCard {
/**
* Applies the effect of this building card to the specified player.
* The effect grants 6 prestige points for each complete set of character cards.
* owned by the player, where a complete set contains one card of each.
*
* <p>The effect grants 6 Prestige Points for each complete set of character
* cards owned by the player, where a complete set contains one card of each
* {@link CharacterType}.
*
* @param player the player to whom the effect is applied.
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building11.java
+10 -13
View File
@@ -6,9 +6,11 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
import it.polimi.ingsw.gc14.Model.Player;
/**
* Represents the building card number 11.
* At the end of the game, the player gains Prestige Points based on the number
* of cards of the indicated character type in their tribe.
*
* <p>This class defines the specific behavior and effects of building card 11.
* <p>The gained amount is equal to the number of matching character cards
* multiplied by the building's prestige multiplier.
*/
public class Building11 extends BuildingCard {
@@ -85,8 +87,8 @@ public class Building11 extends BuildingCard {
* The effect grants prestige points equal to the number of cards of the
* associated CharacterType owned by the player, multiplied by the prestige multiplier.
*
* @param player the player to whom the effect is applied-
* @throws IllegalArgumentException if the player does not own this building card-
* @param player the player to whom the effect is applied.
* @throws IllegalArgumentException if the player does not own this building card.
*/
@Override
public void applyEffect(Player player) throws IllegalArgumentException {
@@ -96,15 +98,10 @@ public class Building11 extends BuildingCard {
}
/**
* Prints a string representation of this {@code Building1}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* <p>includes:
* <li>{@link #icon Icon}
* <li>{@link #PrestigeMul Prestige Multiplier}
* </p>
* @return {@code String} - a string representation of this {@code Building1}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
* Returns a string representation of this {@code Building11}, including the
* character type associated with its effect and its prestige multiplier.
*
* @return a string representation of this {@code Building11}.
*/
@Override
public String toString() {
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building13.java
+4 -4
View File
@@ -5,9 +5,8 @@ import it.polimi.ingsw.gc14.Model.Cards.BuildingCard;
import it.polimi.ingsw.gc14.Model.Player;
/**
* Represents the building card number 13.
*
* <p>This class defines the specific behavior and effects of building card 13.
* At the end of the game, this building grants 25 Prestige Points
* to the player who owns it.
*/
public class Building13 extends BuildingCard{
@@ -49,7 +48,8 @@ public class Building13 extends BuildingCard{
}
/**
* Applies the effect of this building card to the specified player.
* Applies the effect of this building card to the specified player,
* granting 25 Prestige Points.
*
* @param player the player to whom the effect is applied.
* @throws IllegalArgumentException if the player does not own this building card.
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building4.java
+35 -15
View File
@@ -8,23 +8,28 @@ import it.polimi.ingsw.gc14.Model.Player;
import java.util.HashMap;
/**
* From the moment you purchase this building, every time you obtain a pair of identical inventors, you gain 3 food.
* This effect doesn't apply to already owned pairs at the time of purchase.
* Building effect that grants 3 food for each new pair of identical inventors
* obtained after purchasing this building.
*
* <p>Pairs of identical inventors already owned at the moment of purchase
* are stored during initialization and do not provide food.
*/
public class Building4 extends BuildingCard {
/**
* The purchased attribute is used to indicate whether the card has already been initialized.
* Indicates whether the building effect has already been initialized
* after purchase.
*/
boolean purchased ;
/**
* The numPair attribute indicates how many pairs of inventors the player has.
* Number of inventor pairs already counted by this building effect.
*/
int numPair;
/**
* Constructor of the building
* Creates a building with the specified era, price and prestige value.
*
* @param era The game era of the building.
* @param price The price (in food) of the building.
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
@@ -36,7 +41,8 @@ public class Building4 extends BuildingCard {
}
/**
* Constructor of the building.
* Creates a building with the specified image identifier, era, price
* and prestige value.
*
* @param idIMG the image identifier of the building.
* @param era the game era of the building.
@@ -50,9 +56,12 @@ public class Building4 extends BuildingCard {
}
/**
* Initializes the building by counting the number of pairs of inventors at the moment of purchase.
* The building can only be initialized once.
* @param player the player who owns the building, whose inventors are counted to determine the number of pairs.
* Initializes the building effect by storing the number of pairs of identical
* inventors already owned by the player at the moment of purchase.
*
* <p>The initialization is performed only once.
*
* @param player the player who owns the building.
*/
public void initialize(Player player)
{
@@ -79,9 +88,12 @@ public class Building4 extends BuildingCard {
}
/**
* Method used to purchase the building. It also handles its initialization.
* Attempts to purchase the building and initializes its effect if the
* purchase succeeds.
*
* @param player The player who buys the building.
* @return The outcome of the operation.
* @return {@code true} if the building is successfully purchased and initialized,
* {@code false} otherwise.
*/
@Override
public boolean buy(Player player)
@@ -93,8 +105,13 @@ public class Building4 extends BuildingCard {
}
/**
* Method to clone the building: it creates an exact copy.
* @return The new copy of the building.
* Creates a new building instance with the same configuration values
* as this card.
*
* <p>The runtime state of the effect, such as initialization status and
* counted inventor pairs, is not copied.
*
* @return a new building card with the same base properties.
*/
@Override
public BuildingCard clone() {
@@ -102,8 +119,11 @@ public class Building4 extends BuildingCard {
}
/**
* Calculates the current number of pairs and subtracts the previous value (i.e., the number of newly obtained pairs).
* The player gains an amount of food equal to 3 times this result.
* Applies the building effect to the specified player.
*
* <p>The method counts the current number of pairs of identical inventors
* and grants 3 food for each pair obtained since the last stored value.
*
* @param player The player who owns the building.
* @throws IllegalArgumentException Thrown if the specified player does not own this card.
*/
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building8.java
+5 -1
View File
@@ -47,7 +47,11 @@ public class Building8 extends BuildingCard {
}
/**
* For each builder in the player's hand, the player gains double the Prestige Point indicated on the builder card.
* Applies the building effect by granting additional Prestige Points equal to
* the Prestige Value of each Builder card owned by the player.
*
* <p>This effectively doubles the contribution of Builder cards to the final score.
*
* @param player The player who owns the building.
* @throws IllegalArgumentException Thrown if the specified player does not own this building.
*/
src/main/java/it/polimi/ingsw/gc14/Model/Cards/BuildingCard.java
+14 -7
View File
@@ -102,8 +102,10 @@ public class BuildingCard extends PlayableCard implements Cloneable , BuildingEf
}
/**
* Creates a building card with the specified era, price, and prestige value.
* Creates a building card with the specified image identifier, era, price,
* and prestige value.
*
* @param idIMG the image identifier of the building card.
* @param era the era of the building card.
* @param price the price of the building card.
* @param prestigeValue the prestige value of the building card.
@@ -227,10 +229,12 @@ public class BuildingCard extends PlayableCard implements Cloneable , BuildingEf
/**
* Attempts to buy this building card for the specified player.
* The purchase succeeds only if the card has not already been bought
* and the player can pay its price in Food.
* If the purchase succeeds, the card is added to the player's building cards
* and marked as bought.
*
* <p>The effective cost is reduced by the total reduction value provided
* by the player's Builder cards, without dropping below zero. The purchase
* succeeds only if the card has not already been bought and the player can
* pay the resulting amount of Food. If successful, the card is added to
* the player's building cards and marked as bought.
*
* @param player the player attempting to buy the building card.
* @return {@code true} if the building card is successfully bought,
@@ -253,9 +257,12 @@ public class BuildingCard extends PlayableCard implements Cloneable , BuildingEf
}
/**
* Applies the effect of this building card to the specified player.
* Default implementation of the building effect.
*
* @param player the player to whom the effect is applied.
* <p>This method does not perform any operation and can be overridden
* by specific building cards that define an active effect.
*
* @param player the player to whom the effect may be applied.
*/
@Override
public void applyEffect(Player player){};
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Character.java
+4 -5
View File
@@ -5,7 +5,8 @@ import it.polimi.ingsw.gc14.Model.Player;
/**
* Abstract base class for all character cards.
* A Character is a {@link TribeCard} that is not an event card and is associated.
*
* <p>A Character is a {@link TribeCard} that is not an event card and is associated
* with a specific {@link CharacterType}.
*/
public abstract class Character extends TribeCard implements Cloneable {
@@ -77,8 +78,6 @@ public abstract class Character extends TribeCard implements Cloneable {
/**
* Returns the string representation of this character card.
* The returned string includes the string representation of the superclass
* and the string representation of the character type.
*
* @return the string representation of this character card.
*/
@@ -89,8 +88,8 @@ public abstract class Character extends TribeCard implements Cloneable {
/**
* Prints a string representation of this {@code Character}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* Returns a string representation of this {@code Character}. This specific variation is used in the {@code Game}'s
* toString to provide a more detailed version.
* <p>Includes:
* <li>{@link it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType Type}
* </p>
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java
+2 -2
View File
@@ -74,7 +74,8 @@ public class Artist extends Character {
}
/**
* Inserts this Artist card into the specified player's Artist collection.
* Inserts this Artist card into the specified player's Artist collection
* and applies any building effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
@@ -85,4 +86,3 @@ public class Artist extends Character {
}
}
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java
+6 -8
View File
@@ -143,13 +143,10 @@ public class Builder extends Character {
}
/**
* Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* <p>Includes:
* <li>{@link #reductionValue Reduction Value}
* <li>{@link #prestigeValue Prestige Value}
* </p>
* @return {@code String} - a string representation of this {@code TribeCard}.
* Returns a detailed string representation of this {@code Builder} card,
* including its reduction value and prestige value.
*
* @return a detailed string representation of this {@code Builder} card.
* @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
@@ -172,7 +169,8 @@ public class Builder extends Character {
}
/**
* Inserts this Builder card into the specified player's Builder collection.
* Inserts this Builder card into the specified player's Builder collection
* and applies any building effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java
+4 -3
View File
@@ -15,7 +15,7 @@ public class Gatherer extends Character {
/**
* Creates a Gatherer character card with the specified era.
*
* @param Era Gatherers era.
* @param Era the era of the Gatherer card.
*/
public Gatherer(int Era) {
super(Era, CharacterType.GATHERER);
@@ -32,7 +32,7 @@ public class Gatherer extends Character {
}
/**
* Creates a Gatherer character card with the specified era.
* Creates a Gatherer character card with the specified image id and era.
*
* @param idIMG the image identifier of the Gatherer card.
* @param Era the era of the Gatherer card.
@@ -74,7 +74,8 @@ public class Gatherer extends Character {
}
/**
* Inserts this Gatherer card into the specified player's Gatherer collection.
* Inserts this Gatherer card into the specified player's Gatherer collection
* and applies any building effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java
+9 -2
View File
@@ -93,11 +93,14 @@ public class Hunter extends Character {
}
/**
* Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* Returns a detailed string representation of this {@code TribeCard}.
* This specific variation is used in the {@code Game}'s
* toString to provide a more detailed version.
*
* <p>Potentially includes:
* <li>{@link #icon Icon}
* </p>
*
* @return {@code String} - a string representation of this {@code TribeCard}.
* @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
* @see it.polimi.ingsw.gc14.Model.Game Game
@@ -125,6 +128,10 @@ public class Hunter extends Character {
/**
* Inserts this Hunter card into the specified player's Hunter collection.
*
* <p>If this card has the Hunter icon, the player gains 1 food for each
* Hunter currently in their tribe. The method also applies any building
* effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
@Override
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java
+8 -2
View File
@@ -97,11 +97,14 @@ public class Inventor extends Character {
}
/**
* Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* Returns a detailed string representation of this {@code TribeCard}.
* This specific variation is used in the {@code Game}'s toString
* to provide a more detailed version.
*
* <p>Includes:
* <li>{@link #icon Icons's ID}
* </p>
*
* @return {@code String} - a string representation of this {@code TribeCard}.
* @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
* @see it.polimi.ingsw.gc14.Model.Game Game
@@ -125,6 +128,9 @@ public class Inventor extends Character {
/**
* Inserts this Inventor card into the specified player's Inventor collection.
*
* <p>The method also applies the building effects related to inventor pairs
* and any building effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
@Override
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java
+4 -3
View File
@@ -90,8 +90,8 @@ public class Shaman extends Character {
}
/**
* Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* Returns a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
* toString to provide a more detailed version.
* <p>Includes:
* <li>{@link #icon Number of stars}
* </p>
@@ -116,7 +116,8 @@ public class Shaman extends Character {
}
/**
* Inserts this Shaman card into the specified player's Shaman collection.
* Inserts this Shaman card into the specified player's Shaman collection
* and applies any building effects triggered by character set completion.
*
* @param player the player who receives the card.
*/
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/EventCard.java
+1 -3
View File
@@ -8,7 +8,7 @@ import java.lang.reflect.Array;
/**
* Abstract base class for all event cards.
* An EventCard is a {@link TribeCard} marked as an event card and associated.
* An EventCard is a {@link TribeCard} marked as an event card and associated
* with a specific {@link EventType}.
*/
public abstract class EventCard extends TribeCard {
@@ -101,5 +101,3 @@ public abstract class EventCard extends TribeCard {
// End Functions
}
src/main/java/it/polimi/ingsw/gc14/Model/DecksCreator.java
+2 -2
View File
@@ -202,7 +202,7 @@ public class DecksCreator {
/**
* Internal data class representing the raw definition of a tribe card as loaded from a JSON file.
* Contains the card type, era, whether it is armed, whether it is an event card,
* Contains the card identifier, type, era, whether it is armed, whether it is an event card,
* and a list of additional parameters.
*/
private static class TribeCardDefinition {
@@ -216,7 +216,7 @@ public class DecksCreator {
/**
* Internal data class representing the raw definition of a building card as loaded from a JSON file.
* Contains the effect ID, era, price, prestige value, and a list of additional parameters.
* Contains the card identifier, effect ID, era, price, prestige value, and a list of additional parameters.
*/
private static class BuildingCardDefinition {
String id;
src/main/java/it/polimi/ingsw/gc14/Model/GamePackage/Board.java
+5 -2
View File
@@ -25,7 +25,10 @@ public class Board implements Serializable {
/** tribeDeck is the deck from where you draw tribe cards as characters and events. */
private Queue<TribeCard> tribeDeck;
/** The upper row of tribe cards. There must be (num. of players + 4) character cards + Event cards */
/**
* The upper row of tribe cards. It contains a total of
* {@code nTotem + 4} tribe cards, which may include both character and event cards.
*/
public List<TribeCard> upperListTribe;
/**
@@ -38,7 +41,7 @@ public class Board implements Serializable {
/** Contains all the building cards of the upper list. When a new era starts, all its building cards are placed here */
public List<BuildingCard> upperListBuilding;
/** Contains all the building cards of the upper list. When a new era starts, the old era's buildings are moved from the upper to the lower list */
/** Contains all the building cards of the lower list. When a new era starts, the old era's buildings are moved from the upper to the lower list */
public List<BuildingCard> lowerListBuilding;
src/main/java/it/polimi/ingsw/gc14/Model/OrderLogicCard.java
+14 -5
View File
@@ -60,8 +60,12 @@ public abstract class OrderLogicCard implements Serializable {
}
/**
* Adds the player to the end of the queue, without effects.
* Moves the specified player to the end of the queue without applying effects.
*
* <p>Any previous occurrence of the player is removed from both the queue
* and the order list before the player is added again.
*
* @param player the player to be pushed into the queue.
*/
@@ -75,6 +79,9 @@ public abstract class OrderLogicCard implements Serializable {
/**
* Removes and returns the first player in the queue.
*
* <p>The first order entry that has not yet been marked as played
* is marked as played before removing the player from the queue.
*
* @return the first player in the queue, or {@code null} if the queue is empty.
*/
public Player pull(){
@@ -121,10 +128,12 @@ public abstract class OrderLogicCard implements Serializable {
}
/**
* TODO rifare javadoc
* Returns the {@code Player}'s position based on it's {@code Username}.
* @param username The desired {@code Player}'s username.
* @return {@code int} - the {@code Player}'s position.
* Returns the position of the player associated with the specified username
* within the current order list.
*
* @param username the username of the player whose position is requested.
* @return the player's position, or {@code -1} if no player with the specified
* username is present in the order list.
* @see Player
*/
public int getPosition(String username)
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order2.java
+1 -1
View File
@@ -32,7 +32,7 @@ public class Order2 extends OrderLogicCard {
/**
* Applies the effect associated with the specified position index for the given player.
* <p>If {@code index == 0}, the player gains 1 Food and the building effect is applied.
* <p>If {@code index == 1}, the player tries to remove 1 Food; if the player pay it,
* <p>If {@code index == 1}, the player tries to remove 1 Food; if the player cannot pay it,
* the player loses 2 Prestige.
*
* @param player the player to whom the effect is applied.
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order3.java
+1 -1
View File
@@ -33,7 +33,7 @@ public class Order3 extends OrderLogicCard {
* Applies the effect associated with the specified position index for the given player.
* <p>If {@code index == 0}, the player gains 2 Food and the building effect is applied.
* <p>If {@code index == 1}, no effect is applied.
* <p>If {@code index == 2}, the player tries to remove 1 Food; if the player pay it,
* <p>If {@code index == 2}, the player tries to remove 1 Food; if the player cannot pay it,
* the player loses 2 Prestige.
*
* @param player the player to whom the effect is applied.
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order4.java
+1 -1
View File
@@ -34,7 +34,7 @@ public class Order4 extends OrderLogicCard {
* <p>If {@code index == 0}, the player gains 2 Food and the building effect is applied.
* <p>If {@code index == 1}, the player gains 1 Food and the building effect is applied.
* <p>If {@code index == 2}, no effect is applied.
* <p>If {@code index == 3}, the player tries to remove 1 Food; if the player pay it,
* <p>If {@code index == 3}, the player tries to remove 1 Food; if the player cannot pay it,
* the player loses 2 Prestige.
*
* @param player the player to whom the effect is applied.
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order5.java
+1 -1
View File
@@ -35,7 +35,7 @@ public class Order5 extends OrderLogicCard {
* <p>If {@code index == 1}, the player gains 1 Food and the building effect is applied.
* <p>If {@code index == 2}, no effect is applied.
* <p>If {@code index == 3}, no effect is applied.
* <p>If {@code index == 4}, the player tries to remove 1 Food; if the player pay it,
* <p>If {@code index == 4}, the player tries to remove 1 Food; if the player cannot pay it,
* the player loses 2 Prestige.
*
* @param player the player to whom the effect is applied.
src/main/java/it/polimi/ingsw/gc14/Model/Player.java
+9 -7
View File
@@ -149,15 +149,16 @@ public class Player implements Serializable {
/**
* Removes {@code Value} amount of {@code Food} from the Player.
* Note: {@link #FoodValue} cannot be negative, so the method will
* return {@code False} if {@code Value} is greater than the
* amount of {@code Food} the Player possesses, {@code False} otherwise.
* Note: {@link #FoodValue} cannot be negative, so the method returns
* {@code false} if {@code Value} is greater than the amount of {@code Food}
* the Player possesses, and {@code true} otherwise.
*
* @param Value The amount of {@code Food} to be removed.
* Should be positive for expected results
* (otherwise the method will add the absolute
* value of {@code Value}).
* @return {@code Boolean} - {@code True} if {@code Value} is greater than
* the amount of {@code Food} the Player possesses, {@code False} otherwise.
* @return {@code Boolean} - {@code true} if the Food is successfully removed,
* {@code false} otherwise.
* @see #FoodValue
*/
public Boolean removeFood(int Value){
@@ -200,10 +201,11 @@ public class Player implements Serializable {
/**
* Constructor for the class {@code Player}. Each Player is uniquely identified by the {@link #UserName}.
*
* @param UserName Unique String identifier for a Player.
* @throws IllegalArgumentException When {@code UserName} is {@code null} or exceeds {@link #MAX_VALUE}
* @throws IllegalArgumentException when {@code UserName} is empty or exceeds {@link #MAX_VALUE},
* with message:
* <pre>{@code UserName is empty or exceeds maximum permitted length.}<pre>
* <pre>{@code UserName is empty or exceeds maximum permitted length.}</pre>
*
* @see #UserName
* @see #MAX_VALUE