JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / 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   public AllColsIterator(int firstcol, int lastcol,
42           HiddenColumns hiddenCols)
43   {
44     last = lastcol;
45     next = firstcol;
46     current = firstcol;
47   }
48
49   @Override
50   public boolean hasNext()
51   {
52     return next <= last;
53   }
54
55   @Override
56   public Integer next()
57   {
58     if (next > last)
59     {
60       throw new NoSuchElementException();
61     }
62     current = next;
63     next++;
64
65     return current;
66   }
67
68   @Override
69   public void remove()
70   {
71     throw new UnsupportedOperationException();
72   }
73 }