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 de.fhdw.gaming.core.domain.Game;
22: import de.fhdw.gaming.core.domain.GameBuilder;
23: import de.fhdw.gaming.core.domain.GameException;
24: import de.fhdw.gaming.core.domain.ObserverFactoryProvider;
25: import de.fhdw.gaming.ipspiel24.tictactoe.core.moves.TicTacToeMove;
26:
27: /**
28: * A builder which allows to create a Tic Tac Toe game.
29: */
30: public interface TicTacToeGameBuilder extends GameBuilder {
31:
32: /**
33: * The default number of rows (and columns) of a Tic Tac Toe board.
34: */
35: int DEFAULT_BOARD_SIZE = 3;
36:
37: /**
38: * Creates an {@link TicTacToePlayerBuilder} which allows to create and add a player to the game together with her
39: * strategy.
40: */
41: TicTacToePlayerBuilder createPlayerBuilder();
42:
43: /**
44: * Adds a player and her corresponding strategy.
45: *
46: * @param player The player.
47: * @param strategy The player's strategy.
48: * @throws GameException if adding the player is not allowed by the rules of the game.
49: */
50: TicTacToeGameBuilder addPlayer(TicTacToePlayer player, TicTacToeStrategy strategy) throws GameException;
51:
52: /**
53: * Changes the number of rows (and columns) of the board.
54: * <p>
55: * If this operation is called multiple times, only the last board size will be retained. If not called, the default
56: * size of {@link #DEFAULT_BOARD_SIZE} rows and columns is used.
57: *
58: * @param newBoardSize The new number of rows (and columns) of the board.
59: * @return {@code this}
60: */
61: TicTacToeGameBuilder changeBoardSize(int newBoardSize);
62:
63: /**
64: * Changes the {@link ObserverFactoryProvider}.
65: *
66: * @param newObserverFactoryProvider The new {@link ObserverFactoryProvider}.
67: * @return {@code this}
68: */
69: TicTacToeGameBuilder changeObserverFactoryProvider(ObserverFactoryProvider newObserverFactoryProvider);
70:
71: @Override
72: Game<TicTacToePlayer, TicTacToeState, TicTacToeMove, TicTacToeStrategy> build(int id)
73: throws GameException, InterruptedException;
74: }