src/jalview/datamodel/AllColsIterator.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import java.util.Iterator;
  24 import java.util.NoSuchElementException;
  25
  26 /**
  27  * An iterator which iterates over all columns or rows in an alignment, whether
  28  * hidden or visible.
  29  *
  30  * @author kmourao
  31  *
  32  */
  33 public class AllColsIterator implements Iterator<Integer>
  34 {
  35   private int last;
  36
  37   private int next;
  38
  39   private int current;
  40
  41   ColumnSelection hidden;
  42
  43   public AllColsIterator(int firstcol, int lastcol,
  44           ColumnSelection hiddenCols)
  45   {
  46     last = lastcol;
  47     next = firstcol;
  48     current = firstcol;
  49     hidden = hiddenCols;
  50   }
  51
  52   @Override
  53   public boolean hasNext()
  54   {
  55     return current + 1 <= last;
  56   }
  57
  58   @Override
  59   public Integer next()
  60   {
  61     if (current + 1 > last)
  62     {
  63       throw new NoSuchElementException();
  64     }
  65     current = next;
  66     next++;
  67
  68     return current;
  69   }
  70
  71   @Override
  72   public void remove()
  73   {
  74     throw new UnsupportedOperationException();
  75   }
  76 }
  77