com.atlassian.clover.registry.format

Class RegHeader

java.lang.Object

com.atlassian.clover.registry.format.RegHeader

public class RegHeader
extends Object

Encapsulates the header of a Clover registry file. Great care has been taken to ensure this class can be used with NIO and with old IO. Old IO usage is necessary so that Java 1.4 is not required at runtime.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NAME_LENGTH
static int	REG_FORMAT_VERSION
static long	REG_MAGIC
static int	SIZE Size in bytes of the header

Method Summary

Modifier and Type	Method and Description
RegAccessMode	getAccessMode()
long	getCoverageLocation()
long	getLastSessionLocation()
String	getName()
int	getSlotCount()
long	getVersion()
static RegHeader	readFrom(File registryFile) Read the registry header.
protected static RegHeader	readFrom(com.atlassian.clover.registry.format.RegHeader.HeaderInputSource dis) Read header using an abstraction on the underlying data source.
static RegHeader	readFrom(String name, FileChannel channel) Read the registry header via a NIO FileChannel.
void	write(FileChannel channel)

Methods inherited from class java.lang.Object

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

Field Detail

REG_MAGIC

public static final long REG_MAGIC

See Also:

Constant Field Values

REG_FORMAT_VERSION

public static final int REG_FORMAT_VERSION

See Also:

Constant Field Values

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

See Also:

Constant Field Values

SIZE

public static final int SIZE

Size in bytes of the header

See Also:

Constant Field Values

Method Detail

getAccessMode

public RegAccessMode getAccessMode()

getSlotCount

public int getSlotCount()

getVersion

public long getVersion()

getLastSessionLocation

public long getLastSessionLocation()

getCoverageLocation

public long getCoverageLocation()

getName

public String getName()

readFrom

public static RegHeader readFrom(File registryFile)
                          throws IOException,
                                 RegistryFormatException

Read the registry header. Used at recording time by recorders to find the size of the data array

Parameters:

registryFile - the registry file

Returns:

the header of the file

Throws:

IOException - if an unexpected IO problem occurs while reading

RegistryFormatException - if a known registry problem is encountered

readFrom

public static RegHeader readFrom(String name,
                                 FileChannel channel)
                          throws IOException,
                                 RegistryFormatException

Read the registry header via a NIO FileChannel.

Parameters:

name - the name of the registry file

channel - the file channel from which to read

Returns:

the header of the file

Throws:

IOException - if an unexpected IO problem occurs while reading

RegistryFormatException - if a known registry problem is encountered

readFrom

protected static RegHeader readFrom(com.atlassian.clover.registry.format.RegHeader.HeaderInputSource dis)
                             throws IOException,
                                    RegistryFormatException

Read header using an abstraction on the underlying data source. Necessary to avoid NIO references in a 1.3 or lesser environment.

Throws:

IOException

RegistryFormatException

write

public void write(FileChannel channel)
           throws IOException

Throws:

IOException