Interface GinRummyPlayer

All Known Implementing Classes:

SimpleGinRummyPlayer

public interface GinRummyPlayer

Method Summary

Modifier and Type	Method and Description
Card	getDiscard() Get the player's discarded card.
java.util.ArrayList<java.util.ArrayList<Card>>	getFinalMelds() At the end of each turn, this method is called and the player that cannot (or will not) end the round will return a null value.
void	reportDiscard(int playerNum, Card discardedCard) Report that the given player has discarded a given card.
void	reportDraw(int playerNum, Card drawnCard) Report that the given player has drawn a given card and, if known, what the card is.
void	reportFinalMelds(int playerNum, java.util.ArrayList<java.util.ArrayList<Card>> melds) When an player has ended play and formed melds, the melds are reported to both players.
void	reportScores(int[] scores) Report current player scores, indexed by 0-based player number.
void	startGame(int playerNum, int startingPlayerNum, Card[] cards) Inform player of 0-based player number (0/1), starting player number (0/1), and dealt cards
boolean	willDrawFaceUpCard(Card card) Return whether or not player will draw the given face-up card on the draw pile.

Method Detail

startGame

void startGame(int playerNum,
               int startingPlayerNum,
               Card[] cards)

Inform player of 0-based player number (0/1), starting player number (0/1), and dealt cards

Parameters:

playerNum - player's 0-based player number (0/1)

startingPlayerNum - starting player number (0/1)

cards - dealt cards

willDrawFaceUpCard

boolean willDrawFaceUpCard(Card card)

Return whether or not player will draw the given face-up card on the draw pile.

Parameters:

card - face-up card on the draw pile

Returns:

whether or not player will draw the given face-up card on the draw pile

reportDraw

void reportDraw(int playerNum,
                Card drawnCard)

Report that the given player has drawn a given card and, if known, what the card is. If the card is unknown because it is drawn from the face-down draw pile, the drawnCard is null. Note that a player that returns false for willDrawFaceUpCard will learn of their face-down draw from this method.

Parameters:

playerNum - - player drawing a card

drawnCard - - the card drawn or null, depending on whether the card is known to the player or not, respectively.

getDiscard

Card getDiscard()

Get the player's discarded card. If you took the top card from the discard pile, you must discard a different card. If this is not a card in the player's possession, the player forfeits the game.

Returns:

the player's chosen card for discarding

reportDiscard

void reportDiscard(int playerNum,
                   Card discardedCard)

Report that the given player has discarded a given card.

Parameters:

playerNum - the discarding player

discardedCard - the card that was discarded

getFinalMelds

java.util.ArrayList<java.util.ArrayList<Card>> getFinalMelds()

At the end of each turn, this method is called and the player that cannot (or will not) end the round will return a null value. However, the first player to "knock" (that is, end the round), and then their opponent, will return an ArrayList of ArrayLists of melded cards. All other cards are counted as "deadwood", unless they can be laid off (added to) the knocking player's melds. When final melds have been reported for the other player, a player should return their final melds for the round.

Returns:

null if continuing play and opponent hasn't melded, or an ArrayList of ArrayLists of melded cards.

reportFinalMelds

void reportFinalMelds(int playerNum,
                      java.util.ArrayList<java.util.ArrayList<Card>> melds)

When an player has ended play and formed melds, the melds are reported to both players.

Parameters:

playerNum - player that has revealed melds

melds - an ArrayList of ArrayLists of melded cards

reportScores

void reportScores(int[] scores)

Report current player scores, indexed by 0-based player number.

Parameters:

scores - current player scores, indexed by 0-based player number