JAL-2698 source code licencing
[jalview.git] / src / jalview / util / IntRangeComparator.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.util;
22
23 import java.util.Comparator;
24
25 /**
26  * A comparator to order [from, to] ranges into ascending or descending order of
27  * their start position
28  */
29 public class IntRangeComparator implements Comparator<int[]>
30 {
31   public static final Comparator<int[]> ASCENDING = new IntRangeComparator(
32           true);
33
34   public static final Comparator<int[]> DESCENDING = new IntRangeComparator(
35           false);
36
37   boolean forwards;
38
39   IntRangeComparator(boolean forward)
40   {
41     forwards = forward;
42   }
43
44   @Override
45   public int compare(int[] o1, int[] o2)
46   {
47     int compared = Integer.compare(o1[0], o2[0]);
48     return forwards ? compared : -compared;
49   }
50
51 }