IterableDataset.java

   1 package club.wpia.gigi.output.template;
   2
   3 import java.util.Map;
   4
   5 import club.wpia.gigi.localisation.Language;
   6
   7 /**
   8  * Represents some kind of data, that may be iterated over in a template using
   9  * the <code>foreach</code> statement.
  10  */
  11 public interface IterableDataset {
  12
  13     /**
  14      * Moves to the next Dataset.
  15      *
  16      * @param l
  17      *            the language for l10n-ed strings.
  18      * @param vars
  19      *            the variables used in this template. They need to be updated
  20      *            for each line.
  21      * @return true, iff there was a data-line "installed". False of this set is
  22      *         already empty.
  23      */
  24     public boolean next(Language l, Map<String, Object> vars);
  25 }