com.antelmann.game.chess
Class ChessGame

java.lang.Object
  com.antelmann.game.AbstractGame
      com.antelmann.game.chess.ChessGame

All Implemented Interfaces:

GamePlay, Serializable, Cloneable

public class ChessGame
extends AbstractGame

ChessGame provides all external functions needed to play chess. It contains a ChessBoard which represents the game status. It overrides equals() and hashCode() to properly support serialized games.

Author:

Holger Antelmann

See Also:

Serialized Form

Constructor Summary

ChessGame()

ChessGame(String name)

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) This implementation of equals() does currently not care about the move history, it only considers the state of the board.
boolean	gameOver() Current limitations: gameOver() doesn't currently check for things like insufficient material for checkmate or 3rd repititions.
com.antelmann.game.chess.ChessBoard	getBoard()
int[]	getWinner() getWinner() returns an array of all winning game roles - as there could be more than one winner.
int	hashCode()
GameMove[]	listLegalMoves() listLegalMoves() returns the legal moves for this game.
int	nextPlayer() nextPlayer() returns the integer representing the game role of the next player.
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.
protected void	resetLists() overridden to provide package access
String	toString() overridden to provide useful information about the game

Methods inherited from class com.antelmann.game.AbstractGame

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ChessGame

public ChessGame()

ChessGame

public ChessGame(String name)

Method Detail

resetLists

protected void resetLists()

overridden to provide package access

Overrides:

resetLists in class AbstractGame

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.

gameOver

public boolean gameOver()

Current limitations: gameOver() doesn't currently check for things like insufficient material for checkmate or 3rd repititions.

Overrides:

gameOver in class AbstractGame

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

public 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

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.

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.

getBoard

public com.antelmann.game.chess.ChessBoard getBoard()

equals

public boolean equals(Object obj)

This implementation of equals() does currently not care about the move history, it only considers the state of the board. That means that a board may be considered equal even though in one case a castling or enpassant move is possible and not in the other.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from class: AbstractGame

overridden to provide useful information about the game

Overrides:

toString in class AbstractGame

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)