1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/* iterator.vala
*
* Copyright (C) 2007-2008 Jürg Billeter
* Copyright (C) 2009 Didier Villevalois, Maciej Piechotka
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library 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
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Author:
* Jürg Billeter <j@bitron.ch>
* Maciej Piechotka <uzytkownik2@gmail.com>
* Didier 'Ptitjes Villevalois <ptitjes@free.fr>
*/
/**
* An iterator over a collection.
*
* Gee's iterators are "on-track" iterators. They always point to an item
* except before the first call to {@link next} or {@link first}, or, when an
* item has been removed, until the next call to {@link next} or {@link first}.
*
* Please note that when the iterator is out of track, neither {@link get} nor
* {@link remove} are defined and both will fail. After the next call to
* {@link next} or {@link first}, they will be defined again.
*/
public interface Gee.Iterator<G> : Object {
/**
* Advances to the next element in the iteration.
*
* @return ``true`` if the iterator has a next element
*/
public abstract bool next ();
/**
* Checks whether there is a next element in the iteration.
*
* @return ``true`` if the iterator has a next element
*/
public abstract bool has_next ();
/**
* Rewinds to the first element in the iteration.
*
* @return ``true`` if the iterator has a first element
*/
public abstract bool first ();
/**
* Returns the current element in the iteration.
*
* @return the current element in the iteration
*/
public abstract G get ();
/**
* Removes the current element in the iteration. The cursor is set in an
* in-between state. Both {@link get} and {@link remove} will fail until
* the next move of the cursor (calling {@link next} or {@link first}).
*/
public abstract void remove ();
}
|
