JAL-2360 getColour() renamed to getColourScheme(), handling of "None"

[jalview.git] / src / jalview / schemes / ColourSchemeProperty.java

diff --git a/src/jalview/schemes/ColourSchemeProperty.java b/src/jalview/schemes/ColourSchemeProperty.java
index 9b91066..425b3a1 100755 (executable)
--- a/src/jalview/schemes/ColourSchemeProperty.java
+++ b/src/jalview/schemes/ColourSchemeProperty.java
@@ -42,7 +42,7 @@ public class ColourSchemeProperty
 
   /**
    * Returns a colour scheme for the given name, with which the given data may
-   * be coloured. The name may be one of
+   * be coloured. The name is not case-sensitive, and may be one of
    * <ul>
    * <li>Clustal</li>
    * <li>Blosum62</li>
@@ -59,24 +59,27 @@ public class ColourSchemeProperty
    * <li>T-Coffee Scores</li>
    * <li>RNA Helices</li>
    * <li>User Defined</li>
-   * <li>None</li>
    * <li>an AWT colour name e.g. red</li>
    * <li>residue colours list e.g. D,E=red;K,R,H=0022FF;c=yellow</li>
    * </ul>
    * If none of these formats is matched, the string is converted to a colour
-   * using a hashing algorithm.
+   * using a hashing algorithm. For name "None", returns null.
    * 
    * @param forData
    * @param name
    * @return
    */
-  public static ColourSchemeI getColour(AnnotatedCollectionI forData,
+  public static ColourSchemeI getColourScheme(AnnotatedCollectionI forData,
           String name)
   {
+    if (ResidueColourScheme.NONE.equalsIgnoreCase(name))
+    {
+      return null;
+
+    }
     JalviewColourScheme scheme = JalviewColourScheme.forName(name);
     if (scheme != null)
     {
-      // note JalviewColourScheme.None returns null here
       return scheme.getColourScheme(forData);
     }