loci.poi.poifs.storage

Class HeaderBlockReader

java.lang.Object

loci.poi.poifs.storage.HeaderBlockReader

All Implemented Interfaces:

HeaderBlockConstants

public class HeaderBlockReader
extends Object
implements HeaderBlockConstants

The block containing the archive header

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
private IntegerField	_bat_count
private byte[]	_data
private IntegerField	_property_start
private IntegerField	_sbat_start
private IntegerField	_xbat_count
private IntegerField	_xbat_start
private int	batsInHeader

Fields inherited from interface loci.poi.poifs.storage.HeaderBlockConstants

_bat_array_offset, _bat_count_offset, _property_start_offset, _sbat_block_count_offset, _sbat_start_offset, _signature, _signature_offset, _xbat_count_offset, _xbat_start_offset

Constructor Summary

Constructors

Constructor and Description
HeaderBlockReader(InputStream stream, int blockSize) create a new HeaderBlockReader from an InputStream

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getBATArray()
int	getBATCount()
int	getPropertyStart() get start of Property Table
int	getSBATStart()
int	getXBATCount()
int	getXBATIndex()

Methods inherited from class java.lang.Object

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

Field Detail

_bat_count

private IntegerField _bat_count

_property_start

private IntegerField _property_start

_sbat_start

private IntegerField _sbat_start

_xbat_start

private IntegerField _xbat_start

_xbat_count

private IntegerField _xbat_count

_data

private byte[] _data

batsInHeader

private int batsInHeader

Constructor Detail

HeaderBlockReader

public HeaderBlockReader(InputStream stream,
                 int blockSize)
                  throws IOException

create a new HeaderBlockReader from an InputStream

Parameters:

stream - the source InputStream

blockSize - the size of a big block

Throws:

IOException - on errors or bad data

Method Detail

getPropertyStart

public int getPropertyStart()

get start of Property Table

Returns:

the index of the first block of the Property Table

getSBATStart

public int getSBATStart()

Returns:

start of small block allocation table

getBATCount

public int getBATCount()

Returns:

number of BAT blocks

getBATArray

public int[] getBATArray()

Returns:

BAT array

getXBATCount

public int getXBATCount()

Returns:

XBAT count

getXBATIndex

public int getXBATIndex()

Returns:

XBAT index