|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<BookType>
org.crosswire.jsword.book.sword.BookType
public enum BookType
Data about book types.
for license details.
The copyright to this program is held by it's authors.
Enum Constant Summary | |
---|---|
HREF_COM
Uncompresses HREF Commentaries |
|
RAW_COM
Uncompressed Commentaries |
|
RAW_COM4
|
|
RAW_FILES
Uncompressed Commentaries |
|
RAW_GEN_BOOK
Generic Books |
|
RAW_LD
2-Byte Index Uncompressed Dictionaries |
|
RAW_LD4
4-Byte Index Uncompressed Dictionaries |
|
RAW_TEXT
Uncompressed Bibles |
|
Z_COM
Compressed Commentaries |
|
Z_LD
Compressed Dictionaries |
|
Z_TEXT
Compressed Bibles |
Field Summary | |
---|---|
private BookCategory |
category
What category is this book |
private KeyType |
keyType
What category is this book |
private String |
name
The name of the BookType |
Method Summary | |
---|---|
Book |
createBook(SwordBookMetaData sbmd)
Create a Book appropriate for the BookMetaData |
static BookType |
fromString(String name)
Lookup method to convert from a String |
protected abstract AbstractBackend |
getBackend(SwordBookMetaData sbmd)
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. |
KeyType |
getKeyType()
Get the way this type of Book organizes it's keys. |
boolean |
isSupported(SwordBookMetaData sbmd)
Given a SwordBookMetaData determine whether this BookType will work for it. |
String |
toString()
|
static BookType |
valueOf(String name)
Returns the enum constant of this type with the specified name. |
static BookType[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final BookType RAW_TEXT
public static final BookType Z_TEXT
public static final BookType RAW_COM
public static final BookType RAW_COM4
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
Field Detail |
---|
private String name
private BookCategory category
private KeyType keyType
Method Detail |
---|
public static BookType[] values()
for (BookType c : BookType.values()) System.out.println(c);
public static BookType valueOf(String name)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum type has no constant
with the specified name
NullPointerException
- if the argument is nullpublic static BookType getBookType(String name)
name
- The name of the BookType to look up
public BookCategory getBookCategory()
public KeyType getKeyType()
public boolean isSupported(SwordBookMetaData sbmd)
sbmd
- the BookMetaData that this BookType works upon
public Book createBook(SwordBookMetaData sbmd) throws BookException
BookException
protected abstract Book getBook(SwordBookMetaData sbmd, AbstractBackend backend)
protected abstract AbstractBackend getBackend(SwordBookMetaData sbmd) throws BookException
BookException
public static BookType fromString(String name)
public String toString()
toString
in class Enum<BookType>
|
Copyright ? 2003-2011 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |