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

Merge pull request #59 from rubenpirreram/javadoc-fixes

Browse Source 
Javadoc fixes
This commit is contained in:
rubenpirreram
2026-04-30 20:11:20 +02:00
committed by GitHub
parent e3ddd92627 c2e879724e
commit 7f60ec56be
39 changed files with 352 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/it/polimi/ingsw/gc14/ClientLauncherTUI.java
+1
View File
@@ -8,6 +8,7 @@ import it.polimi.ingsw.gc14.View.TUI.TUI;
import java.util.Scanner;
public class ClientLauncherTUI {
//TODO Javadoc
public void main() throws InterruptedException {
TUI view=new TUI(null);
ClientController controller = new ClientController(view);
src/main/java/it/polimi/ingsw/gc14/Controller/ClientController.java
+3
View File
@@ -7,9 +7,12 @@ import it.polimi.ingsw.gc14.Network.NetworkEvents.*;
import it.polimi.ingsw.gc14.Network.Observer;
import it.polimi.ingsw.gc14.View.IView;
//TODO Javadoc
public class ClientController {
public GameController localController;
//TODO Javadoc
public IView view=null;
private IClient client;
src/main/java/it/polimi/ingsw/gc14/LimitedList.java
+9
View File
@@ -2,15 +2,21 @@ package it.polimi.ingsw.gc14;
import java.util.ArrayList;
//TODO Javadoc
public class LimitedList<T> extends ArrayList<T> {
//TODO Javadoc
private int limit;
//TODO Javadoc
private Runnable action;
//TODO Javadoc
public LimitedList(int limit, Runnable action) {
this.limit = limit;
this.action = action;
}
//TODO Javadoc
@Override
public boolean add(T element) {
boolean result = super.add(element);
@@ -20,12 +26,15 @@ public class LimitedList<T> extends ArrayList<T> {
return result;
}
//TODO Javadoc
public void setLimit(int num) {
this.limit=num;
}
//TODO Javadoc
public int getLimit(){return limit;}
//TODO Javadoc
public void setAction(Runnable action) {
this.action=action;
}
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java
+10 -1
View File
@@ -4,7 +4,6 @@ import it.polimi.ingsw.gc14.Model.Cards.Building.EffectType;
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.
@@ -44,6 +43,16 @@ public class Building1 extends BuildingCard {
return new Building1(getEra(),getPrice(),getPrestigeValue(),getIcon());
}
/**
* 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
*/
@Override
public String toString() {
return super.toString() + " Icon: " + this.icon.toString().charAt(0);
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building11.java
+14
View File
@@ -7,6 +7,9 @@ import it.polimi.ingsw.gc14.Model.Player;
public class Building11 extends BuildingCard {
/**
* The icon attribute indicates the character type involved in the building effect.
*/
private CharacterType icon ;
/**
@@ -68,6 +71,17 @@ public class Building11 extends BuildingCard {
player.addPrestige(player.getNType(getIcon()) * this.getPrestigeMul());
}
/**
* 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
*/
@Override
public String toString() {
return super.toString() + " Icon: " + this.icon.toString().charAt(0) + " MP: " + this.PrestigeMul;
src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building13.java
-1
View File
@@ -5,7 +5,6 @@ import it.polimi.ingsw.gc14.Model.Cards.BuildingCard;
import it.polimi.ingsw.gc14.Model.Player;
public class Building13 extends BuildingCard{
/**
* Creates a Building13 card with the specified era, price, and prestige value.
*
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Character.java
+11
View File
@@ -60,6 +60,17 @@ public abstract class Character extends TribeCard implements Cloneable {
return super.toString();
}
/**
* 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.
* <p>Includes:
* <li>{@link it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType Type}
* </p>
* @return {@code String} - a string representation of this {@code Character}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard()
{
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java
+14 -3
View File
@@ -4,9 +4,7 @@ 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 Builder extends Character
{
public class Builder extends Character {
/**
* The reduction value provided by this Builder card.
*/
@@ -89,6 +87,19 @@ public class Builder extends Character
public String toString() {
return super.toString() + " RV:" + String.valueOf(reductionValue) + " PV:" + String.valueOf(prestigeValue);
}
/**
* 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}.
* @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
*/
@Override
public String toStringBoard()
{
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java
-1
View File
@@ -5,7 +5,6 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
import it.polimi.ingsw.gc14.Model.Player;
public class Gatherer extends Character {
/**
* Creates a Gatherer character card with the specified era.
*
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java
+18 -1
View File
@@ -5,6 +5,12 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
import it.polimi.ingsw.gc14.Model.Player;
public class Hunter extends Character {
/**
* Describes whether the {@code Hunter Icon} is present or not. Whenever an
* {@code Hunter} with an {@code Hunter Icon} is added to the tribe, 1 {@code Food token} is awarded for each Hunter in the tribe
* (with or without an icon).
*/
private boolean icon;
/**
@@ -53,6 +59,18 @@ public class Hunter extends Character {
}
return toPrint;
}
/**
* 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>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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
String toPrint = super.toStringBoard();
@@ -62,7 +80,6 @@ public class Hunter extends Character {
return toPrint;
}
/**
* Creates and returns a copy of this Hunter card.
*
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java
+15
View File
@@ -4,6 +4,9 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
import it.polimi.ingsw.gc14.Model.Player;
public class Inventor extends Character {
/**
* The {@code Icons}'s ID. There are a total of 10 different Icons.
*/
private int icon;
/**
@@ -54,6 +57,18 @@ public class Inventor extends Character {
public String toString() {
return super.toString() + " I_ID:" + String.valueOf(icon);
}
/**
* 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 #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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toStringBoard() + " I_ID:" + String.valueOf(icon);
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java
+19 -2
View File
@@ -6,7 +6,13 @@ import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
import it.polimi.ingsw.gc14.Model.Player;
public class Shaman extends Character {
/**
* The number of star {@code Icons} the card possesses.
* During the {@link it.polimi.ingsw.gc14.Model.Cards.TribeCards.Events.ShamanicRitual Shamanic Ritual Event}, having the
* majority of these icons provides Prestige Points;
* having the minority, on the other hand, results in
* losing Prestige Points.
*/
private int icon;
/**
@@ -51,12 +57,23 @@ public class Shaman extends Character {
public String toString() {
return super.toString() + " *:" + String.valueOf(icon);
}
/**
* 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 #icon Number of stars}
* </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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toStringBoard() + " *:" + String.valueOf(icon);
}
/**
* Creates and returns a copy of this Shaman card.
*
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/EventCard.java
+11
View File
@@ -64,6 +64,17 @@ public abstract class EventCard extends TribeCard {
public String toString() {
return super.toString()+" "+type.toString();
}
/**
* Prints a string representation of this {@code EventCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version.
* <p>Includes:
* <li>{@link #type Type}
* </p>
* @return {@code String} - a string representation of this {@code EventCard}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toString()+" "+type.toString();
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Events/CavePaintings.java
+18
View File
@@ -86,6 +86,24 @@ public class CavePaintings extends EventCard {
return new CavePaintings(getEra(), NLower, NPrestigeRem, NPrestigeMul) ;
}
/**
* 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>NOTE: {@code NUpper} is not a real attribute used in calculations (only {@code NLower} is needed),
* however it's a parameter on the cards' design.
* </p>
* <p>Includes:
* <li>{@link #NLower}
* <li>{@code NUpper}
* <li>{@link #NPrestigeRem}
* <li>{@link #NPrestigeMul}
* </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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toString()+" 0-"+(NLower-1)+":"+NPrestigeRem+" "+NLower+"+:"+NPrestigeMul;
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Events/Hunt.java
+12
View File
@@ -70,6 +70,18 @@ public class Hunt extends EventCard {
public EventCard clone() {
return new Hunt(getEra(), prestigeMultiplier);
}
/**
* 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 #prestigeMultiplier}
* </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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toString()+" 1F+"+prestigeMultiplier+"PP"+" X N Hunter";
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Events/ShamanicRitual.java
+13
View File
@@ -96,6 +96,19 @@ public class ShamanicRitual extends EventCard {
public EventCard clone() {
return new ShamanicRitual(getEra(), prestigeToAdd, prestigeToRemove);
}
/**
* 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 #prestigeToAdd}
* <li>{@link #prestigeToRemove}
* </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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toString()+" *>:"+prestigeToAdd+" *<:"+prestigeToRemove;
src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Events/Sustenance.java
+11
View File
@@ -90,6 +90,17 @@ public class Sustenance extends EventCard {
return new Sustenance(getEra(), PrestigeDebt);
}
/**
* 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 #PrestigeDebt}
* </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
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
@Override
public String toStringBoard() {
return super.toString()+" -1F/-"+PrestigeDebt+"PP";
src/main/java/it/polimi/ingsw/gc14/Model/DecksCreator.java
+14 -3
View File
@@ -1,7 +1,6 @@
package it.polimi.ingsw.gc14.Model;
import com.google.gson.*;
import it.polimi.ingsw.gc14.Model.Cards.Building.EffectType;
import it.polimi.ingsw.gc14.Model.Cards.Building.Effects.*;
import it.polimi.ingsw.gc14.Model.Cards.BuildingCard;
import it.polimi.ingsw.gc14.Model.Cards.TribeCards.CharacterType;
@@ -16,9 +15,10 @@ import java.io.*;
import java.lang.reflect.Type;
import java.util.*;
//TODO javadoc
public class DecksCreator {
//TODO javadoc
public static List<TribeCard> loadTribeDeckByEra(int era) throws IllegalArgumentException
{
return switch (era) {
@@ -28,6 +28,8 @@ public class DecksCreator {
default -> throw new IllegalArgumentException();
};
}
//TODO javadoc
public static List<TribeCard> loadTribeDeck(String resourcePath) {
Gson gson = new Gson();
Type listType = new com.google.gson.reflect.TypeToken<List<TribeCardDefinition>>(){}.getType();
@@ -48,11 +50,15 @@ public class DecksCreator {
throw new RuntimeException("Errore caricamento mazzo: " + resourcePath, e);
}
}
//TODO javadoc
public static List<BuildingCard> loadBuildingDeckByEra(int era) throws IllegalArgumentException
{
if(era<=0 || era>3) throw new IllegalArgumentException();
return loadBuildingDeck("/Cards/buildingCards.json").stream().filter(x->x.getEra()==era).toList();
}
//TODO javadoc
public static List<BuildingCard> loadBuildingDeck(String resourcePath) {
Gson gson = new Gson();
Type listType = new com.google.gson.reflect.TypeToken<List<BuildingCardDefinition>>(){}.getType();
@@ -74,6 +80,7 @@ public class DecksCreator {
}
}
//TODO javadoc
public static List<Slot> loadSlotDeck()
{
List<Slot> slots = new ArrayList<>();
@@ -82,6 +89,8 @@ public class DecksCreator {
slots.add(new Slot(c));
return slots;
}
//TODO javadoc
private static TribeCard createCard(TribeCardDefinition def) {
int era = def.era;
@@ -129,6 +138,7 @@ public class DecksCreator {
};
}
//TODO javadoc
private static BuildingCard createCard(BuildingCardDefinition def) {
return switch (def.effectId) {
case 0 -> new Building0(def.era, def.price, def.prestigeValue);
@@ -143,7 +153,7 @@ public class DecksCreator {
}
//TODO javadoc
private static class TribeCardDefinition {
String type;
int era;
@@ -152,6 +162,7 @@ public class DecksCreator {
List<Object> params; // Object per gestire boolean e int misti
}
//TODO javadoc
private static class BuildingCardDefinition {
int effectId;
int era;
src/main/java/it/polimi/ingsw/gc14/Model/Game.java
+10
View File
@@ -758,6 +758,16 @@ public class Game implements Serializable {
return true;
}
/**
* Prints a string representation of the {@code Game}. Used in the TUI implementation to draw:
* <li>{@link it.polimi.ingsw.gc14.Model.GamePackage.Board Board}
* <li>{@link it.polimi.ingsw.gc14.Model.Player Players}
* <li>{@link #getUpperListTribeCards() Upper TribeCard List} <li>{@link #getUpperListBuilding() Upper Building List}
* <li>{@link #getLowerListTribeCards() Lower TribeCard List} <li>{@link #getLowerListBuilding() Lower Building List}
* <li>{@link it.polimi.ingsw.gc14.Model.OrderLogicCard Offer Track}
*
* @return {@code String} - a string representation of the {@code Game}.
*/
@Override
public String toString() {
return PlayersStamp()+"\n"+BoardStamp()+"\n";
src/main/java/it/polimi/ingsw/gc14/Model/OrderLogicCard.java
+11 -1
View File
@@ -12,9 +12,13 @@ import java.util.stream.Collectors;
public abstract class OrderLogicCard implements Serializable {
/**
* The queue of players associated with this order logic card.
* The queue of {@link Player Players} associated with this order logic card.
*/
protected Queue<Player> players;
/**
* The list of {@link Player Players} associated with this order logic card.
*/
protected List<OrderPlayer> playerList;
@@ -98,6 +102,12 @@ public abstract class OrderLogicCard implements Serializable {
player.addFood(1);
}
/**
* 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.
* @see Player
*/
protected int getPosition(String username)
{
int pos = 0;
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order2.java
+1 -1
View File
@@ -26,7 +26,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 cannot remove it,
* <p>If {@code index == 1}, the player tries to remove 1 Food; if the player 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
+2 -1
View File
@@ -27,7 +27,8 @@ 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}, if the player can remove 1 Food, the player loses 2 Prestige.
* <p>If {@code index == 2}, the player tries to remove 1 Food; if the player pay it,
* the player loses 2 Prestige.
*
* @param player the player to whom the effect is applied.
* @param index the position index of the effect to apply.
src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order4.java
+1 -1
View File
@@ -28,7 +28,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 removal succeeds,
* <p>If {@code index == 3}, the player tries to remove 1 Food; if the player 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
@@ -29,7 +29,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 removal succeeds,
* <p>If {@code index == 4}, the player tries to remove 1 Food; if the player 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/OrderPlayer.java
+4 -3
View File
@@ -5,9 +5,10 @@ import it.polimi.ingsw.gc14.Model.Player;
import java.io.Serializable;
/**
* Abstract base class for all order logic cards.
* An OrderLogicCard manages a queue of players and defines the effects
* applied when players are pushed back into the queue.
* Abstract base class for all order {@code logic cards}.
* An {@code OrderLogicCard} manages a queue of {@code players} and defines the effects
* applied when they are pushed back into the queue.
* @see it.polimi.ingsw.gc14.Model.Player Player
*/
public class OrderPlayer implements Serializable {
public Player player;
src/main/java/it/polimi/ingsw/gc14/Model/PlayableCard.java
+8
View File
@@ -45,6 +45,14 @@ public abstract class PlayableCard implements Serializable {
public String toString() {
return "⎕:";
}
/**
* Prints a string representation of this {@code PlayableCard}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version (in this specific case the two methods are equal).
* @return {@code String} - a string representation of this {@code PlayableCard}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
public String toStringBoard()
{
return "⎕:";
src/main/java/it/polimi/ingsw/gc14/Model/Player.java
+25 -16
View File
@@ -8,7 +8,6 @@ import it.polimi.ingsw.gc14.View.TUI.AsciiTable;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static it.polimi.ingsw.gc14.View.TUI.BorderStyle.*;
@@ -125,13 +124,6 @@ public class Player implements Serializable {
public int getPrestigeValue() {
return PrestigeValue;
}
/* TODO
* private Game game;
* public Game getGame(){
* return Game;
* }
*/
// endregion getters
// region Setters
@@ -228,17 +220,34 @@ public class Player implements Serializable {
// endregion constructors
// region Functions
/**
* Prints the {@code Player}'s attributes for the {@code Board}'s representation.
* Uses the {@code UNICODE} border style.
* <p><b>Includes:</b>
* <li>{@link #FoodValue Food}
* <li>{@link #PrestigeValue Prestige}
* <li>{@link #artists Artists}
* <li>{@link #builders Builders}
* <li>{@link #gatherers Gatherers}
* <li>{@link #shamans Shamans}
* <li>{@link #inventors Inventors}
* <li>{@link #hunters Hunters}
* <li>{@link #buildingCards Buildings}
* </p>
* @return {@code String} - A string representation of the {@code Player}'s attributes.
* @see it.polimi.ingsw.gc14.View.TUI.BorderStyle BorderStyle
*/
@Override
public String toString() {
int Last = 6;
int Last = -1;
var table = new AsciiTable(UNICODE, 1);
table.addHeader(this.getUserName());
table.addRow("RESOURCES:");
table.addRow("Food: " + this.getFoodValue());
table.addSeparator();
table.addRow("Prestige: " + this.getPrestigeValue());
table.addSeparator();
if(!this.hunters.isEmpty()){
Last = 6;
@@ -267,44 +276,44 @@ public class Player implements Serializable {
}
table.addRow("CHARACTERS:");
if(!this.artists.isEmpty()){
table.addRow("Artists: " + this.artists.toString());
if(Last == 1){
table.addSeparator();
}
table.addRow("Artists: " + this.artists.toString());
}
if(!this.builders.isEmpty()){
table.addRow("Builders: " + this.builders.toString());
if(Last == 2){
table.addSeparator();
}
table.addRow("Builders: " + this.builders.toString());
}
if(!this.gatherers.isEmpty()){
table.addRow("Gatherers: " + this.gatherers.toString());
if(Last == 3){
table.addSeparator();
}
table.addRow("Gatherers: " + this.gatherers.toString());
}
if(!this.shamans.isEmpty()){
table.addRow("Shamans: " + this.shamans.toString());
if(Last == 4){
table.addSeparator();
}
table.addRow("Shamans: " + this.shamans.toString());
}
if(!this.inventors.isEmpty()){
table.addRow("Inventors: " + this.inventors.toString());
if(Last == 5){
table.addSeparator();
}
table.addRow("Inventors: " + this.inventors.toString());
}
if(!this.hunters.isEmpty()){
table.addSeparator();
table.addRow("Hunters: " + this.hunters.toString());
table.addSeparator();
}
table.addRow("BUILDING CARDS:");
src/main/java/it/polimi/ingsw/gc14/Model/Slot.java
+13
View File
@@ -156,6 +156,19 @@ public class Slot implements Serializable {
}
/**
* Prints a string representation of this {@code Slot}. This specific variation is used in the {@code Game}'s
* toString to print a more detailed version for the TUI implementation.
* <p>includes:
* <li>{@link #slotId SlotId}
* <li>{@link #NUpper NUpper}
* <li>{@link #NLower NLower}
* <li>{@link #Food Food}
* </p>
* @return {@code String} - a string representation of this {@code Slot}.
* @see it.polimi.ingsw.gc14.Model.Game Game
* @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
*/
public String toStringTUI()
{
StringBuilder s = new StringBuilder();
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvent.java
+17
View File
@@ -4,23 +4,39 @@ import it.polimi.ingsw.gc14.Controller.GameController;
import java.io.Serializable;
//TODO javadoc
public abstract class NetworkEvent implements Serializable {
//TODO javadoc
protected String username;
//TODO javadoc
public String getUsername() {
return username;
}
//TODO javadoc
protected EventType eventType;
//TODO javadoc
public EventType getEventType() {return eventType;}
//TODO javadoc
protected boolean isError;
//TODO javadoc
public boolean getIsError() {return isError;}
//TODO javadoc
public void setIsError(boolean isError) {this.isError = isError;}
//TODO javadoc
protected NetworkEvent(String username, EventType eventType, boolean isError) {
this.username = username;
this.eventType = eventType;
this.isError = isError;
}
//TODO javadoc
@Override
public String toString() {
if(isError) {
@@ -30,5 +46,6 @@ public abstract class NetworkEvent implements Serializable {
}
}
//TODO javadoc
public abstract boolean apply(GameController gameController);
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/AddPlayer.java
+8
View File
@@ -7,15 +7,23 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class AddPlayer extends NetworkEvent implements Serializable {
//TODO javadoc
private int proposedNPlayer;
//TODO javadoc
public int getProposedNPlayer() {
return proposedNPlayer;
}
//TODO javadoc
public AddPlayer(String username, int proposedNPlayer) {
super(username, EventType.ADD_PLAYER, false);
this.proposedNPlayer = proposedNPlayer;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController)
{
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/DrawLowerBuildingCard.java
+5
View File
@@ -7,19 +7,24 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class DrawLowerBuildingCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public DrawLowerBuildingCard(String username, int pos){
super(username, EventType.DRAW_LOWER_BUILD, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.drawLowerBuildingCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/DrawLowerTribeCard.java
+4
View File
@@ -8,18 +8,22 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
public class DrawLowerTribeCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public DrawLowerTribeCard(String username, int pos){
super(username, EventType.DRAW_LOWER_TRIBE, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.drawLowerTribeCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/DrawUpperBuildingCard.java
+5
View File
@@ -7,19 +7,24 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class DrawUpperBuildingCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public DrawUpperBuildingCard(String username, int pos){
super(username, EventType.DRAW_UPPER_BUILD, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.drawUpperBuildingCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/DrawUpperTribeCard.java
+5
View File
@@ -7,19 +7,24 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class DrawUpperTribeCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public DrawUpperTribeCard(String username, int pos){
super(username, EventType.DRAW_UPPER_TRIBE, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.drawUpperTribeCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/PickOptionalBuildingCard.java
+5
View File
@@ -7,19 +7,24 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class PickOptionalBuildingCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public PickOptionalBuildingCard(String username, int pos){
super(username, EventType.PICK_OPTIONAL_BUILD, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.pickOptionalBuildingCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/PickOptionalTribeCard.java
+6
View File
@@ -7,19 +7,25 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class PickOptionalTribeCard extends NetworkEvent implements Serializable{
//TODO javadoc
private int pos;
//TODO javadoc
public PickOptionalTribeCard(String username, int pos){
super(username, EventType.PICK_OPTIONAL_TRIBE, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController){
return gameController.pickOptionalTribeCard(username, pos);
}
//TODO javadoc
public String apply(IView gameController){
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/NetworkEvents/SlotChoice.java
+5
View File
@@ -7,19 +7,24 @@ import it.polimi.ingsw.gc14.View.IView;
import java.io.Serializable;
//TODO javadoc
public class SlotChoice extends NetworkEvent implements Serializable {
//TODO javadoc
private int pos;
//TODO javadoc
public SlotChoice(String username, int pos) {
super(username, EventType.SLOT_CHOICE, false);
this.pos = pos;
}
//TODO javadoc
@Override
public boolean apply(GameController gameController) {
return gameController.slotChoice(username, pos);
}
//TODO javadoc
public String apply(IView gameController) {
return gameController.toString();
}
src/main/java/it/polimi/ingsw/gc14/Network/RMI/Client/RMIClient.java
+1 -1
View File
@@ -39,7 +39,7 @@ public class RMIClient implements IClient {
this.port = port;
}
//TODO Javadoc fix
/**
* Connects to the RMI server and attempts to join the game.
* Looks up the RMI registry to retrieve the {@link IGameServer} stub.
src/main/java/it/polimi/ingsw/gc14/View/TUI/AsciiTable.java
+22
View File
@@ -1,22 +1,40 @@
package it.polimi.ingsw.gc14.View.TUI;
import java.util.*;
//TODO javadoc
// Helper generale per costruire tabelle ASCII
public class AsciiTable {
//TODO javadoc
private final BorderStyle s;
//TODO javadoc
private final int cols;
//TODO javadoc
private final List<List<String>> rows = new ArrayList<>();
//TODO javadoc
private final List<Integer> separators = new ArrayList<>();
//TODO javadoc
public AsciiTable(BorderStyle s, int cols) {
this.s = s; this.cols = cols;
}
//TODO javadoc
public void addRow(String... cells) { rows.add(Arrays.asList(cells)); }
//TODO javadoc
public void addRow(List<String> cells) { rows.add(cells); }
//TODO javadoc
public void addHeader(String... cells) { rows.add(0, Arrays.asList(cells)); separators.add(0); }
public void addSeparator() { separators.add(rows.size()-1); }
//TODO javadoc
public void addSeparator() { separators.add(rows.size()-1); }
//TODO javadoc
public String build() {
var sb = new StringBuilder();
int maxWidth = rows.stream().mapToInt(x->x.stream().mapToInt(y->y.length()).max().getAsInt()).max().getAsInt()+1;
@@ -34,6 +52,7 @@ public class AsciiTable {
return sb.toString();
}
//TODO javadoc
private String hline(String l, String m, String r,int maxWidth) {
var sb = new StringBuilder(l);
for (int i = 0; i < cols; i++) {
@@ -43,10 +62,13 @@ public class AsciiTable {
return sb.append(r).toString();
}
//TODO javadoc
private static String rpad(String s, int w) {
if (s.length() >= w) return s.substring(0, w);
return s + " ".repeat(w - s.length());
}
//TODO javadoc
public static String sideBySide(List<String> left, List<String> right, int gap) {
int leftWidth = left.stream().mapToInt(String::length).max().orElse(0);
int maxHeight = Math.max(left.size(), right.size());