JAL-4090 JAL-1551 source license
[jalview.git] / src / jalview / schemes / NucleotideAmbiguityColourScheme.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.schemes;
22
23 import jalview.api.AlignViewportI;
24 import jalview.datamodel.AnnotatedCollectionI;
25
26 public class NucleotideAmbiguityColourScheme extends ResidueColourScheme
27 {
28   /**
29    * Creates a new NucleotideColourScheme object.
30    */
31   public NucleotideAmbiguityColourScheme()
32   {
33     super(ResidueProperties.nucleotideIndex,
34             ResidueProperties.nucleotideAmbiguity);
35   }
36
37   @Override
38   public boolean isNucleotideSpecific()
39   {
40     return true;
41   }
42
43   @Override
44   public String getSchemeName()
45   {
46     return JalviewColourScheme.NucleotideAmbiguity.toString();
47   }
48
49   /**
50    * Returns a new instance of this colour scheme with which the given data may
51    * be coloured
52    */
53   @Override
54   public ColourSchemeI getInstance(AlignViewportI view,
55           AnnotatedCollectionI coll)
56   {
57     return new NucleotideAmbiguityColourScheme();
58   }
59
60 }