2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.urls.api;
23 import jalview.urls.UrlLinkDisplay;
25 import java.util.List;
26 import java.util.Vector;
29 * Methods for providing consistent access to up-to-date URLs
34 public interface UrlProviderI
38 * Get names and urls in the UrlProvider as strings for display
41 Vector<String> getLinksForMenu();
44 * Get names and urls as strings for display
47 List<UrlLinkDisplay> getLinksForTable();
50 * Set names and urls from display settings
52 void setUrlData(List<UrlLinkDisplay> links);
55 * Get the link for the default URL
57 * @seqid sequence id for which to build link
58 * @return link for the default URL
60 String getDefaultUrl(String seqid);
63 * Get the default URL id
65 * @return id for default URL
67 String getDefaultUrlId();
70 * Get the target of the link for the default URL
72 * @seqid sequence id for which to build link
73 * @return target of link for the default URL
75 String getDefaultTarget(String seqid);
81 * the id of the URL to set as default
82 * @return true if setting is successful
83 * @throws IllegalArgumentException
84 * if id does not exist as a url in the UrlProvider
86 boolean setDefaultUrl(String id) throws IllegalArgumentException;
89 * Test if UrlProvider contains a url
93 * @return true of UrlProvider contains this id, false otherwise
95 boolean contains(String id);
98 * Write out all URLs as a string suitable for serialising
100 * @return string representation of available URLs
102 String writeUrlsAsString(boolean selected);
105 * Choose the default URL in the event of the selected default being
108 * @return id of chosen default url
110 String chooseDefaultUrl();
113 * Determine if id is for a user-defined URL
115 boolean isUserEntry(String id);