1   /**
2    * Distribution License:
3    * JSword 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 or later
5    * as published by the Free Software Foundation. This program is distributed
6    * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7    * the 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/lgpl.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   * © CrossWire Bible Society, 2007 - 2016
18   *
19   */
20  package org.crosswire.common.config;
21  
22  import java.util.Map;
23  
24  /**
25   * MappedChoice is simply a Choice where there are a number of alternative
26   * options where each entry is a Map.Entry.
27   * 
28   * @param <K> the key's type
29   * @param <V> the value's type
30   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
31   * @author DM Smith
32   */
33  public interface MappedChoice<K, V> extends Choice {
34      /**
35       * The available alternative values to be presented as options to the user
36       * where the user interface allows presentation of alternatives.
37       * @return A string array of alternatives.
38       */
39      Map<K, V> getOptions();
40  }
41