From 18bea10f02bf8312383f8267b1c0c94aae507952 Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:00:53 +0200 Subject: [PATCH] Add: JavaDoc for Builder class --- .../Cards/TribeCards/Characters/Artist.java | 3 --- .../Cards/TribeCards/Characters/Builder.java | 10 ------- .../Cards/TribeCards/Characters/Gatherer.java | 27 ++++++++++++++++++- 3 files changed, 26 insertions(+), 14 deletions(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java index 78453ff..9eb41f6 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java @@ -30,7 +30,6 @@ public class Artist extends Character { * * @return the string representation of this Artist card */ - @Override public String toString() { return super.toString(); @@ -41,7 +40,6 @@ public class Artist extends Character { * * @return a clone of this Artist card */ - @Override public Character clone() { return new Artist(getEra(), getNMin()); @@ -52,7 +50,6 @@ public class Artist extends Character { * * @param player the player who receives the card */ - @Override public void insert(Player player) { player.artists.add(this); diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java index 55fd721..6a51b3c 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java @@ -10,13 +10,11 @@ public class Builder extends Character /** * The reduction valure provided by this Builder card. */ - private int reductionValue; /** * The prestige value provided by this Builder card. */ - private int prestigeValue; /** @@ -24,7 +22,6 @@ public class Builder extends Character * * @return the reduction value of this Builder card */ - public int getReductionValue() { return reductionValue; } @@ -34,7 +31,6 @@ public class Builder extends Character * * @return the prestige value of this Builder card */ - public int getPrestigeValue() { return prestigeValue; } @@ -48,7 +44,6 @@ public class Builder extends Character * @param prestigeValue the prestige value of the Builder card * @throws IllegalArgumentException if {@code reductionValue < 0} or {@code prestigeValue < 0} */ - public Builder(int Era, int reductionValue, int prestigeValue) throws IllegalArgumentException { super(Era,CharacterType.BUILDER); if(reductionValue < 0) { @@ -72,8 +67,6 @@ public class Builder extends Character * @param nMin the minimum number of players required for the card * @throws IllegalArgumentException if {@code reductionValue < 0} or {@code prestigeValue < 0} */ - - public Builder(int Era, int reductionValue, int prestigeValue,int nMin) throws IllegalArgumentException { super(Era,CharacterType.BUILDER,nMin); if(reductionValue < 0) { @@ -92,7 +85,6 @@ public class Builder extends Character * * @return the string representation of this Builder card */ - @Override public String toString() { return super.toString()+" Reduction Value: " + String.valueOf(reductionValue) + "\n Prestige Value: " + String.valueOf(prestigeValue); } @@ -101,7 +93,6 @@ public class Builder extends Character * * @return a clone of this Builder card */ - @Override public Character clone() { return new Builder(getEra(),getReductionValue(), getPrestigeValue(), getNMin()); @@ -112,7 +103,6 @@ public class Builder extends Character * * @param player the player who receives the card */ - public void insert(Player player) { player.builders.add(this); } diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java index ce4016f..740828a 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java @@ -7,24 +7,49 @@ import it.polimi.ingsw.gc14.Model.Player; public class Gatherer extends Character { /** + * Creates a Gatherer character card with the specified era. * - * @param Era gatherers era + * @param Era Gatherers era */ public Gatherer(int Era) { super(Era, CharacterType.GATHERER); } + + /** + * Creates a Gatherer character card with the specified era and minimum number of players. + * + * @param Era the era of the Gatherer card + * @param nMin the minimum number of players required for the card + */ public Gatherer(int Era, int nMin) { super(Era, CharacterType.GATHERER,nMin); } + + /** + * Returns the string representation of this Gatherer card. + * + * @return the string representation of this Gatherer card + */ @Override public String toString() { return super.toString(); } + /** + * Creates and returns a copy of this Gatherer card. + * + * @return a clone of this Gatherer card + */ @Override public Character clone() { return new Gatherer(getEra(), getNMin()); } + + /** + * Inserts this Gatherer card into the specified player's Gatherer collection. + * + * @param player the player who receives the card + */ public void insert(Player player) { player.gatherers.add(this); }