Class AtaxxState

java.lang.Object

AtaxxState

All Implemented Interfaces:

java.lang.Cloneable

public class AtaxxState
extends java.lang.Object
implements java.lang.Cloneable

AtaxxState - a model of a state of the game Ataxx. See https://en.wikipedia.org/wiki/Ataxx for details. The red player goes first. Board row and column numbers are 0-based in AtaxxState.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLUE A constant integer value representing "blue piece" (in getPiece(int, int)) and "blue player winner" (in getWinner()).
static int	NONE A constant integer value representing "no piece" (in getPiece(int, int)) and "no winner" (in getWinner()).
static int	RED A constant integer value representing "red piece" (in getPiece(int, int)) and "red player winner" (in getWinner()).
static int	SIZE The size of the 7-by-7 square grid.

Constructor Summary

Constructors

Constructor and Description
AtaxxState() Initialize board with RED pieces at [0][SIZE-1] and [SIZE-1][0] and BLUE pieces at [0][0] and [SIZE-1][SIZE-1].

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Return a deep clone of AtaxxState such that changes to a clone state do not affect the original or vice versa.
int	getCurrentPlayer() Return the current player (BLUE/RED).
int	getPiece(int row, int col) Return the piece (NONE/BLUE/RED) at the given 0-based row and column.
int	getWinner() Return the winner (BLUE/RED) of the game or NONE if there is no winner.
boolean	grow(int toRow, int toCol) Grow into a given 0-based position if and only if it is legal and return whether or not the growth was legal.
boolean	jump(int fromRow, int fromCol, int toRow, int toCol) Jump between two given 0-based positions if and only if it is legal and return whether or not the jump was legal.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final int NONE

A constant integer value representing "no piece" (in getPiece(int, int)) and "no winner" (in getWinner()).

See Also:

Constant Field Values

BLUE

public static final int BLUE

A constant integer value representing "blue piece" (in getPiece(int, int)) and "blue player winner" (in getWinner()).

See Also:

Constant Field Values

RED

public static final int RED

A constant integer value representing "red piece" (in getPiece(int, int)) and "red player winner" (in getWinner()).

See Also:

Constant Field Values

SIZE

public static final int SIZE

The size of the 7-by-7 square grid.

See Also:

Constant Field Values

Constructor Detail

AtaxxState

public AtaxxState()

Initialize board with RED pieces at [0][SIZE-1] and [SIZE-1][0] and BLUE pieces at [0][0] and [SIZE-1][SIZE-1]. All other positions have the value NONE. The first player is RED.

Method Detail

getPiece

public int getPiece(int row,
                    int col)

Return the piece (NONE/BLUE/RED) at the given 0-based row and column.

Parameters:

row - given row

col - given column

Returns:

the piece (NONE/BLUE/RED) at the given 0-based row and column

getCurrentPlayer

public int getCurrentPlayer()

Return the current player (BLUE/RED).

Returns:

the current player (BLUE/RED)

getWinner

public int getWinner()

Return the winner (BLUE/RED) of the game or NONE if there is no winner. Because there is no draw in Ataxx, a return value of NONE implies that the game is not over.

Returns:

the winner (BLUE/RED) of the game or NONE if there is no winner

jump

public boolean jump(int fromRow,
                    int fromCol,
                    int toRow,
                    int toCol)

Jump between two given 0-based positions if and only if it is legal and return whether or not the jump was legal. Conclude the move by moving the piece to the destination, flipping opponent pieces adjacent to the destination, and changing the current player. However, if the opponent has no legal move, the remaining board spaces are filled with the current player and the game is over.

Parameters:

fromRow - row piece is jumped from

fromCol - column piece is jumped from

toRow - row piece is jumped to

toCol - column piece is jumped to

Returns:

whether or not the jump was legal (and thus taken)

grow

public boolean grow(int toRow,
                    int toCol)

Grow into a given 0-based position if and only if it is legal and return whether or not the growth was legal. Conclude the move by placing the new piece in the destination, flipping opponent pieces adjacent to the destination, and changing the current player. However, if the opponent has no legal move, the remaining board spaces are filled with the current player and the game is over.

Parameters:

toRow - row piece is grown to

toCol - column piece is grown to

Returns:

whether or not the growth was legal (and thus taken)

clone

public java.lang.Object clone()

Return a deep clone of AtaxxState such that changes to a clone state do not affect the original or vice versa. Most simply done, this will involve a shallow clone via super.clone() followed by the creation of a new board 2D array with copied values for each row and column. See CloneFun.java lecture example.

Overrides:

clone in class java.lang.Object

Returns:

a deep clone of AtaxxState such that changes to a clone state do not affect the original or vice versa