JAL-2316 Changes following review.

[jalview.git] / src / jalview / urls / api / UrlProviderI.java

diff --git a/src/jalview/urls/api/UrlProviderI.java b/src/jalview/urls/api/UrlProviderI.java
index 50e2b78..728d9be 100644 (file)
--- a/src/jalview/urls/api/UrlProviderI.java
+++ b/src/jalview/urls/api/UrlProviderI.java
@@ -23,7 +23,6 @@ package jalview.urls.api;
 import jalview.urls.UrlLinkDisplay;
 
 import java.util.List;
-import java.util.Vector;
 
 /**
  * Methods for providing consistent access to up-to-date URLs
@@ -38,7 +37,7 @@ public interface UrlProviderI
    * Get names and urls in the UrlProvider as strings for display
    * 
    */
-  Vector<String> getLinksForMenu();
+  List<String> getLinksForMenu();
 
   /**
    * Get names and urls as strings for display
@@ -52,38 +51,40 @@ public interface UrlProviderI
   void setUrlData(List<UrlLinkDisplay> links);
 
   /**
-   * Get the link for the default URL
+   * Get the link for the primary URL
    * 
    * @seqid sequence id for which to build link
-   * @return link for the default URL
+   * @return link for the primary URL
    */
-  String getDefaultUrl(String seqid);
+  String getPrimaryUrl(String seqid);
 
   /**
-   * Get the default URL id
+   * Get the primary URL id
    * 
-   * @return id for default URL
+   * @return id for primary URL
    */
-  String getDefaultUrlId();
+  String getPrimaryUrlId();
 
   /**
-   * Get the target of the link for the default URL
+   * Get the target of the link for the primary URL
    * 
    * @seqid sequence id for which to build link
-   * @return target of link for the default URL
+   * @return target of link for the primary URL
    */
-  String getDefaultTarget(String seqid);
+  String getPrimaryTarget(String seqid);
 
   /**
-   * Set the default URL
+   * Set the primary URL: if only one URL can be used, this URL is the one which
+   * should be chosen, e.g. provides the URL to be used on double-click of a
+   * sequence id
    * 
    * @param id
-   *          the id of the URL to set as default
+   *          the id of the URL to set as primary
    * @return true if setting is successful
    * @throws IllegalArgumentException
    *           if id does not exist as a url in the UrlProvider
    */
-  boolean setDefaultUrl(String id) throws IllegalArgumentException;
+  boolean setPrimaryUrl(String id) throws IllegalArgumentException;
 
   /**
    * Test if UrlProvider contains a url
@@ -102,12 +103,12 @@ public interface UrlProviderI
   String writeUrlsAsString(boolean selected);
 
   /**
-   * Choose the default URL in the event of the selected default being
+   * Choose the primary URL in the event of the selected primary being
    * unavailable
    * 
-   * @return id of chosen default url
+   * @return id of chosen primary url
    */
-  String chooseDefaultUrl();
+  String choosePrimaryUrl();
 
   /**
    * Determine if id is for a user-defined URL