contrib/psg/src/peersim/util/IndexIterator.java

   1 /*
   2  * Copyright (c) 2003-2005 The BISON Project
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  16  *
  17  */
  18
  19 package peersim.util;
  20
  21 /**
  22 * This class provides iterations over the set of integers [0...k-1].
  23 */
  24 public interface IndexIterator {
  25
  26         /**
  27         * This resets the iteration. The set of integers will be 0,..,k-1.
  28         */
  29         public void reset(int k);
  30
  31         /**
  32         * Returns next index.
  33         */
  34         public int next();
  35
  36         /**
  37         * Returns true if {@link #next} can be called at least one more time.
  38         * Note that {@link #next} can be called k times after {@link #reset}.
  39         */
  40         public boolean hasNext();
  41 }
  42