Class FreecellGame

java.lang.Object

FreecellGame

public class FreecellGame
extends java.lang.Object

Model of a Freecell game. Card stacks are numbered as follows: 0: deck (not used by player), 1-4: cells, 5-8: foundations, 9-16: cascades The toString method is implemented as shown in text game transcript. For example:

  Cells:
   1: 
   2: 
   3: 
   4: Kh
  Foundations:
   5: AC, 2C, 3C, 4C
   6: Ah, 2h, 3h, 4h, 5h, 6h, 7h
   7: AS
   8: Ad
  Cascades:
   9: 6S, 7S, 5C, 2S, 8d, 6d, Jh, 10C, 9h, 8C, 7d, 6C
  10: 7C
  11: 4S, 3d
  12: 
  13: QC, 8h, 9C, KC, Qd, JS, 10d, 9S
  14: Kd, QS, Jd, 10S, 9d
  15: 10h, 5d, 2d, 8S, JC, 5S, 4d, 3S
  16: KS, Qh
  

Constructor Summary

Constructors

Constructor and Description
FreecellGame(long seed) Create a Freecell game with a random deal generated with a given seed.

Method Summary

Modifier and Type	Method and Description
Card[]	getStack(int stackNum) Return an array with the Card in the given stack number listed from bottom to top.
boolean	isGameOver() Return whether or not the game has been won (that is, all cards are on foundations).
boolean	play(int srcStackNum, int destStackNum) Attempt to move a card from stack srcStackNum to stack destStackNum.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FreecellGame

public FreecellGame(long seed)

Create a Freecell game with a random deal generated with a given seed.

Parameters:

seed - seed for random deal

Method Detail

play

public boolean play(int srcStackNum,
                    int destStackNum)
             throws IllegalPlayException

Attempt to move a card from stack srcStackNum to stack destStackNum. If the play is legal, the play is made and true is returned. If the play is not legal, no change is made and an appropriate Exception is thrown.

Parameters:

srcStackNum - source stack number

destStackNum - destination stack number

Returns:

true if the play was legal and performed

Throws:

IllegalPlayException - thrown if (1) "Illegal stack number. Stacks are numbered 1-16.", (2) "Source and destination stacks must be different.", or (3) playTo(CardStack) throws one.

getStack

public Card[] getStack(int stackNum)

Return an array with the Card in the given stack number listed from bottom to top.

Parameters:

stackNum - stack number

Returns:

an array with the Card in the given stack number listed from bottom to top

isGameOver

public boolean isGameOver()

Return whether or not the game has been won (that is, all cards are on foundations).

Returns:

whether or not the game has been won (that is, all cards are on foundations)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object