inf112.fiasko.roborally.objects

Interface Deck<T>

All Known Implementing Classes:

AbstractDeck, ProgrammingCardDeck

public interface Deck<T>

Describes a deck

Any card stored in the deck is assumed to be immutable. If it's not, the integrity of the deck cannot be guaranteed.

Method Summary

Modifier and Type	Method and Description
void	draw(Deck<T> other) Draws one card from the top of another deck
void	draw(Deck<T> other, int n) Draws n cards from the top of another deck
void	emptyInto(Deck<T> other) Moves all cards in this deck into another deck
java.util.List<T>	getCards() Gets a list of all cards in this deck The list should have the correct order according to the actual order within the deck.
boolean	isEmpty() Whether this deck is empty
T	peekBottom() Takes a peek at the card currently at the bottom of the deck
T	peekTop() Takes a peek at the card currently at the top of the deck
void	shuffle() Shuffles the order of the cards in the deck
int	size() Gets the number of cards currently in this deck

Method Detail

shuffle

void shuffle()

Shuffles the order of the cards in the deck

draw

void draw(Deck<T> other)

Draws one card from the top of another deck

Parameters:

other - The deck to draw the card from

draw

void draw(Deck<T> other,
          int n)

Draws n cards from the top of another deck

Parameters:

other - The other deck to draw from

n - The number of cards to draw

emptyInto

void emptyInto(Deck<T> other)

Moves all cards in this deck into another deck

Parameters:

other - The deck to move this deck's cards into

isEmpty

boolean isEmpty()

Whether this deck is empty

Returns:

True if this deck is currently empty

size

int size()

Gets the number of cards currently in this deck

Returns:

The number of cards in this deck

peekTop

T peekTop()

Takes a peek at the card currently at the top of the deck

Returns:

The card at the top of the deck

peekBottom

T peekBottom()

Takes a peek at the card currently at the bottom of the deck

Returns:

The card at the bottom of the deck

getCards

java.util.List<T> getCards()

Gets a list of all cards in this deck

The list should have the correct order according to the actual order within the deck.

Returns:

A list of all cards in this deck