Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.crosswire.jsword.book.basic
Class AbstractBookDriver

    java.lang.Object
      org.crosswire.jsword.book.basic.AbstractBookDriver

All Implemented Interfaces:
  BookDriver, BookProvider

Direct Known Subclasses:
  ReadingsBookDriver, SwordBookDriver

    public abstract class AbstractBookDriver

extends Object
implements BookDriver

The AbstractBookDriver class implements some BibleDriver methods, making a simple read-only BibleDriver.

Author:
  Joe Walker
See Also:
  `The GNU Lesser General Public License for details.`

Constructor Summary
`AbstractBookDriver()`

Method Summary
`Book` | `create(Book source)` Create a new Book based on a source.
`void` | `delete(Book dead)` Delete this Book from the system.
`Book` | `getFirstBook()` Provide the first book.
`boolean` | `isDeletable(Book dead)` Is this book able to be deleted.
`boolean` | `isWritable()` Is this name capable of creating writing data in the correct format as well as reading it?

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.crosswire.jsword.book.BookDriver
`getDriverName`

Methods inherited from interface org.crosswire.jsword.book.BookProvider
`getBooks`

Constructor Detail

### AbstractBookDriver

    public AbstractBookDriver()

Method Detail

### isWritable

    public boolean isWritable()

  Description copied from interface: `BookDriver`
  Is this name capable of creating writing data in the correct format as well as reading it?

  Specified by:
    `isWritable` in interface `BookDriver`
  Returns:
    true/false to indicate ability to write data

### create

    public Book create(Book source)
                throws BookException

  Description copied from interface: `BookDriver`
  Create a new Book based on a source.

  Specified by:
    `create` in interface `BookDriver`
  Parameters:
    `source` - The Book from which to copy data
  Returns:
    The new WritableBible
  Throws:
    `BookException` - If the name is not valid

### isDeletable

    public boolean isDeletable(Book dead)

  Description copied from interface: `BookDriver`
  Is this book able to be deleted.

  Specified by:
    `isDeletable` in interface `BookDriver`
  Parameters:
    `dead` - the book to be deleted
  Returns:
    whether the book can be deleted.

### delete

    public void delete(Book dead)
                throws BookException

  Description copied from interface: `BookDriver`
  Delete this Book from the system. Take care with this method for obvious reasons. For most implementations of Book etc, this method will throw up because most will be read-only.

  Specified by:
    `delete` in interface `BookDriver`
  Parameters:
    `dead` - the book to be deleted
  Throws:
    `BookException` - If the Book can't be deleted.

### getFirstBook

    public Book getFirstBook()

  Description copied from interface: `BookProvider`
  Provide the first book.

  Specified by:
    `getFirstBook` in interface `BookProvider`
  Returns:
    the first book

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Copyright ¨ 2003-2015
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD