3 namespace Org\Mxchange\CoreFramework\Iterator\!!!;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Iterator\BaseIterator;
14 * @author Roland Haeder <webmaster@ship-simu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.ship-simu.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 class ???Iterator extends BaseIterator implements Iterator {
35 * Protected constructor
39 private function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this class
47 * @return $iteratorInstance An instance of a Iterator class
49 public final static function create???Iterator () {
51 $iteratorInstance = new ???Iterator();
53 // Return the prepared instance
54 return $iteratorInstance;
58 * Getter for current value from group or generic
60 * @return $current Current value in iteration
62 public function current () {
66 $this->partialStub('Please implement this method.');
73 * Getter for key from group or generic
75 * @return $key Current key in iteration
77 public function key () {
81 $this->partialStub('Please implement this method.');
88 * Advances to the next entry
92 public function next () {
93 $this->partialStub('Please implement this method.');
97 * Rewinds to the beginning of the iteration
101 public function rewind () {
102 $this->partialStub('Please implement this method.');
106 * Checks wether the current entry is valid (not at the end of the list)
110 public function valid () {
111 $this->partialStub('Please implement this method.');