binaryFileStorage

Class ModuleFooter

java.lang.Object

binaryFileStorage.ModuleFooter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClickBinaryModuleFooter

public abstract class ModuleFooter
extends java.lang.Object
implements java.io.Serializable

Class to contain module specific information which will be stored at the end of a binary data file, just before the BinaryFooter.

Author:

Doug Gillespie

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModuleFooter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	createFooter(BinaryObjectData binaryObjectData, BinaryHeader binaryHeader, ModuleHeader moduleHeader) Read data from a byte array to recreate a module header being read back from file.
abstract byte[]	getByteArray() Get module specific data to write to the footer.
boolean	writeModuleFooter(java.io.DataOutputStream dos) Writes the module header to a DataOutputStream

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFooter

public ModuleFooter()

Method Detail

writeModuleFooter

public final boolean writeModuleFooter(java.io.DataOutputStream dos)

Writes the module header to a DataOutputStream

Parameters:

dos - Data output stream (generally a binary file)

Returns:

true if successful

getByteArray

public abstract byte[] getByteArray()

Get module specific data to write to the footer. Note that this is just the module data, not the object identifier.

Returns:

byte array or null

createFooter

public abstract boolean createFooter(BinaryObjectData binaryObjectData,
                   BinaryHeader binaryHeader,
                   ModuleHeader moduleHeader)

Read data from a byte array to recreate a module header being read back from file.

The BinaryHeader and ModuleHeader can be used to check version numbers if required.

Parameters:

binaryObjectData - data read from file

binaryHeader - binary Header from data file

moduleHeader - module specific header from data file

Returns:

true if unpacked successfully.