Add: Added Javadoc For "getPosition" Method And "playerList" Field In OrderLogicCard.java.

This commit is contained in:
GabrieleRadice
2026-04-30 18:39:16 +02:00
parent 6826886d4b
commit 9992808426
@@ -12,9 +12,13 @@ import java.util.stream.Collectors;
public abstract class OrderLogicCard implements Serializable { 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; protected Queue<Player> players;
/**
* The list of {@link Player Players} associated with this order logic card.
*/
protected List<OrderPlayer> playerList; protected List<OrderPlayer> playerList;
@@ -98,6 +102,12 @@ public abstract class OrderLogicCard implements Serializable {
player.addFood(1); 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) protected int getPosition(String username)
{ {
int pos = 0; int pos = 0;