com.fossgalaxy.games.fireworks.state

Class Deck

java.lang.Object

com.fossgalaxy.games.fireworks.state.Deck

All Implemented Interfaces:

Serializable

public class Deck
extends Object
implements Serializable

Represents a deck of Hanabi cards.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Deck()
Deck(Deck deck) Provides a clone of the given deck

Method Summary

Modifier and Type	Method and Description
void	add(Card card) Add a new card to the deck.
boolean	equals(Object o)
int	getCardsLeft() Gets the number of cards left in the deck
Card	getTopCard() Gets and removes the top card from the deck
boolean	hasCardsLeft() Are there any cards left in the deck?
int	hashCode()
void	init() Initialises the deck of cards with a complete set for the game
void	remove(Card card)
void	shuffle() shuffle this deck of cards.
void	shuffle(long seed) shuffle this deck with a prefined seed
void	sort()
List<Card>	toList()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Deck

public Deck()

Deck

public Deck(Deck deck)

Provides a clone of the given deck

A shallow copy - but the cards themselves are immutable so no problem.

Parameters:

deck - The given deck to be cloned

Method Detail

add

public void add(Card card)

Add a new card to the deck.

Parameters:

card - the card to add

getCardsLeft

public int getCardsLeft()

Gets the number of cards left in the deck

Returns:

int number of cards left

getTopCard

public Card getTopCard()

Gets and removes the top card from the deck

Returns:

The card that was on top of the deck

hasCardsLeft

public boolean hasCardsLeft()

Are there any cards left in the deck?

Returns:

boolean are there any cards left?

init

public void init()

Initialises the deck of cards with a complete set for the game

shuffle

public void shuffle()

shuffle this deck of cards.

sort

public void sort()

shuffle

public void shuffle(long seed)

shuffle this deck with a prefined seed

remove

public void remove(Card card)

toList

public List<Card> toList()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object