com.antelmann.game.puzzle
Class Solitaire

java.lang.Object
  com.antelmann.game.AbstractGame
      com.antelmann.game.puzzle.Solitaire

All Implemented Interfaces:

GamePlay, Serializable, Cloneable

public class Solitaire
extends AbstractGame

A one-player game where the goal is to remove all 'peggs' on the board by jumping over them one by one.

Author:

Holger Antelmann

See Also:

Serialized Form

Constructor Summary

Solitaire()
uses SolitaireSamples.getSolitiare() to initialize the game

Solitaire(String name, int[][] board)
Instead of building the board array yourself, you can take advantage of the static methods of the class SolitaireSamples, which provides convenient standard configurations; if you build a configuration yourself, the convention for int[][] board is as follows.

Method Summary

Object	clone() Any inheriting class with non-primitive members must override this clone() method to provide a full deep copy of the object, which is essential for spawnChild() to work correctly.
boolean	equals(Object obj)
double	getResult(int playerRole) a default implementation for convenience which may suit most games that do not involve betting or any form of measuring how 'big' the win was.
int	getValueAt(int column, int row)
int	getValueAt(com.antelmann.game.puzzle.SolitairePosition pos)
int[]	getWinner() getWinner() returns an array of all winning game roles - as there could be more than one winner.
int	hashCode() still experimental at this point
boolean	isSolved()
protected GameMove[]	listLegalMoves() listLegalMoves() returns the legal moves for this game.
int	nextPlayer() nextPlayer() returns the integer representing the game role of the next player.
int	pegsLeft()
protected boolean	popMove() popMove undoes the last move by altering the game board to the stage before the last move happened.
protected boolean	pushMove(GameMove move) pushMove takes a GameMove and alters the game according to to the move.
String	toString() overridden to provide useful information about the game

Methods inherited from class com.antelmann.game.AbstractGame

addObserver, clearRedoList, gameOver, getGameName, getLastMove, getLastPlayer, getLegalMoves, getLegalMoves, getMoveHistory, getNumberOfRedoMoves, getObservers, getRedoList, isLegalMove, isWinner, loadFromFile, makeMove, numberOfMoves, numberOfPlayers, redoMove, removeObserver, resetLegalMoves, resetLists, saveToFile, spawnChild, undoLastMove, undoMoves

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Solitaire

public Solitaire()

uses SolitaireSamples.getSolitiare() to initialize the game

See Also:

SolitaireSamples.getSolitaire()

Solitaire

public Solitaire(String name,
                 int[][] board)

Instead of building the board array yourself, you can take advantage of the static methods of the class SolitaireSamples, which provides convenient standard configurations; if you build a configuration yourself, the convention for int[][] board is as follows.

array must be of size [8][8]

0 values in the array are wasted; for the game the values considered are only the array values 1 to 7 to make it more 'human-readable'

every position outside the Solitaire playing field (here including the 0 value border arrays) must be other than 0 or 1

every Solitaire game position is either set to 0 or 1, where 0 is an empty tile and 1 is a peg

The String name is just used as an identification

See Also:

SolitaireSamples

Method Detail

getWinner

public int[] getWinner()

Description copied from interface: GamePlay

getWinner() returns an array of all winning game roles - as there could be more than one winner. If the function returns null, it doesn't necessarily mean that the game is still in progress, but it could also mean that there is no winner in this game even though it is over (alternatively, an empty array could be returned depending on the requirements of the game). Also, if winners are returned, the game could still be in progress. Maybe, a game keeps playing to determine who is the second winner, etc.

getResult

public double getResult(int playerRole)

Description copied from class: AbstractGame

a default implementation for convenience which may suit most games that do not involve betting or any form of measuring how 'big' the win was.

Specified by:

getResult in interface GamePlay

Overrides:

getResult in class AbstractGame

Returns:

1 if game is won, -1 if game is lost and 0 if no winners are present

nextPlayer

public int nextPlayer()

Description copied from interface: GamePlay

nextPlayer() returns the integer representing the game role of the next player. If there is no next player, it is assumed that there are no more legal moves left in the game, in which case the value of nextPlayer() should be irrelevant.

listLegalMoves

protected GameMove[] listLegalMoves()

Description copied from class: AbstractGame

listLegalMoves() returns the legal moves for this game. This function is used by the final method getLegalMoves(), which is a wrapper around this method to avoid the overhead of generating the legal moves over and over again when called multiple times (as calculating legal moves is commonly expensive). Note that implementations of listLegalMoves() must not check for gameOver(), unless gameOver() is overridden not to check for listLegalMoves(). The same applies to isLegalMove().

Specified by:

listLegalMoves in class AbstractGame

pushMove

protected boolean pushMove(GameMove move)

Description copied from class: AbstractGame

pushMove takes a GameMove and alters the game according to to the move.

Specified by:

pushMove in class AbstractGame

Returns:

true only if the move was put on the board successfully.

popMove

protected boolean popMove()

Description copied from class: AbstractGame

popMove undoes the last move by altering the game board to the stage before the last move happened.

Specified by:

popMove in class AbstractGame

Returns:

true only if the move was taken back successfully.

isSolved

public boolean isSolved()

pegsLeft

public int pegsLeft()

getValueAt

public int getValueAt(com.antelmann.game.puzzle.SolitairePosition pos)

getValueAt

public int getValueAt(int column,
                      int row)
               throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from class: AbstractGame

Any inheriting class with non-primitive members must override this clone() method to provide a full deep copy of the object, which is essential for spawnChild() to work correctly. Ay overriding of this method should still begin with a call to super.clone(), though. Also, note that this clone() method does not clone the embedded GameMove objects, i.e. those are expected not to change (except for their heuristics, which shouldn't affect game functionality) - or the subclass will have to take care of this.

Specified by:

clone in interface GamePlay

Overrides:

clone in class AbstractGame

Throws:

CloneNotSupportedException

See Also:

AbstractGame.spawnChild(GameMove)

toString

public String toString()

Description copied from class: AbstractGame

overridden to provide useful information about the game

Overrides:

toString in class AbstractGame

hashCode

public int hashCode()

still experimental at this point

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object