|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.BookType
public abstract class BookType
Data about book types.
for license details.
The copyright to this program is held by it's authors.
,
Serialized FormField Summary | |
---|---|
static BookType |
HREF_COM
Uncompresses HREF Commentaries |
private String |
name
The name of the BookType |
private static int |
nextObj
|
private int |
obj
|
static BookType |
RAW_COM
Uncompressed Commentaries |
static BookType |
RAW_FILES
Uncompressed Commentaries |
static BookType |
RAW_GEN_BOOK
Generic Books |
static BookType |
RAW_LD
2-Byte Index Uncompressed Dictionaries |
static BookType |
RAW_LD4
4-Byte Index Uncompressed Dictionaries |
static BookType |
RAW_TEXT
Uncompressed Bibles |
private BookCategory |
type
What category is this book |
private static BookType[] |
VALUES
|
static BookType |
Z_COM
Compressed Commentaries |
static BookType |
Z_LD
Compressed Dictionaries |
static BookType |
Z_TEXT
Compressed Bibles |
Constructor Summary | |
---|---|
BookType(String name,
BookCategory type)
Simple ctor |
Method Summary | |
---|---|
Book |
createBook(SwordBookMetaData sbmd,
File progdir)
Create a Book appropriate for the BookMetaData |
boolean |
equals(Object o)
Prevent subclasses from overriding canonical identity based Object methods |
static BookType |
fromString(String name)
Lookup method to convert from a String |
protected abstract AbstractBackend |
getBackend(SwordBookMetaData sbmd,
File rootPath)
Create a the appropriate backend for this type of book |
protected abstract Book |
getBook(SwordBookMetaData sbmd,
AbstractBackend backend)
Create a Book with the given backend |
BookCategory |
getBookCategory()
The category of this book |
static BookType |
getBookType(String name)
Find a BookType from a name. |
protected static AbstractBackend |
getCompressedBackend(SwordBookMetaData sbmd,
File rootPath)
|
int |
hashCode()
Prevent subclasses from overriding canonical identity based Object methods |
protected boolean |
isBackendSupported(SwordBookMetaData sbmd)
By default the backend is supported if the BookMetaData is not null. |
protected static boolean |
isCompressedBackendSupported(SwordBookMetaData sbmd)
|
boolean |
isSupported(SwordBookMetaData sbmd)
Given a SwordBookMetaData determine whether this BookType will work for it. |
(package private) Object |
readResolve()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final BookType RAW_TEXT
public static final BookType Z_TEXT
public static final BookType RAW_COM
public static final BookType Z_COM
public static final BookType HREF_COM
public static final BookType RAW_FILES
public static final BookType RAW_LD
public static final BookType RAW_LD4
public static final BookType Z_LD
public static final BookType RAW_GEN_BOOK
private String name
private BookCategory type
private static int nextObj
private final int obj
private static final BookType[] VALUES
Constructor Detail |
---|
public BookType(String name, BookCategory type)
Method Detail |
---|
public static BookType getBookType(String name)
name
- The name of the BookType to look up
public BookCategory getBookCategory()
public boolean isSupported(SwordBookMetaData sbmd)
sbmd
- the BookMetaData that this BookType works upon
protected boolean isBackendSupported(SwordBookMetaData sbmd)
public Book createBook(SwordBookMetaData sbmd, File progdir) throws BookException
BookException
protected abstract Book getBook(SwordBookMetaData sbmd, AbstractBackend backend)
protected abstract AbstractBackend getBackend(SwordBookMetaData sbmd, File rootPath) throws BookException
BookException
protected static AbstractBackend getCompressedBackend(SwordBookMetaData sbmd, File rootPath) throws BookException
BookException
protected static boolean isCompressedBackendSupported(SwordBookMetaData sbmd)
public static BookType fromString(String name)
public final boolean equals(Object o)
equals
in class Object
Object.equals(java.lang.Object)
public final int hashCode()
hashCode
in class Object
Object.hashCode()
public String toString()
toString
in class Object
Object readResolve()
|
Copyright ? 2003-2006 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |