Package org.docx4j.org.apache.poi.poifs.storage

Class BigBlock

java.lang.Object

org.docx4j.org.apache.poi.poifs.storage.BigBlock

All Implemented Interfaces:

BlockWritable

Direct Known Subclasses:

BATBlock, DocumentBlock, PropertyBlock

abstract class BigBlock
extends Object
implements BlockWritable

Field Summary

Fields

Modifier and Type	Field	Description
protected POIFSBigBlockSize	bigBlockSize	Either 512 bytes (POIFSConstants.SMALLER_BIG_BLOCK_SIZE) or 4096 bytes (POIFSConstants.LARGER_BIG_BLOCK_SIZE)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BigBlock(POIFSBigBlockSize bigBlockSize)

Method Summary

Modifier and Type	Method	Description
protected void	doWriteData(OutputStream stream, byte[] data)	Default implementation of write for extending classes that contain their data in a simple array of bytes.
void	writeBlocks(OutputStream stream)	Write the storage to an OutputStream
(package private) abstract void	writeData(OutputStream stream)	Write the block's data to an OutputStream

Methods inherited from class java.lang.Object

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

Field Details

bigBlockSize

protected POIFSBigBlockSize bigBlockSize

Either 512 bytes (POIFSConstants.SMALLER_BIG_BLOCK_SIZE) or 4096 bytes (POIFSConstants.LARGER_BIG_BLOCK_SIZE)

Constructor Details

BigBlock

protected BigBlock(POIFSBigBlockSize bigBlockSize)

Method Details

doWriteData

protected void doWriteData(OutputStream stream,
 byte[] data)
                    throws IOException

Default implementation of write for extending classes that contain their data in a simple array of bytes.

Parameters:

stream - the OutputStream to which the data should be written.

data - the byte array of to be written.

Throws:

IOException - on problems writing to the specified stream.

writeData

abstract void writeData(OutputStream stream)
                 throws IOException

Write the block's data to an OutputStream

Parameters:

stream - the OutputStream to which the stored data should be written

Throws:

IOException - on problems writing to the specified stream

writeBlocks

public void writeBlocks(OutputStream stream)
                 throws IOException

Write the storage to an OutputStream

Specified by:

writeBlocks in interface BlockWritable

Parameters:

stream - the OutputStream to which the stored data should be written

Throws:

IOException - on problems writing to the specified stream