|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.crosswire.jsword.book.sword.AbstractBackend
public abstract class AbstractBackend
A generic way to read data from disk for later formatting.
for license details.
The copyright to this program is held by it's authors.
Field Summary | |
---|---|
private SwordBookMetaData |
bmd
|
Constructor Summary | |
---|---|
AbstractBackend()
Default constructor for the sake of serialization. |
|
AbstractBackend(SwordBookMetaData sbmd)
Construct a minimal backend |
Method Summary | |
---|---|
abstract boolean |
contains(Key key)
|
void |
decipher(byte[] data)
Decipher the data in place, if it is enciphered and there is a key to unlock it. |
void |
encipher(byte[] data)
Encipher the data in place, if there is a key to unlock it. |
SwordBookMetaData |
getBookMetaData()
|
URI |
getExpandedDataPath()
|
abstract String |
getRawText(Key key)
Get the text allotted for the given entry |
boolean |
isSupported()
Returns whether this AbstractBackend is implemented. |
boolean |
isWritable()
A Backend is writable if the file system allows the underlying files to be opened for writing and if the backend has implemented writing. |
Key |
readIndex()
Initialize a AbstractBackend before use. |
void |
setRawText(Key key,
String text)
Set the text allotted for the given verse |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.crosswire.common.activate.Activatable |
---|
activate, deactivate |
Field Detail |
---|
private SwordBookMetaData bmd
Constructor Detail |
---|
public AbstractBackend()
public AbstractBackend(SwordBookMetaData sbmd)
sbmd
- Method Detail |
---|
public SwordBookMetaData getBookMetaData()
public void decipher(byte[] data)
data
- the data to unlockpublic void encipher(byte[] data)
data
- public URI getExpandedDataPath() throws BookException
BookException
public Key readIndex()
public abstract boolean contains(Key key)
public abstract String getRawText(Key key) throws BookException
key
- The key to fetch
BookException
- If the data can not be read.public void setRawText(Key key, String text)
key
- The key to fetch
BookException
- If the data can not be set.public boolean isSupported()
public boolean isWritable()
|
Copyright ยจ 2003-2007 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |