Class PropertyTable
java.lang.Object
org.docx4j.org.apache.poi.poifs.property.PropertyTableBase
org.docx4j.org.apache.poi.poifs.property.PropertyTable
- All Implemented Interfaces:
BATManaged
,BlockWritable
public final class PropertyTable extends PropertyTableBase implements BlockWritable
This class embodies the Property Table for the
POIFSFileSystem
;
this is basically the directory for all of the documents in the
filesystem.- Author:
- Marc Johnson (mjohnson at apache dot org)
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PropertyTable(HeaderBlock headerBlock)
PropertyTable(HeaderBlock headerBlock, RawDataBlockList blockList)
reading constructor (used when we've read in a file and we want to extract the property table from it). -
Method Summary
Modifier and Type Method Description int
countBlocks()
Return the number of BigBlock's this instance usesvoid
preWrite()
Prepare to be writtenvoid
writeBlocks(java.io.OutputStream stream)
Write the storage to an OutputStreamMethods inherited from class org.docx4j.org.apache.poi.poifs.property.PropertyTableBase
addProperty, getRoot, getStartBlock, removeProperty, setStartBlock
-
Constructor Details
-
PropertyTable
-
PropertyTable
public PropertyTable(HeaderBlock headerBlock, RawDataBlockList blockList) throws java.io.IOExceptionreading constructor (used when we've read in a file and we want to extract the property table from it). Populates the properties thoroughly- Parameters:
headerBlock
- the header block of the fileblockList
- the list of blocks- Throws:
java.io.IOException
- if anything goes wrong (which should be a result of the input being NFG)
-
-
Method Details
-
preWrite
public void preWrite()Prepare to be written -
countBlocks
public int countBlocks()Return the number of BigBlock's this instance uses- Specified by:
countBlocks
in interfaceBATManaged
- Returns:
- count of BigBlock instances
-
writeBlocks
public void writeBlocks(java.io.OutputStream stream) throws java.io.IOExceptionWrite the storage to an OutputStream- Specified by:
writeBlocks
in interfaceBlockWritable
- Parameters:
stream
- the OutputStream to which the stored data should be written- Throws:
java.io.IOException
- on problems writing to the specified stream
-