3 namespace Org\Mxchange\City\State;
5 // Import application-specific stuff
6 use Org\Mxchange\City\State\Init\CityInitState;
8 // Import framework stuff
9 use Org\Mxchange\CoreFramework\State\BaseState;
12 * A general city state class
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2015 - 2023 City Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 abstract class BaseCityState extends BaseState {
35 * Protected constructor
37 * @param $className Name of the class
40 protected function __construct (string $className) {
41 // Call parent constructor
42 parent::__construct($className);
46 * Validates whether the state is 'active' or throws an exception if
47 * it is every other state.
50 * @throws UnexpectedStateException If the state is not 'active'
52 public function validateCityStateIsActive () {
54 if (!$this instanceof CityActiveState) {
55 // Throw the exception
56 throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
61 * Validates whether the state is 'init' or throws an exception if
62 * it is every other state.
65 * @throws UnexpectedStateException If the state is not 'virgin'
67 public function validateCityStateIsInit () {
69 if (!$this instanceof CityInitState) {
70 // Throw the exception
71 throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);