SmallBlockTableReader (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.poifs.storage
Class SmallBlockTableReader

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

public final class SmallBlockTableReader
extends java.lang.Object
extends java.lang.Object

This class implements reading the small document block list from an existing file

Constructor Summary
`SmallBlockTableReader()`

Method Summary
`static BlockAllocationTableReader`	`_getSmallDocumentBlockReader(POIFSBigBlockSize bigBlockSize, RawDataBlockList blockList, RootProperty root, int sbatStart)` Fetch the small document block reader from an existing file, normally needed for debugging and low level dumping.
`static BlockList`	`getSmallDocumentBlocks(POIFSBigBlockSize bigBlockSize, RawDataBlockList blockList, RootProperty root, int sbatStart)` Fetch the small document block list from an existing file

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SmallBlockTableReader

public SmallBlockTableReader()

Method Detail

_getSmallDocumentBlockReader

public static BlockAllocationTableReader _getSmallDocumentBlockReader(POIFSBigBlockSize bigBlockSize,
                                                                      RawDataBlockList blockList,
                                                                      RootProperty root,
                                                                      int sbatStart)
                                                               throws java.io.IOException

Fetch the small document block reader from an existing file, normally needed for debugging and low level dumping. You should typically call getSmallDocumentBlocks(POIFSBigBlockSize, RawDataBlockList, RootProperty, int) instead.

Parameters:: blockList - the raw data from which the small block table will be extracted; root - the root property (which contains the start block and small block table size); sbatStart - the start block of the SBAT
Returns:: the small document block reader
Throws:: java.io.IOException

getSmallDocumentBlocks

public static BlockList getSmallDocumentBlocks(POIFSBigBlockSize bigBlockSize,
                                               RawDataBlockList blockList,
                                               RootProperty root,
                                               int sbatStart)
                                        throws java.io.IOException

Fetch the small document block list from an existing file

Parameters:: blockList - the raw data from which the small block table will be extracted; root - the root property (which contains the start block and small block table size); sbatStart - the start block of the SBAT
Returns:: the small document block list
Throws:: java.io.IOException