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 as published by
5    * 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/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   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: BookDriver.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.jsword.book;
23  
24  /**
25   * The BibleDriver class allows creation of new Books.
26   * 
27   * @see gnu.lgpl.License for license details.<br>
28   *      The copyright to this program is held by it's authors.
29   * @author Joe Walker [joe at eireneh dot com]
30   */
31  public interface BookDriver extends BookProvider {
32      /**
33       * Is this name capable of creating writing data in the correct format as
34       * well as reading it?
35       * 
36       * @return true/false to indicate ability to write data
37       */
38      boolean isWritable();
39  
40      /**
41       * Create a new Book based on a source.
42       * 
43       * @param source
44       *            The Book from which to copy data
45       * @return The new WritableBible
46       * @exception BookException
47       *                If the name is not valid
48       */
49      Book create(Book source) throws BookException;
50  
51      /**
52       * Is this book able to be deleted.
53       * 
54       * @param dead
55       *            the book to be deleted
56       * @return whether the book can be deleted.
57       */
58      boolean isDeletable(Book dead);
59  
60      /**
61       * Delete this Book from the system. Take care with this method for obvious
62       * reasons. For most implementations of Book etc, this method will throw up
63       * because most will be read-only.
64       * 
65       * @throws BookException
66       *             If the Book can't be deleted.
67       */
68      void delete(Book dead) throws BookException;
69  
70      /**
71       * A short name for this BookDriver
72       */
73      String getDriverName();
74  }
75