]> git.mxchange.org Git - hub.git/blob - application/hub/main/iterator/pool/shutdown/class_Shutdown
'public static final' is the right thing, some variables renamed to make clear what...
[hub.git] / application / hub / main / iterator / pool / shutdown / class_Shutdown
1 <?php
2 /**
3  * A shutdown ??? iterator
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 class Shutdown???Iterator extends BaseIterator implements Iterator {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @return      $iteratorInstance               An instance a Iterator class
39          */
40         public final static function createShutdown???Iterator () {
41                 // Get new instance
42                 $iteratorInstance = new Shutdown???Iterator();
43
44                 // Return the prepared instance
45                 return $iteratorInstance;
46         }
47
48         /**
49          * Getter for current value from group or generic
50          *
51          * @return      $current        Current value in iteration
52          */
53         public function current () {
54                 // Default is null
55                 $current = null;
56
57                 $this->partialStub('Please implement this method.');
58
59                 // Return it
60                 return $current;
61         }
62
63         /**
64          * Getter for key from group or generic
65          *
66          * @return      $key    Current key in iteration
67          */
68         public function key () {
69                 // Default is null
70                 $key = null;
71
72                 $this->partialStub('Please implement this method.');
73
74                 // Return it
75                 return $key;
76         }
77
78         /**
79          * Advances to the next entry
80          *
81          * @return      void
82          */
83         public function next () {
84                 $this->partialStub('Please implement this method.');
85         }
86
87         /**
88          * Rewinds to the beginning of the iteration
89          *
90          * @return      void
91          */
92         public function rewind () {
93                 $this->partialStub('Please implement this method.');
94         }
95
96         /**
97          * Checks wether the current entry is valid (not at the end of the list)
98          *
99          * @return      void
100          */
101         public function valid () {
102                 $this->partialStub('Please implement this method.');
103         }
104 }
105
106 // [EOF]
107 ?>