JAL-2788 possible adjustments to sequence accesses
[jalview.git] / src / jalview / api / AlignmentColsCollectionI.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.api;
22
23 public interface AlignmentColsCollectionI extends Iterable<Integer>
24 {
25   /**
26    * Answers if the column at the given position is hidden.
27    * 
28    * @param c
29    *          the column index to check
30    * @return true if the column at the position is hidden
31    */
32   public boolean isHidden(int c);
33
34   /**
35    * Answers if any column in this collection is hidden
36    * 
37    * @return true if there is at least 1 hidden column
38    */
39   public boolean hasHidden();
40 }