JAL-2664 Updates following review
[jalview.git] / src / jalview / api / AlignmentRowsCollectionI.java
1 package jalview.api;
2
3 import jalview.datamodel.SequenceI;
4
5 public interface AlignmentRowsCollectionI extends Iterable<Integer>
6 {
7   /**
8    * Answers if the sequence at the given position is hidden.
9    * 
10    * @param r
11    *          the row index to check
12    * @return true if the sequence at r is hidden
13    */
14   public boolean isHidden(int r);
15
16   /**
17    * Answers if any row in this collection is hidden
18    * 
19    * @return true if there is at least 1 hidden row
20    */
21   public boolean hasHidden();
22
23   /**
24    * Answers the sequence at the given position in the alignment
25    * 
26    * @param r
27    *          the row index to locate
28    * @return the sequence
29    */
30   public SequenceI getSequence(int r);
31 }