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.
23 import java.util.HashMap;
24 import java.util.Vector;
27 * Methods for providing consistent access to up-to-date URLs
32 public interface UrlProviderI
35 * Get all the URL links
37 * @return all URL links
39 public HashMap<String, UrlLink> getUrlLinks();
42 * Get names and urls in as strings for display
47 public void getLinksForDisplay(Vector<String> nameLinks,
48 Vector<String> urlLinks);
53 * @return id of the default URL
55 public String getDefaultUrl();
61 * the id of the URL to set as default
63 public void setDefaultUrl(String id);
66 * Write out all URLs as a string suitable for serialising
68 * @return string representation of available URLs
70 public String writeUrlsAsString();
73 * Set URL links from string
76 * string representation of URL links, i.e. | separated
78 public void setUrlLinks(String cachedUrl);
81 * Set URL links from collection
84 * hashmap containing string indexed UrlLinks
86 public void setUrlLinks(HashMap<String, UrlLink> links);