com.antelmann.game.wolfsheep
Class WolfsheepGame

java.lang.Object
  com.antelmann.game.AbstractGame
      com.antelmann.game.wolfsheep.WolfsheepGame

All Implemented Interfaces:

GamePlay, Serializable, Cloneable

public class WolfsheepGame
extends AbstractGame

an implementation of the wolf&sheep game which is played on a chess-like board; it uses the BoardPosition from the chess package for convenience. The game is played with 1 'wolf' and 4 'sheeps'; the setup and rules are somewhat simillar to checker, but way simpler. Wolf and sheeps start on opposite sites of the board. The sheeps can only move forward diagonal; the wolf can move back&forth, but only diagonal, also. Hence, each sheep has 2 move option at most and the wolf has 4 move options at most. The sheeps' goal is to contain the wolf, so that it cannot move anymore. The wolf's goal is to bypass the sheeps closing line and reach the other side of the board. If the wolf moves first, the wolf represents game role 0 and the sheeps represent 1. If the sheeps move first, these game roles are reversed.

Author:

Holger Antelmann

See Also:

BoardPosition, Serialized Form

Field Summary

static byte	SHEEP
static byte	WOLF

Constructor Summary

WolfsheepGame()
initiates the game with the wolf being the first player

WolfsheepGame(byte firstPlayer)
can initiate the game with either the wolf or the sheeps as the first player;

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)
BoardPosition	getSheepPosition(int index) accepts index 0 - 3
int[]	getWinner() getWinner() returns an array of all winning game roles - as there could be more than one winner.
BoardPosition	getWolfPosition()
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.
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, getResult, isLegalMove, isWinner, loadFromFile, makeMove, numberOfMoves, numberOfPlayers, redoMove, removeObserver, resetLegalMoves, resetLists, saveToFile, spawnChild, undoLastMove, undoMoves

Methods inherited from class java.lang.Object

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

Field Detail

SHEEP

public static final byte SHEEP

See Also:

Constant Field Values

WOLF

public static final byte WOLF

See Also:

Constant Field Values

Constructor Detail

WolfsheepGame

public WolfsheepGame()

initiates the game with the wolf being the first player

WolfsheepGame

public WolfsheepGame(byte firstPlayer)

can initiate the game with either the wolf or the sheeps as the first player;

See Also:

WOLF, SHEEP

Method Detail

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.

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.

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.

getWolfPosition

public BoardPosition getWolfPosition()

getSheepPosition

public BoardPosition getSheepPosition(int index)
                               throws ArrayIndexOutOfBoundsException

accepts index 0 - 3

Throws:

ArrayIndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals 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)