Package: TicTacToeGameBuilder

TicTacToeGameBuilder

Coverage

1: /*
2: * Copyright © 2021-2023 Fachhochschule für die Wirtschaft (FHDW) Hannover
3: *
4: * This file is part of ipspiel24-tictactoe-core.
5: *
6: * ipspiel24-tictactoe-core is free software: you can redistribute it and/or modify it under
7: * the terms of the GNU General Public License as published by the Free Software
8: * Foundation, either version 3 of the License, or (at your option) any later
9: * version.
10: *
11: * ipspiel24-tictactoe-core is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
14: * details.
15: *
16: * You should have received a copy of the GNU General Public License along with
17: * ipspiel24-tictactoe-core. If not, see <http://www.gnu.org/licenses/>.
18: */
19: package de.fhdw.gaming.ipspiel24.tictactoe.core.domain;
20:
21: import java.util.List;
22:
23: import de.fhdw.gaming.core.domain.Game;
24: import de.fhdw.gaming.core.domain.GameBuilder;
25: import de.fhdw.gaming.core.domain.GameException;
26: import de.fhdw.gaming.core.domain.Observer;
27: import de.fhdw.gaming.ipspiel24.tictactoe.core.moves.TicTacToeMove;
28:
29: /**
30: * A builder which allows to create a Tic Tac Toe game.
31: */
32: public interface TicTacToeGameBuilder extends GameBuilder {
33:
34: /**
35: * The default number of rows (and columns) of a Tic Tac Toe board.
36: */
37: int DEFAULT_BOARD_SIZE = 3;
38:
39: /**
40: * Creates an {@link TicTacToePlayerBuilder} which allows to create and add a player to the game together with her
41: * strategy.
42: */
43: TicTacToePlayerBuilder createPlayerBuilder();
44:
45: /**
46: * Adds a player and her corresponding strategy.
47: *
48: * @param player The player.
49: * @param strategy The player's strategy.
50: * @throws GameException if adding the player is not allowed by the rules of the game.
51: */
52: TicTacToeGameBuilder addPlayer(TicTacToePlayer player, TicTacToeStrategy strategy) throws GameException;
53:
54: /**
55: * Changes the number of rows (and columns) of the board.
56: * <p>
57: * If this operation is called multiple times, only the last board size will be retained. If not called, the default
58: * size of {@link #DEFAULT_BOARD_SIZE} rows and columns is used.
59: *
60: * @param newBoardSize The new number of rows (and columns) of the board.
61: * @return {@code this}
62: */
63: TicTacToeGameBuilder changeBoardSize(int newBoardSize);
64:
65: @Override
66: TicTacToeGameBuilder addObservers(List<Observer> newObservers);
67:
68: @Override
69: Game<TicTacToePlayer, TicTacToeState, TicTacToeMove, TicTacToeStrategy> build(int id)
70: throws GameException, InterruptedException;
71: }