Package: OthelloGameBuilder

OthelloGameBuilder

Coverage

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