model

Class Board

java.lang.Object

model.Board

public class Board
extends java.lang.Object

A Board object represents the state of a board at a given point in time. Each cell may contain a mark from either player, or no mark at all (represented by null).

Important: Boards are immutable; the update method returns a modified COPY of the board, without modifying the original board.

Boards have no public constructors. Instead, they should be created by starting with EMPTY and repeatedly calling update(...).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Board.State The possible states of the game.

Field Summary

Fields

Modifier and Type	Field and Description
static @NonNull Board	EMPTY The empty board.
static @NonNull java.lang.Iterable<Location>	LOCATIONS The set of all valid locations.
static int	NUM_COLS The number of columns on any board.
static int	NUM_ROWS The number of rows on any board.

Method Summary

Modifier and Type	Method and Description
Player	get(int row, int col) Return the player who has played in (r,c), or null if it is empty.
Player	get(@NonNull Location loc) Return the player who has played in loc, or null if loc is empty.
@NonNull Board.State	getState() Return the state of the board
@NonNull Victory	getWinner() Return a Victory object if the game has been won.
Board	update(@NonNull Player p, @NonNull Location loc) Return a new board that is the same as this with loc mapped to p.

Methods inherited from class java.lang.Object

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

Field Detail

NUM_ROWS

public static final int NUM_ROWS

The number of rows on any board.

See Also:

Constant Field Values

NUM_COLS

public static final int NUM_COLS

The number of columns on any board.

See Also:

Constant Field Values

EMPTY

public static final @NonNull Board EMPTY

The empty board.

LOCATIONS

public static final @NonNull java.lang.Iterable<Location> LOCATIONS

The set of all valid locations.

Method Detail

update

public Board update(@NonNull Player p,
                    @NonNull Location loc)
             throws java.lang.IllegalArgumentException

Return a new board that is the same as this with loc mapped to p.

Throws:

java.lang.IllegalArgumentException - if loc has already been played

get

public Player get(@NonNull Location loc)

Return the player who has played in loc, or null if loc is empty.

get

public Player get(int row,
                  int col)

Return the player who has played in (r,c), or null if it is empty.

getWinner

public @NonNull Victory getWinner()
                           throws java.lang.IllegalStateException

Return a Victory object if the game has been won.

Throws:

java.lang.IllegalStateException - if the game has not been won.

getState

public @NonNull Board.State getState()

Return the state of the board