Pair.java

/**
 * It is a subclass of the Hand class and is used to model a hand of pair in a Big two card game, i.e two cards with the same rank
 * It overrides the getType() and the isValid() methods
 * @author Devang
 *
 */
public class Pair extends Hand
{
	private static final long serialVersionUID = 178749520333021015L;
	/** Constructor of the Pair class to initialise the player of the current hand and the cards played by the player
	 * It simply calls the super (Hand) class constructor
	 * @param player
	 * 		Use to specify the player of the current hand
	 * @param cards
	 * 		Used to specify the cards played in the current hand
	 */
	public Pair(CardGamePlayer player, CardList cards)
	{
		super(player,cards);
	}
	
	/**
	 * A getter method for returning a string specifying the type of this hand, i.e Pair.
	 * @return
	 * 		a string value specifying the type of hand, i.e Pair
	 */
	public String getType()
	{
		return "Pair";
	}
	
	/**
	 *  An method for checking if this is a valid Pair, i.e three cards with the same rank
	 * @return
	 * 		boolean value specifying if the hand being a Pair is valid or not
	 */
	public boolean isValid()
	{
		if(this.size() != 2) // If the hand size is not 2 then it is not a pair
			return false;
		Card c1 = this.getCard(0);
		Card c2 = this.getCard(1);
		if (c1.getRank() == c2.getRank()) // Else checking if the ranks of the 2 cards is the same, which means they are a pair
			return true;
		return false;
	}
}