Class MutablePropertySet
- Direct Known Subclasses:
SpecialPropertySet
Adds writing support to the PropertySet class.
Please be aware that this class' functionality will be merged into the
PropertySet class at a later time, so the API will change.
- Since:
- 2003-02-19
- Version:
- $Id: MutablePropertySet.java 489730 2006-12-22 19:18:16Z bayard $
- Author:
- Rainer Klute <klute@rainer-klute.de>
-
Field Summary
Fields inherited from class loci.poi.hpsf.PropertySet
byteOrder, classID, format, OS_MACINTOSH, OS_WIN16, OS_WIN32, osVersion, sections -
Constructor Summary
ConstructorsConstructorDescriptionConstructs aMutablePropertySetinstance.Constructs aMutablePropertySetby doing a deep copy of an existingPropertySet. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSection(Section section) Adds a section to this property set.voidRemoves all sections from this property set.voidsetByteOrder(int byteOrder) Sets the "byteOrder" property.voidsetClassID(ClassID classID) Sets the property set stream's low-level "class ID" field.voidsetFormat(int format) Sets the "format" property.voidsetOSVersion(int osVersion) Sets the "osVersion" property.loci.common.RandomAccessInputStreamReturns the contents of this property set stream as an input stream.voidwrite(OutputStream out) Writes the property set to an output stream.voidwrite(DirectoryEntry dir, String name) Writes a property set to a document in a POI filesystem directory.Methods inherited from class loci.poi.hpsf.PropertySet
equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyBooleanValue, getPropertyIntValue, getSectionCount, getSections, getSingleSection, hashCode, isDocumentSummaryInformation, isPropertySetStream, isPropertySetStream, isSummaryInformation, toString, wasNull
-
Constructor Details
-
MutablePropertySet
public MutablePropertySet()Constructs a
MutablePropertySetinstance. Its primary task is to initialize the immutable field with their proper values. It also sets fields that might change to reasonable defaults. -
MutablePropertySet
Constructs a
MutablePropertySetby doing a deep copy of an existingPropertySet. All nested elements, i.e.Sections andPropertyinstances, will be their mutable counterparts in the newMutablePropertySet.- Parameters:
ps- The property set to copy
-
-
Method Details
-
setByteOrder
public void setByteOrder(int byteOrder) Sets the "byteOrder" property.
- Parameters:
byteOrder- the byteOrder value to set
-
setFormat
public void setFormat(int format) Sets the "format" property.
- Parameters:
format- the format value to set
-
setOSVersion
public void setOSVersion(int osVersion) Sets the "osVersion" property.
- Parameters:
osVersion- the osVersion value to set
-
setClassID
Sets the property set stream's low-level "class ID" field.
- Parameters:
classID- The property set stream's low-level "class ID" field.- See Also:
-
clearSections
public void clearSections()Removes all sections from this property set.
-
addSection
Adds a section to this property set.
- Parameters:
section- TheSectionto add. It will be appended after any sections that are already present in the property set and thus become the last section.
-
write
Writes the property set to an output stream.
- Parameters:
out- the output stream to write the section to- Throws:
IOException- if an error when writing to the output stream occursWritingNotSupportedException- if HPSF does not yet support writing a property's variant type.
-
toInputStream
public loci.common.RandomAccessInputStream toInputStream() throws IOException, WritingNotSupportedExceptionReturns the contents of this property set stream as an input stream. The latter can be used for example to write the property set into a POIFS document. The input stream represents a snapshot of the property set. If the latter is modified while the input stream is still being read, the modifications will not be reflected in the input stream but in the
MutablePropertySetonly.- Returns:
- the contents of this property set stream
- Throws:
WritingNotSupportedException- if HPSF does not yet support writing of a property's variant type.IOException- if an I/O exception occurs.
-
write
Writes a property set to a document in a POI filesystem directory.
- Parameters:
dir- The directory in the POI filesystem to write the document to.name- The document's name. If there is already a document with the same name in the directory the latter will be overwritten.- Throws:
WritingNotSupportedExceptionIOException
-