gee/mapiterator.vala

   1 /* mapiterator.vala
   2  *
   3  * Copyright (C) 2011  Florian Brosch
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Florian Brosch <flo.brosch@gmail.com>
  21  */
  22
  23
  24
  25 /**
  26  * An iterator over a map.
  27  */
  28 public abstract class Vala.MapIterator<K,V> {
  29         /**
  30          * Advances to the next element in the iteration.
  31          *
  32          * @return true if the iterator has a next element
  33          */
  34         public abstract bool next ();
  35
  36         /**
  37          * Returns the current key in the iteration.
  38          *
  39          * @return the current key in the iteration
  40          */
  41         public abstract K get_key ();
  42
  43         /**
  44          * Returns the current value in the iteration.
  45          *
  46          * @return the current value in the iteration
  47          */
  48         public abstract V get_value ();
  49 }
  50
  51
  52