/*
 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
 * Copyright (C) $$Year-Rel$$ The Jalview Authors
 * 
 * This file is part of Jalview.
 * 
 * Jalview is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License 
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *  
 * Jalview is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty 
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
 * PURPOSE.  See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
 * The Jalview Authors are detailed in the 'AUTHORS' file.
 */
package jalview.util;

import java.util.HashMap;
import java.util.Vector;

/**
 * Methods for providing consistent access to up-to-date URLs
 * 
 * @author $author$
 * @version $Revision$
 */
public interface UrlProviderI
{
  /**
   * Get all the URL links
   * 
   * @return all URL links
   */
  public HashMap<String, UrlLink> getUrlLinks();

  /**
   * Get names and urls in as strings for display
   * 
   * @param nameLinks
   * @param urlLinks
   */
  public void getLinksForDisplay(Vector<String> nameLinks,
          Vector<String> urlLinks);

  /**
   * Get the default URL
   * 
   * @return id of the default URL
   */
  public String getDefaultUrl();

  /**
   * Set the default URL
   * 
   * @param id
   *          the id of the URL to set as default
   */
  public void setDefaultUrl(String id);

  /**
   * Write out all URLs as a string suitable for serialising
   * 
   * @return string representation of available URLs
   */
  public String writeUrlsAsString();

  /**
   * Set URL links from string
   * 
   * @param cachedUrl
   *          string representation of URL links, i.e. | separated
   */
  public void setUrlLinks(String cachedUrl);

  /**
   * Set URL links from collection
   * 
   * @param links
   *          hashmap containing string indexed UrlLinks
   */
  public void setUrlLinks(HashMap<String, UrlLink> links);
}