You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
91 lines
3.5 KiB
91 lines
3.5 KiB
/** |
|
* Base class for iterator, an auxiliary object for iterating through |
|
* objects stored inside an Acedia's collection. |
|
* Iterators expect that collection remains unchanged while they |
|
* are iterating through it. Otherwise their behavior becomes undefined. |
|
* Copyright 2020 Anton Tarasenko |
|
*------------------------------------------------------------------------------ |
|
* This file is part of Acedia. |
|
* |
|
* Acedia is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU General Public License as published by |
|
* the Free Software Foundation, version 3 of the License, or |
|
* (at your option) any later version. |
|
* |
|
* Acedia is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU General Public License |
|
* along with Acedia. If not, see <https://www.gnu.org/licenses/>. |
|
*/ |
|
class Iter extends AcediaObject |
|
abstract; |
|
|
|
/** |
|
* Initialized caller `Iterator` to iterate over a given collection. |
|
* |
|
* `Iterator` should only be initialized once, reinitializing `Iterator` is |
|
* considered an undefined behavior. Collection's `Iterate()` method is |
|
* a preferred method to create initialized `Iterator`. |
|
* |
|
* Initialization is not guaranteed to be successful, - each iterator class |
|
* corresponds to a particular collection and it's not `none` reference must |
|
* be used as an argument. |
|
* |
|
* @param relevantCollection `Collection` over which items `Iterator` |
|
* must iterate. |
|
* @param `true` if iteration was successful and `false` otherwise. |
|
*/ |
|
public function bool Initialize(Collection relevantCollection); |
|
|
|
/** |
|
* Makes iterator pick next item in collection. |
|
* As long as collection that's being iterated over is not modified, |
|
* `Next()` is guaranteed to iterate over all it's items. |
|
* Use `HasFinished()` to check whether you have iterated all of them. |
|
* Order of iteration is not guaranteed. |
|
* |
|
* @param skipNone Set this to `true` if you want to skip all stored |
|
* values that are equal to `none`. By default does not skip them. |
|
* Since order of iterating through items is not guaranteed, at each |
|
* `Next()` call an arbitrary set of items can be skipped. |
|
* @return Reference to caller `Iterator` to allow for method chaining. |
|
*/ |
|
public function Iter Next(optional bool skipNone); |
|
|
|
/** |
|
* Returns current value pointed to by an iterator. |
|
* |
|
* Does not advance iteration: use `Next()` to pick next value. |
|
* |
|
* @return Current value being iterated over. If `Iterator()` has finished |
|
* iterating over all values or was not initialized - returns `none`. |
|
* Note that `none` can also be returned if it's stored in a collection. |
|
*/ |
|
public function AcediaObject Get(); |
|
|
|
/** |
|
* Returns key of current value pointed to by an iterator. |
|
* |
|
* Does not advance iteration: use `Next()` to pick next value. |
|
* |
|
* @return Key of the current value being iterated over. |
|
* If `Iterator()` has finished iterating over all values or |
|
* was not initialized - returns `none`. |
|
* Note that `none` can also be returned if it's stored in a collection. |
|
*/ |
|
public function AcediaObject GetKey(); |
|
|
|
/** |
|
* Checks if caller `Iterator` has finished iterating. |
|
* |
|
* @return `true` if caller `Iterator` has finished iterating or |
|
* was not initialized. `false` otherwise. |
|
*/ |
|
public function bool HasFinished(); |
|
|
|
defaultproperties |
|
{ |
|
} |