loci.poi.poifs.storage

Class PropertyBlock

java.lang.Object

loci.poi.poifs.storage.BigBlock

loci.poi.poifs.storage.PropertyBlock

All Implemented Interfaces:

BlockWritable

public class PropertyBlock
extends BigBlock

A block of Property instances

Author:

Marc Johnson (mjohnson at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
private Property[]	_properties
private int	_properties_per_block
private int	blockSize

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PropertyBlock(Property[] properties, int offset, int blockSize) Create a single instance initialized with default values

Method Summary

Methods

Modifier and Type	Method and Description
static BlockWritable[]	createPropertyBlockArray(List properties, int size) Create an array of PropertyBlocks from an array of Property instances, creating empty Property instances to make up any shortfall
int	getBigBlockSize()
(package private) void	writeData(OutputStream stream) Write the block's data to an OutputStream

Methods inherited from class loci.poi.poifs.storage.BigBlock

doWriteData, writeBlocks

Methods inherited from class java.lang.Object

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

Field Detail

_properties

private Property[] _properties

_properties_per_block

private int _properties_per_block

blockSize

private int blockSize

Constructor Detail

PropertyBlock

private PropertyBlock(Property[] properties,
             int offset,
             int blockSize)

Create a single instance initialized with default values

Parameters:

properties - the properties to be inserted

offset - the offset into the properties array

blockSize - size of a big block

Method Detail

getBigBlockSize

public int getBigBlockSize()

Specified by:

getBigBlockSize in class BigBlock

createPropertyBlockArray

public static BlockWritable[] createPropertyBlockArray(List properties,
                                       int size)

Create an array of PropertyBlocks from an array of Property instances, creating empty Property instances to make up any shortfall

Parameters:

properties - the Property instances to be converted into PropertyBlocks, in a java List

Returns:

the array of newly created PropertyBlock instances

writeData

void writeData(OutputStream stream)
         throws IOException

Write the block's data to an OutputStream

Specified by:

writeData in class BigBlock

Parameters:

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

Throws:

IOException - on problems writing to the specified stream