Package com.pnfsoftware.jeb.core.dao.impl

Class JDB2Writer

java.lang.Object

com.pnfsoftware.jeb.core.dao.impl.JDB2Writer

All Implemented Interfaces:

IFileDatabaseWriter, Closeable, AutoCloseable

public class JDB2Writer
extends Object
implements IFileDatabaseWriter

JDB2 (JEB saved project database) record writer.

Constructor Summary

Constructors

Constructor	Description
JDB2Writer(File f)	Create a writer for a new JDB2 file.
JDB2Writer(File f, boolean appendIfExists)	Create a writer for a JDB2 file.

Method Summary

Modifier and Type	Method	Description
OutputStream	beginRecord(int type, int flags)	Initialize a new record.
void	close()
void	endRecord(OutputStream out)	Close an opened record.
File	getBackingFile()	Retrieve the backing file, if any.
boolean	hasBackingFile()	Determine if this database is backed by a file.
void	verify()	Verify that all opened records were closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JDB2Writer

public JDB2Writer(File f)
           throws IOException

Create a writer for a new JDB2 file.

Parameters:

f - target JDB2 file

Throws:

IOException - if the file cannot be created

JDB2Writer

public JDB2Writer(File f,
 boolean appendIfExists)
           throws IOException

Create a writer for a JDB2 file.

Parameters:

f - target JDB2 file

appendIfExists - if true, append new records to an existing JDB2 file

Throws:

IOException - if the file cannot be created, opened, or validated

Method Details

hasBackingFile

public boolean hasBackingFile()

Description copied from interface: IFileDatabaseWriter

Determine if this database is backed by a file.

Specified by:

hasBackingFile in interface IFileDatabaseWriter

Returns:

true if a backing file is available

getBackingFile

public File getBackingFile()

Description copied from interface: IFileDatabaseWriter

Retrieve the backing file, if any.

Specified by:

getBackingFile in interface IFileDatabaseWriter

Returns:

the backing file

beginRecord

public OutputStream beginRecord(int type,
 int flags)
                         throws IOException

Description copied from interface: IFileDatabaseWriter

Initialize a new record.

Specified by:

beginRecord in interface IFileDatabaseWriter

Parameters:

type - the record type, should be in [0, 0xFFFFFF], refer to JDB2Manager.TYPE_xxx for a list of well-known types; custom types are allowed and must start be in the 0x99xxxx range

flags - record flags, should be in [0, 0xFF], see JDB2Manager.FLAG_xxx for a list of accepted flags

Returns:

the output stream for the newly-created record

Throws:

IOException - if the record could not be initialized

endRecord

public void endRecord(OutputStream out)
               throws IOException

Description copied from interface: IFileDatabaseWriter

Close an opened record.

Specified by:

endRecord in interface IFileDatabaseWriter

Parameters:

out - the record output stream returned by IFileDatabaseWriter.beginRecord(int, int)

Throws:

IOException - if the record could not be finalized

verify

public void verify()

Description copied from interface: IFileDatabaseWriter

Verify that all opened records were closed. To be called before Closeable.close() if no I/O error happened.

Specified by:

verify in interface IFileDatabaseWriter

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException