CardGame.java

import java.util.ArrayList;

/**
 * An interface for a general card game.
 * 
 * @author Kenneth Wong
 *
 */
public interface CardGame {
	/**
	 * Returns the number of players in this card game.
	 * 
	 * @return the number of players in this card game
	 */
	public int getNumOfPlayers();

	/**
	 * Returns the deck of cards being used in this card game.
	 * 
	 * @return the deck of cards being used in this card game
	 */
	public Deck getDeck();

	/**
	 * Returns the list of players in this card game.
	 * 
	 * @return the list of players in this card game
	 */
	public ArrayList<CardGamePlayer> getPlayerList();

	/**
	 * Returns the list of hands played on the table.
	 * 
	 * @return the list of hands played on the table
	 */
	public ArrayList<Hand> getHandsOnTable();

	/**
	 * Returns the index of the current player.
	 * 
	 * @return the index of the current player
	 */
	public int getCurrentPlayerIdx();

	/**
	 * Starts the card game.
	 * 
	 * @param deck the deck of (shuffled) cards to be used in this game
	 */
	public void start(Deck deck);

	/**
	 * Makes a move by the player.
	 * 
	 * @param playerIdx the index of the player who makes the move
	 * @param cardIdx   the list of the indices of the cards selected by the player
	 */
	public void makeMove(int playerIdx, int[] cardIdx);

	/**
	 * Checks the move made by the player.
	 * 
	 * @param playerIdx the index of the player who makes the move
	 * @param cardIdx   the list of the indices of the cards selected by the player
	 */
	public void checkMove(int playerIdx, int[] cardIdx);

	/**
	 * Checks for end of game.
	 * 
	 * @return true if the game ends; false otherwise
	 */
	public boolean endOfGame();
}