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, 2005 - 2016
18   *
19   */
20  package org.crosswire.jsword.passage;
21  
22  /**
23   * For any time when a component wishes to express a preference for a Key. This
24   * interface will often be optional to allow objects to not specify a
25   * preference.
26   * 
27   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
28   * @author Joe Walker
29   */
30  public interface PreferredKey {
31      /**
32       * What Key would this object like us to use?
33       * 
34       * @return The preferredKey
35       */
36      Key getPreferred();
37  }
38