org.crosswire.jsword.passage
Interface PreferredKey

All Known Implementing Classes:

ReadingsBook

public interface PreferredKey

For any time when a component wishes to express a preferrence for a Key. This interface will often be optional to allow objects to not specify a preferrence.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program 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.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:

$Id: PreferredKey.java,v 1.2 2004/08/16 22:08:44 joe Exp $

Author:

Joe Walker [joe at eireneh dot com]

See Also:

Licence

Method Summary

Key	getPreferred() What Key would this object like us to use?

Method Detail

getPreferred

Key getPreferred()

What Key would this object like us to use?

Returns:

The preferredKey