binaryFileStorage
Class ModuleHeader

java.lang.Object
  binaryFileStorage.ModuleHeader

Direct Known Subclasses:

ClickBinaryModuleHeader

public abstract class ModuleHeader
extends java.lang.Object

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

Field Summary

private int

moduleVersion

Constructor Summary

ModuleHeader(int moduleVersion)

Method Summary

abstract boolean	createHeader(BinaryObjectData binaryObjectData, BinaryHeader binaryHeader) Read data from a byte array to recreate a module header being read back from file.
int	getModuleVersion()

Methods inherited from class java.lang.Object

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

Field Detail

moduleVersion

private int moduleVersion

Constructor Detail

ModuleHeader

public ModuleHeader(int moduleVersion)

Parameters:

moduleVersion -

Method Detail

createHeader

public abstract boolean createHeader(BinaryObjectData binaryObjectData,
                                     BinaryHeader binaryHeader)

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

Returns:

true if unpacked successfully.

getModuleVersion

public int getModuleVersion()

Returns:

the moduleVersion