PropertyBlock

java.lang.Object

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

org.docx4j.org.apache.poi.poifs.storage.PropertyBlock

All Implemented Interfaces:: BlockWritable

public final class PropertyBlock extends BigBlock

A block of Property instances

Field Summary

Fields

Modifier and Type

Field

Description

private Property[]

_properties

Fields inherited from class org.docx4j.org.apache.poi.poifs.storage.BigBlock
bigBlockSize
Constructor Summary

Constructors

Modifier

Constructor

Description

private

PropertyBlock(POIFSBigBlockSize bigBlockSize, Property[] properties, int offset)

Create a single instance initialized with default values
Method Summary

Modifier and Type

Method

Description

static BlockWritable[]

createPropertyBlockArray(POIFSBigBlockSize bigBlockSize, List<Property> properties)

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

(package private) void

writeData(OutputStream stream)

Write the block's data to an OutputStream

Methods inherited from class org.docx4j.org.apache.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 Details
- _properties
  
  private Property[] _properties
Constructor Details
- PropertyBlock
  
  private PropertyBlock(POIFSBigBlockSize bigBlockSize, Property[] properties, int offset)
  
  Create a single instance initialized with default values
  
  Parameters:
  
  properties - the properties to be inserted
  
  offset - the offset into the properties array
Method Details
- createPropertyBlockArray
  
  public static BlockWritable[] createPropertyBlockArray(POIFSBigBlockSize bigBlockSize, List<Property> properties)
  
  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