| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.core.dao.impl.JEB2FileDatabase |
Class Overview
JEB database file ("*.jdb2") manager.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | EXTENSION | JEB database file extension with the Leading dot. | |||||||||
| int | FLAG_COMPRESS | This flags is used to specify that the record should be compressed | |||||||||
| int | FLAG_ENCRYPT | This flags is used to specify that the record should be encrypted | |||||||||
| int | FLAG_NONE | No flag | |||||||||
| int | MARKER | File header marker, little-endian: JDB2 |
|||||||||
| int | TYPE_ARTIFACTS | Artifacts collections, little-endian: ART
|
|||||||||
| int | TYPE_PROJECT | Project block marker, little-endian: PRJ
|
|||||||||
| int | TYPE_PROJECT_CONFIGURATION | Persisted Project Configuration: PPC
|
|||||||||
| int | TYPE_PROJECT_METADATA | Persisted Project Metadata: PPM
|
|||||||||
| int | TYPE_QSTATES | Quick-states block marker, little-endian: QCK
|
|||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| JEB2FileDatabase(String basedir) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
deleteFile(String key, int version)
Delete a file.
| ||||||||||
| IFileDatabaseReader |
getDatabaseReader(String key)
Get a database record reader.
| ||||||||||
| IFileDatabaseWriter |
getDatabaseWriter(String key)
Get a database record writer.
| ||||||||||
| InputStream |
getFileReader(String key)
Get an input stream reader for low-level reading from a file.
| ||||||||||
| OutputStream |
getFileWriter(String key)
Get an output stream reader for low-level writing to a file.
| ||||||||||
| boolean |
hasFile(String key, int version)
Determine if the database contains the given file.
| ||||||||||
| byte[] |
loadFile(String key, int version)
Retrieve the contents of a file.
| ||||||||||
| boolean |
saveFile(String key, int version, byte[] data)
Store the contents of a file.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.dao.IFileDatabase
| |||||||||||
Constants
public static final String EXTENSION
JEB database file extension with the Leading dot. The case matters.
public static final int FLAG_COMPRESS
This flags is used to specify that the record should be compressed
public static final int FLAG_ENCRYPT
This flags is used to specify that the record should be encrypted
public static final int FLAG_NONE
No flag
public static final int MARKER
File header marker, little-endian: JDB2
public static final int TYPE_ARTIFACTS
Artifacts collections, little-endian: ART
public static final int TYPE_PROJECT
Project block marker, little-endian: PRJ
public static final int TYPE_PROJECT_CONFIGURATION
Persisted Project Configuration: PPC
public static final int TYPE_PROJECT_METADATA
Persisted Project Metadata: PPM
public static final int TYPE_QSTATES
Quick-states block marker, little-endian: QCK
Public Constructors
public JEB2FileDatabase (String basedir)
Public Methods
public boolean deleteFile (String key, int version)
Delete a file.
Parameters
| key | file key |
|---|---|
| version | file version |
Returns
- success indicator
public IFileDatabaseReader getDatabaseReader (String key)
Get a database record reader.
This method may not be implemented, in which case the implementation may throw an UnsupportedOperationException.@return
Throws
| IOException |
|---|
public IFileDatabaseWriter getDatabaseWriter (String key)
Get a database record writer.
This method may not be implemented, in which case the implementation may throw an UnsupportedOperationException.@return
Throws
| IOException |
|---|
public InputStream getFileReader (String key)
Get an input stream reader for low-level reading from a file. The client is responsible for closing the stream after usage.
This method may not be implemented, in which case the implementation may throw an UnsupportedOperationException.@return
Throws
| FileNotFoundException |
|---|
public OutputStream getFileWriter (String key)
Get an output stream reader for low-level writing to a file. The client is responsible for closing the stream after usage.
This method may not be implemented, in which case the implementation may throw an UnsupportedOperationException.@return
Throws
| FileNotFoundException |
|---|
public boolean hasFile (String key, int version)
Determine if the database contains the given file.
Parameters
| key | file key |
|---|---|
| version | file version |
Returns
- presence indicator
public byte[] loadFile (String key, int version)
Retrieve the contents of a file.
Parameters
| key | file key |
|---|---|
| version | file version |
Returns
- file data, null on error
public boolean saveFile (String key, int version, byte[] data)
Store the contents of a file.
Parameters
| key | file key |
|---|---|
| version | file version |
| data | file data |
Returns
- success indicator