loci.poi.poifs.storage

Class SmallDocumentBlockList

java.lang.Object

loci.poi.poifs.storage.SmallDocumentBlockList

All Implemented Interfaces:

BlockList

public class SmallDocumentBlockList
extends Object

A list of SmallDocumentBlocks instances, and methods to manage the list

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
protected ListManagedBlock[]	_blocks

Constructor Summary

Constructors

Constructor and Description
SmallDocumentBlockList(List blocks) Constructor SmallDocumentBlockList

Method Summary

Methods

Modifier and Type	Method and Description
ListManagedBlock[]	fetchBlocks(int startBlock) get the blocks making up a particular stream in the list.
ListManagedBlock[]	getBlocks()
ListManagedBlock	remove(int index) remove and return the specified block from the list
void	setBAT(BlockAllocationTableReader bat) set the associated BlockAllocationTable
protected void	setBlocks(ListManagedBlock[] blocks) provide blocks to manage
void	zap(int index) remove the specified block from the list

Methods inherited from class java.lang.Object

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

Field Detail

_blocks

protected ListManagedBlock[] _blocks

Constructor Detail

SmallDocumentBlockList

public SmallDocumentBlockList(List blocks)

Constructor SmallDocumentBlockList

Parameters:

blocks - a list of SmallDocumentBlock instances

Method Detail

getBlocks

public ListManagedBlock[] getBlocks()

setBlocks

protected void setBlocks(ListManagedBlock[] blocks)

provide blocks to manage

Parameters:

blocks - blocks to be managed

zap

public void zap(int index)

remove the specified block from the list

Specified by:

zap in interface BlockList

Parameters:

index - the index of the specified block; if the index is out of range, that's ok

remove

public ListManagedBlock remove(int index)
                        throws IOException

remove and return the specified block from the list

Specified by:

remove in interface BlockList

Parameters:

index - the index of the specified block

Returns:

the specified block

Throws:

IOException - if the index is out of range or has already been removed

fetchBlocks

public ListManagedBlock[] fetchBlocks(int startBlock)
                               throws IOException

get the blocks making up a particular stream in the list. The blocks are removed from the list.

Specified by:

fetchBlocks in interface BlockList

Parameters:

startBlock - the index of the first block in the stream

Returns:

the stream as an array of correctly ordered blocks

Throws:

IOException - if blocks are missing

setBAT

public void setBAT(BlockAllocationTableReader bat)
            throws IOException

set the associated BlockAllocationTable

Specified by:

setBAT in interface BlockList

Parameters:

bat - the associated BlockAllocationTable

Throws:

IOException