org.apache.poi.poifs.storage
Class HeaderBlockReader

java.lang.Object
  org.apache.poi.poifs.storage.HeaderBlockReader

public final class HeaderBlockReader
extends java.lang.Object

The block containing the archive header

Author:

Marc Johnson (mjohnson at apache dot org)

Constructor Summary

HeaderBlockReader(java.io.InputStream stream)
create a new HeaderBlockReader from an InputStream

Method Summary

int[]	getBATArray() Returns the offsets to the first (up to) 109 BAT sectors.
int	getBATCount()
POIFSBigBlockSize	getBigBlockSize()
int	getPropertyStart() get start of Property Table
int	getSBATCount()
int	getSBATStart()
int	getXBATCount()
int	getXBATIndex()

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderBlockReader

public HeaderBlockReader(java.io.InputStream stream)
                  throws java.io.IOException

create a new HeaderBlockReader from an InputStream

Parameters:

stream - the source InputStream

Throws:

java.io.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 (MiniFAT) allocation table

getSBATCount

public int getSBATCount()

getBATCount

public int getBATCount()

Returns:

number of BAT blocks

getBATArray

public int[] getBATArray()

Returns the offsets to the first (up to) 109 BAT sectors. Any additional BAT sectors

Returns:

BAT offset array

getXBATCount

public int getXBATCount()

Returns:

XBAT (DIFAT) count

getXBATIndex

public int getXBATIndex()

Returns:

XBAT (DIFAT) index

getBigBlockSize

public POIFSBigBlockSize getBigBlockSize()

Returns:

The Big Block size, normally 512 bytes, sometimes 4096 bytes