public interface

IFileDatabaseWriter

com.pnfsoftware.jeb.core.dao.IFileDatabaseWriter
Known Indirect Subclasses

Class Overview

A database record writer.

See Also

Summary

Public Methods
abstract OutputStream beginRecord(int type, int flags)
Initialize a new record.
abstract void close()
Close the writer.
abstract void endRecord(OutputStream out)
Close an opened record.
abstract File getBackingFile()
Retrieve the backing file, if any.@return
abstract boolean hasBackingFile()
Determine if this database is backed by a file.
abstract void verify()
Verify that all opened records were closed.

Public Methods

public abstract OutputStream beginRecord (int type, int flags)

Initialize a new record.

Parameters
type the record type, should be in [0, 0xFFFFFF]
flags record flags, should be in [0, 0xFF]
Returns
  • the output stream for the newly-created record
Throws
IOException

public abstract void close ()

Close the writer.

Throws
IOException

public abstract void endRecord (OutputStream out)

Close an opened record.

Throws
IOException

public abstract File getBackingFile ()

Retrieve the backing file, if any.@return

Throws
NoSuchFileException

public abstract boolean hasBackingFile ()

Determine if this database is backed by a file.

public abstract void verify ()

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

Throws
IllegalStateException on error