Class CardStack

java.lang.Object

CardStack

Direct Known Subclasses:

Cascade, Cell, Deck, Foundation

public class CardStack
extends java.lang.Object

CardStack - a superclass of all Card stacks, embodying basic functionality, yet modifiable via class extension. The toString method represents a CardStack as a comma-and-space-separated list of Card Strings.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Stack<Card>	stack

Constructor Summary

Constructors

Constructor and Description
CardStack()

Method Summary

Modifier and Type	Method and Description
void	addCard(Card card) Add the given card to the top of the stack.
boolean	canPlayFrom() Returns true if a card may be removed from this stack and otherwise throws an IllegalPlayException ("You cannot play from an empty stack.").
Card	getTopCard() Return the top card or throw an EmptyStackException if empty.
boolean	isEmpty() Return whether or not the card stack is empty.
boolean	playTo(Card card) Given a card to be played to the top of this card stack, either make the legal play and return true, or ignore the illegal play and throw an appropriate Exception.
boolean	playTo(CardStack otherStack) Given a stack from which the top card is to be played to the top of this card stack, either make the legal play and return true, or throw an appropriate IllegalPlayException.
Card	removeTopCard() Remove the top card and return it or throw an EmptyStackException if empty.
int	size() Return the size of the card stack.
Card[]	toArray() Return an array of Card objects in this stack, ordered bottom to top.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

stack

protected java.util.Stack<Card> stack

Constructor Detail

CardStack

public CardStack()

Method Detail

addCard

public void addCard(Card card)

Add the given card to the top of the stack.

Parameters:

card - card to add

canPlayFrom

public boolean canPlayFrom()
                    throws IllegalPlayException

Returns true if a card may be removed from this stack and otherwise throws an IllegalPlayException ("You cannot play from an empty stack.").

Returns:

true if a card may be removed from this stack

Throws:

IllegalPlayException - "You cannot play from an empty stack." in the case of an empty stack.

getTopCard

public Card getTopCard()
                throws java.util.EmptyStackException

Return the top card or throw an EmptyStackException if empty.

Returns:

the top card

Throws:

java.util.EmptyStackException

isEmpty

public boolean isEmpty()

Return whether or not the card stack is empty.

Returns:

whether or not the card stack is empty

playTo

public boolean playTo(Card card)
               throws IllegalPlayException,
                      java.lang.NullPointerException

Given a card to be played to the top of this card stack, either make the legal play and return true, or ignore the illegal play and throw an appropriate Exception.

Parameters:

card - card to be played onto this card stack

Returns:

true if the card was played onto this card stack

Throws:

IllegalPlayException - if an illegal play is attempted

java.lang.NullPointerException - if the given card parameter is null

playTo

public boolean playTo(CardStack otherStack)
               throws IllegalPlayException

Given a stack from which the top card is to be played to the top of this card stack, either make the legal play and return true, or throw an appropriate IllegalPlayException.

Parameters:

otherStack - the other stack from which the top card is to be played

Returns:

true if the card was played onto this card stack

Throws:

IllegalPlayException - thrown if an IllegalPlayException is thrown by a call to canPlayFrom() or playTo(CardStack) calls.

removeTopCard

public Card removeTopCard()

Remove the top card and return it or throw an EmptyStackException if empty.

Returns:

the top card

size

public int size()

Return the size of the card stack.

Returns:

the size of the card stack

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toArray

public Card[] toArray()

Return an array of Card objects in this stack, ordered bottom to top.

Returns:

an array of Card objects in this stack, ordered bottom to top