gee/listiterator.vala

   1 /* listiterator.vala
   2  *
   3  * Copyright (C) 2009  Didier Villevalois
   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  *      Didier 'Ptitjes Villevalois <ptitjes@free.fr>
  21  */
  22
  23 /**
  24  * A list iterator. This supports bi-directionnal and index-based iteration.
  25  */
  26 public interface Gee.ListIterator<G> : Gee.Iterator<G> {
  27         /**
  28          * Sets the current item in the iteration to the specified new item.
  29          */
  30         public abstract void set (G item);
  31
  32         /**
  33          * Adds the specified item after the current item in the iteration. The
  34          * cursor is moved to point to the new added item.
  35          */
  36         public abstract void add (G item);
  37
  38         /**
  39          * Returns the current index in the iteration.
  40          *
  41          * @return the current index
  42          */
  43         public abstract int index ();
  44 }