From 21c1a6353bc9315640df056b8022897eb3ef738e Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 16:17:10 +0200 Subject: [PATCH 1/8] Add: JavaDoc for Artist class --- .../Cards/TribeCards/Characters/Artist.java | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) 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 7c3cb8b..78453ff 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 @@ -7,26 +7,52 @@ import it.polimi.ingsw.gc14.Model.Player; public class Artist extends Character { /** + * Creates an Artist character card with the specified era. * - * param Era artist era + * @param Era the era of the Artist card */ public Artist(int Era) { super(Era, CharacterType.ARTIST); } + + /** + * Creates an Artist character card with the specified Era and minimum number of players. + * + * @param Era the era of the Artist card + * @param nMin the minimum number of players required for the card + */ public Artist(int Era,int nMin) { super(Era, CharacterType.ARTIST,nMin); } + /** + * Returns the string representation of this Artist card. + * + * @return the string representation of this Artist card + */ + @Override public String toString() { return super.toString(); } + /** + * Creates and returns a copy of this Artist card. + * + * @return a clone of this Artist card + */ + @Override public Character clone() { return new Artist(getEra(), getNMin()); } + /** + * Inserts this Artist card into the specified player's Artist collection. + * + * @param player the player who receives the card + */ + @Override public void insert(Player player) { player.artists.add(this); From 53e9c55d7a53e159b7732a40c58c54aaeb895f95 Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 16:48:45 +0200 Subject: [PATCH 2/8] Add: JavaDoc for Builder class --- .../Cards/TribeCards/Characters/Builder.java | 69 +++++++++++++++++-- 1 file changed, 65 insertions(+), 4 deletions(-) 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 c5fb17a..55fd721 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 @@ -6,19 +6,49 @@ import it.polimi.ingsw.gc14.Model.Player; public class Builder extends Character { - private int reductionValue; - private int prestigeValue; + /** - * - * @return Builder specific reduction value + * The reduction valure provided by this Builder card. */ + + private int reductionValue; + + /** + * The prestige value provided by this Builder card. + */ + + private int prestigeValue; + + /** + * Returns the reduction value of this Builder card. + * + * @return the reduction value of this Builder card + */ + public int getReductionValue() { return reductionValue; } + + /** + * Returns the prestige value of this Builder card. + * + * @return the prestige value of this Builder card + */ + public int getPrestigeValue() { return prestigeValue; } + /** + * Creates a Builder character card with the specified era, reduction value, + * and prestige value. + * + * @param Era the era of the Builder card + * @param reductionValue the reduction value of the Builder card + * @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) { @@ -32,6 +62,18 @@ public class Builder extends Character this.prestigeValue = prestigeValue; } + /** + * Creates a Builder character card with the specified era, reduction value, + * prestige value, and minimum number of players. + * + * @param Era the era of the Builder card + * @param reductionValue the reduction value of the Builder card + * @param prestigeValue the prestige value of the Builder card + * @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) { @@ -44,14 +86,33 @@ public class Builder extends Character } this.prestigeValue = prestigeValue; } + + /** + * Returns the string representation of this Builder card. + * + * @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); } + /** + * Creates and returns a copy of this Builder card. + * + * @return a clone of this Builder card + */ + @Override public Character clone() { return new Builder(getEra(),getReductionValue(), getPrestigeValue(), getNMin()); } + /** + * Inserts this Builder card into the specified player's Builder collection. + * + * @param player the player who receives the card + */ + public void insert(Player player) { player.builders.add(this); } From 18bea10f02bf8312383f8267b1c0c94aae507952 Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:00:53 +0200 Subject: [PATCH 3/8] 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); } From 2c8f578b88b9c82f82ff71653bb7262c77401132 Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:00:53 +0200 Subject: [PATCH 4/8] Fix: fixed typos. Add: JavaDoc for Gatherer 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); } From f4d0dad8ec1260ce3bc5fa5ed98acd760cd15b88 Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:22:17 +0200 Subject: [PATCH 5/8] Add: JavaDoc for Hunter class --- .../Cards/TribeCards/Characters/Hunter.java | 35 ++++++++++++++++--- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java index 8fc09b2..6c1d00d 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java @@ -4,40 +4,67 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.Character; import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType; import it.polimi.ingsw.gc14.Model.Player; -public class Hunter extends Character { +public class Hunter extends Character { private boolean icon; /** + * Returns whether this Hunter card has the icon. * - * @return Hunter specific icon + * @return {@code true} if this Hunter card has the icon, {@code false} otherwise */ public boolean getIcon() { return icon; } /** + * Creates a Hunter character card with the specified era and icon value. * - * @param Era hunter era - * @param icon hunter icon + * @param Era the era of the Hunter card + * @param icon the icon value of the Hunter card */ public Hunter(int Era, boolean icon) { super(Era, CharacterType.HUNTER); this.icon = icon; } + + /** + * Creates a Hunter character card with the specified era, icon value, + * and minimum number of players. + * + * @param Era the era of the Hunter card + * @param icon the icon value of the Hunter card + * @param nMin the minimum number of players required for the card + */ public Hunter(int Era, boolean icon, int nMin) { super(Era, CharacterType.HUNTER,nMin); this.icon = icon; } + /** + * Returns the string representation of this Hunter card. + * + * @return the string representation of this Hunter card + */ @Override public String toString() { return super.toString() + "Icon: " + String.valueOf(icon); } + /** + * Creates and returns a copy of this Hunter card. + * + * @return a clone of this Hunter card + */ @Override public Character clone() { return new Hunter(getEra(), getIcon(), getNMin()); } + + /** + * Inserts this Hunter card into the specified player's Hunter collection. + * + * @param player the player who receives the card + */ @Override public void insert(Player player) { player.hunters.add(this); From 6a96e24e115a9734bc24cd2af7787c82ca8ee33e Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:30:23 +0200 Subject: [PATCH 6/8] Add: JavaDoc for Inventor class --- .../Cards/TribeCards/Characters/Inventor.java | 37 +++++++++++++++++-- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java index 28a81c3..5da8d78 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java @@ -7,18 +7,20 @@ public class Inventor extends Character { private int icon; /** + * Returns the icon value of this Inventor card. * - * @return Inventor Specific Symbol + * @return the icon value of this Inventor card */ public int Icon() { return icon; } /** + * Creates an Inventor character card with the specified era and icon value. * - * @param Era inventor era - * @param icon inventor symbol - * @throws IllegalArgumentException + * @param Era the era of the Inventor card + * @param icon the icon value of the Inventor card + * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9} */ public Inventor(int Era,int icon) throws IllegalArgumentException { super(Era, CharacterType.INVENTOR); @@ -26,21 +28,48 @@ public class Inventor extends Character { throw new IllegalArgumentException(); this.icon = icon; } + + /** + * Creates an Inventor character card with the specified era, icon value, + * and minimum number of players. + * + * @param Era the era of the Inventor card + * @param icon the icon value of the Inventor card + * @param nMin the minimum number of players required for the card + * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9} + */ public Inventor(int Era,int icon,int nMin) throws IllegalArgumentException { super(Era, CharacterType.INVENTOR,nMin); if(icon<0 || icon>9) throw new IllegalArgumentException(); this.icon = icon; } + + /** + * Returns the string representation of this Inventor card. + * + * @return the string representation of this Inventor card + */ @Override public String toString() { return super.toString() + " Symbol:" + String.valueOf(icon); } + /** + * Creates and returns a copy of this Inventor card. + * + * @return a clone of this Inventor card + */ @Override public Character clone() { return new Inventor(getEra(),icon, getNMin()); } + + /** + * Inserts this Inventor card into the specified player's Inventor collection. + * + * @param player the player who receives the card + */ @Override public void insert(Player player) { player.inventors.add(this); From 9686424f389a1b6005f22863c2944bdd3fba8dcd Mon Sep 17 00:00:00 2001 From: MatteoPellegrino05 Date: Sun, 12 Apr 2026 17:39:56 +0200 Subject: [PATCH 7/8] Add: JavaDoc for Shaman class --- .../Cards/TribeCards/Characters/Shaman.java | 35 ++++++++++++++++--- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java index 6c71208..8fdce5c 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java @@ -10,36 +10,63 @@ public class Shaman extends Character { private int icon; /** + * Returns the icon value of this Shaman card. * - * @return Shaman specific icon + * @return the icon value of this Shaman card */ public int getIcon() { return icon; } /** + * Creates a Shaman character card with the specified era and icon value. * - * @param Era shaman era - * @param icon shaman icon + * @param Era the era of the Shaman card + * @param icon the icon value of the Shaman card */ public Shaman(int Era, int icon) { super(Era, CharacterType.SHAMAN); this.icon = icon; } + + /** + * Creates a Shaman character card with the specified era, icon value, + * and minimum number of players. + * + * @param Era the era of the Shaman card + * @param icon the icon value of the Shaman card + * @param nMin the minimum number of players required for the card + */ public Shaman(int Era, int icon, int nMin) { super(Era, CharacterType.SHAMAN,nMin); this.icon = icon; } + + /** + * Returns the string representation of this Shaman card. + * + * @return the string representation of this Shaman card + */ @Override public String toString() { - return super.toString() + "icon: " + String.valueOf(icon); + return super.toString() + "Icon: " + String.valueOf(icon); } + /** + * Creates and returns a copy of this Shaman card. + * + * @return a clone of this Shaman card + */ @Override public Character clone() { return new Shaman(getEra(), getIcon(), getNMin()); } + /** + * Inserts this Shaman card into the specified player's Shaman collection. + * + * @param player the player who receives the card + */ @Override public void insert(Player player) { From 8f78834c6932156b93e8d59a1b87aff6ee8a0a99 Mon Sep 17 00:00:00 2001 From: GabrieleRadice <265572328+GabrieleRadice@users.noreply.github.com> Date: Sun, 12 Apr 2026 18:13:40 +0200 Subject: [PATCH 8/8] Fix: Artist.java, Shaman.java, Gatherer.java, Hunter.java, Inventor.java, Shaman.java Fixed Typos. --- .../Cards/TribeCards/Characters/Artist.java | 8 ++--- .../Cards/TribeCards/Characters/Builder.java | 30 +++++++++---------- .../Cards/TribeCards/Characters/Gatherer.java | 12 ++++---- .../Cards/TribeCards/Characters/Hunter.java | 18 +++++------ .../Cards/TribeCards/Characters/Inventor.java | 22 +++++++------- .../Cards/TribeCards/Characters/Shaman.java | 18 +++++------ 6 files changed, 54 insertions(+), 54 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 9eb41f6..8276fb0 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 @@ -16,7 +16,7 @@ public class Artist extends Character { } /** - * Creates an Artist character card with the specified Era and minimum number of players. + * Creates an Artist character card with the specified Era and minimum number of players required to play it. * * @param Era the era of the Artist card * @param nMin the minimum number of players required for the card @@ -28,7 +28,7 @@ public class Artist extends Character { /** * Returns the string representation of this Artist card. * - * @return the string representation of this Artist card + * @return the string representation of this Artist card. */ @Override public String toString() { @@ -38,7 +38,7 @@ public class Artist extends Character { /** * Creates and returns a copy of this Artist card. * - * @return a clone of this Artist card + * @return a clone of this Artist card. */ @Override public Character clone() { @@ -48,7 +48,7 @@ public class Artist extends Character { /** * Inserts this Artist card into the specified player's Artist collection. * - * @param player the player who receives the card + * @param player the player who receives the card. */ @Override public void insert(Player player) { 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 6a51b3c..3fb9706 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 @@ -8,7 +8,7 @@ public class Builder extends Character { /** - * The reduction valure provided by this Builder card. + * The reduction value provided by this Builder card. */ private int reductionValue; @@ -20,7 +20,7 @@ public class Builder extends Character /** * Returns the reduction value of this Builder card. * - * @return the reduction value of this Builder card + * @return the reduction value of this Builder card. */ public int getReductionValue() { return reductionValue; @@ -29,7 +29,7 @@ public class Builder extends Character /** * Returns the prestige value of this Builder card. * - * @return the prestige value of this Builder card + * @return the prestige value of this Builder card. */ public int getPrestigeValue() { return prestigeValue; @@ -39,10 +39,10 @@ public class Builder extends Character * Creates a Builder character card with the specified era, reduction value, * and prestige value. * - * @param Era the era of the Builder card - * @param reductionValue the reduction value of the Builder card - * @param prestigeValue the prestige value of the Builder card - * @throws IllegalArgumentException if {@code reductionValue < 0} or {@code prestigeValue < 0} + * @param Era the era of the Builder card. + * @param reductionValue the reduction value of the Builder card. + * @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); @@ -61,11 +61,11 @@ public class Builder extends Character * Creates a Builder character card with the specified era, reduction value, * prestige value, and minimum number of players. * - * @param Era the era of the Builder card - * @param reductionValue the reduction value of the Builder card - * @param prestigeValue the prestige value of the Builder card - * @param nMin the minimum number of players required for the card - * @throws IllegalArgumentException if {@code reductionValue < 0} or {@code prestigeValue < 0} + * @param Era the era of the Builder card. + * @param reductionValue the reduction value of the Builder card. + * @param prestigeValue the prestige value of the Builder card. + * @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); @@ -83,7 +83,7 @@ public class Builder extends Character /** * Returns the string representation of this Builder card. * - * @return the string representation of this Builder card + * @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); } @@ -91,7 +91,7 @@ public class Builder extends Character /** * Creates and returns a copy of this Builder card. * - * @return a clone of this Builder card + * @return a clone of this Builder card. */ @Override public Character clone() { @@ -101,7 +101,7 @@ public class Builder extends Character /** * Inserts this Builder card into the specified player's Builder collection. * - * @param player the player who receives the card + * @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 740828a..f74149b 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 @@ -9,7 +9,7 @@ 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); @@ -18,8 +18,8 @@ public class Gatherer extends Character { /** * 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 + * @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); @@ -28,7 +28,7 @@ public class Gatherer extends Character { /** * Returns the string representation of this Gatherer card. * - * @return the string representation of this Gatherer card + * @return the string representation of this Gatherer card. */ @Override public String toString() { @@ -38,7 +38,7 @@ public class Gatherer extends Character { /** * Creates and returns a copy of this Gatherer card. * - * @return a clone of this Gatherer card + * @return a clone of this Gatherer card. */ @Override public Character clone() { @@ -48,7 +48,7 @@ public class Gatherer extends Character { /** * Inserts this Gatherer card into the specified player's Gatherer collection. * - * @param player the player who receives the card + * @param player the player who receives the card. */ public void insert(Player player) { player.gatherers.add(this); diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java index 6c1d00d..b956a18 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java @@ -10,7 +10,7 @@ public class Hunter extends Character { /** * Returns whether this Hunter card has the icon. * - * @return {@code true} if this Hunter card has the icon, {@code false} otherwise + * @return {@code true} if this Hunter card has the icon, {@code false} otherwise. */ public boolean getIcon() { return icon; @@ -19,8 +19,8 @@ public class Hunter extends Character { /** * Creates a Hunter character card with the specified era and icon value. * - * @param Era the era of the Hunter card - * @param icon the icon value of the Hunter card + * @param Era the era of the Hunter card. + * @param icon the icon value of the Hunter card. */ public Hunter(int Era, boolean icon) { super(Era, CharacterType.HUNTER); @@ -31,9 +31,9 @@ public class Hunter extends Character { * Creates a Hunter character card with the specified era, icon value, * and minimum number of players. * - * @param Era the era of the Hunter card - * @param icon the icon value of the Hunter card - * @param nMin the minimum number of players required for the card + * @param Era the era of the Hunter card. + * @param icon the icon value of the Hunter card. + * @param nMin the minimum number of players required for the card. */ public Hunter(int Era, boolean icon, int nMin) { super(Era, CharacterType.HUNTER,nMin); @@ -43,7 +43,7 @@ public class Hunter extends Character { /** * Returns the string representation of this Hunter card. * - * @return the string representation of this Hunter card + * @return the string representation of this Hunter card. */ @Override public String toString() { @@ -53,7 +53,7 @@ public class Hunter extends Character { /** * Creates and returns a copy of this Hunter card. * - * @return a clone of this Hunter card + * @return a clone of this Hunter card. */ @Override public Character clone() { @@ -63,7 +63,7 @@ public class Hunter extends Character { /** * Inserts this Hunter card into the specified player's Hunter collection. * - * @param player the player who receives the card + * @param player the player who receives the card. */ @Override public void insert(Player player) { diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java index 5da8d78..d8c5f45 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java @@ -9,7 +9,7 @@ public class Inventor extends Character { /** * Returns the icon value of this Inventor card. * - * @return the icon value of this Inventor card + * @return the icon value of this Inventor card. */ public int Icon() { return icon; @@ -18,9 +18,9 @@ public class Inventor extends Character { /** * Creates an Inventor character card with the specified era and icon value. * - * @param Era the era of the Inventor card - * @param icon the icon value of the Inventor card - * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9} + * @param Era the era of the Inventor card. + * @param icon the icon value of the Inventor card. + * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9}. */ public Inventor(int Era,int icon) throws IllegalArgumentException { super(Era, CharacterType.INVENTOR); @@ -33,10 +33,10 @@ public class Inventor extends Character { * Creates an Inventor character card with the specified era, icon value, * and minimum number of players. * - * @param Era the era of the Inventor card - * @param icon the icon value of the Inventor card - * @param nMin the minimum number of players required for the card - * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9} + * @param Era the era of the Inventor card. + * @param icon the icon value of the Inventor card. + * @param nMin the minimum number of players required for the card. + * @throws IllegalArgumentException if {@code icon < 0} or {@code icon > 9}. */ public Inventor(int Era,int icon,int nMin) throws IllegalArgumentException { super(Era, CharacterType.INVENTOR,nMin); @@ -48,7 +48,7 @@ public class Inventor extends Character { /** * Returns the string representation of this Inventor card. * - * @return the string representation of this Inventor card + * @return the string representation of this Inventor card. */ @Override public String toString() { @@ -58,7 +58,7 @@ public class Inventor extends Character { /** * Creates and returns a copy of this Inventor card. * - * @return a clone of this Inventor card + * @return a clone of this Inventor card. */ @Override public Character clone() { @@ -68,7 +68,7 @@ public class Inventor extends Character { /** * Inserts this Inventor card into the specified player's Inventor collection. * - * @param player the player who receives the card + * @param player the player who receives the card. */ @Override public void insert(Player player) { diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java index 8fdce5c..b04098f 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java @@ -12,7 +12,7 @@ public class Shaman extends Character { /** * Returns the icon value of this Shaman card. * - * @return the icon value of this Shaman card + * @return the icon value of this Shaman card. */ public int getIcon() { return icon; @@ -21,8 +21,8 @@ public class Shaman extends Character { /** * Creates a Shaman character card with the specified era and icon value. * - * @param Era the era of the Shaman card - * @param icon the icon value of the Shaman card + * @param Era the era of the Shaman card. + * @param icon the icon value of the Shaman card. */ public Shaman(int Era, int icon) { super(Era, CharacterType.SHAMAN); @@ -33,9 +33,9 @@ public class Shaman extends Character { * Creates a Shaman character card with the specified era, icon value, * and minimum number of players. * - * @param Era the era of the Shaman card - * @param icon the icon value of the Shaman card - * @param nMin the minimum number of players required for the card + * @param Era the era of the Shaman card. + * @param icon the icon value of the Shaman card. + * @param nMin the minimum number of players required for the card. */ public Shaman(int Era, int icon, int nMin) { super(Era, CharacterType.SHAMAN,nMin); @@ -45,7 +45,7 @@ public class Shaman extends Character { /** * Returns the string representation of this Shaman card. * - * @return the string representation of this Shaman card + * @return the string representation of this Shaman card. */ @Override public String toString() { @@ -55,7 +55,7 @@ public class Shaman extends Character { /** * Creates and returns a copy of this Shaman card. * - * @return a clone of this Shaman card + * @return a clone of this Shaman card. */ @Override public Character clone() { @@ -65,7 +65,7 @@ public class Shaman extends Character { /** * Inserts this Shaman card into the specified player's Shaman collection. * - * @param player the player who receives the card + * @param player the player who receives the card. */ @Override public void insert(Player player)