binaryFileStorage

Class ModuleHeader

java.lang.Object

binaryFileStorage.ModuleHeader

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClickBinaryModuleHeader, LtsaModuleHeader, WhistleBinaryModuleHeader

public abstract class ModuleHeader
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
ModuleHeader(int moduleVersion)

Method Summary

Methods

Modifier and Type	Method and Description
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

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

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