1   /**
2    * Distribution License:
3    * This is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published
5    * by the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/llgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2007
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: MappedChoice.java 1462 2007-07-02 02:32:23Z dmsmith $
21   */
22  package org.crosswire.common.config;
23  
24  import java.util.Map;
25  
26  /**
27   * MappedChoice is simply a Choice where there are a number of alternative
28   * options where each entry is a Map.Entry.
29   * 
30   * @see gnu.lgpl.License for license details.<br>
31   *      The copyright to this program is held by it's authors.
32   * @author DM Smith [dmsmith555 at yahoo dot com]
33   */
34  public interface MappedChoice<K, V> extends Choice {
35      /**
36       * The available alternative values to be presented as options to the user
37       * where the user interface allows presentation of alternatives.
38       * @return A string array of alternatives.
39       */
40      Map<K, V> getOptions();
41  }
42