|
| |
|
| java.lang.Object
 org.apache.poi.hpsf.PropertySet
org.apache.poi.hpsf.MutablePropertySet
All known Subclasses: org.apache.poi.hpsf.SpecialPropertySet,
| MutablePropertySet | | public class MutablePropertySet extends PropertySet (Code) | | 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.
author:
Rainer Klute author:
href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de>
version:
$Id: MutablePropertySet.java 489730 2006-12-22 19:18:16Z bayard $
since:
2003-02-19 |
| Method Summary | |
| public void | addSection(Section section)
Adds a section to this property set.
Parameters:
section - The Section to add. | | public void | clearSections()
| | public void | setByteOrder(int byteOrder)
| | public void | setClassID(ClassID classID)
| | public void | setFormat(int format)
| | public void | setOSVersion(int osVersion)
| | public InputStream | toInputStream()
Returns 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. | | public void | write(OutputStream out)
| | public void | write(DirectoryEntry dir, String name)
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.
Parameters:
name - The document's name. |
| MutablePropertySet | | public MutablePropertySet()(Code) | | Constructs a MutablePropertySet instance. Its
primary task is to initialize the immutable field with their proper
values. It also sets fields that might change to reasonable defaults.
|
| MutablePropertySet | | public MutablePropertySet(PropertySet ps)(Code) | | Constructs a MutablePropertySet by doing a deep copy of
an existing PropertySet. All nested elements, i.e.
Sections and Property instances, will be their
mutable counterparts in the new MutablePropertySet.
Parameters:
ps - The property set to copy |
| addSection | | public void addSection(Section section)(Code) | | Adds a section to this property set.
Parameters:
section - The Section to add. It will be appendedafter any sections that are already present in the property setand thus become the last section. |
| clearSections | | public void clearSections()(Code) | | Removes all sections from this property set.
|
| setByteOrder | | public void setByteOrder(int byteOrder)(Code) | | Sets the "byteOrder" property.
Parameters:
byteOrder - the byteOrder value to set |
| setClassID | | public void setClassID(ClassID classID)(Code) | | 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: PropertySet.getClassID |
| setFormat | | public void setFormat(int format)(Code) | | Sets the "format" property.
Parameters:
format - the format value to set |
| setOSVersion | | public void setOSVersion(int osVersion)(Code) | | Sets the "osVersion" property.
Parameters:
osVersion - the osVersion value to set |
| toInputStream | | public InputStream toInputStream() throws IOException, WritingNotSupportedException(Code) | | Returns 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
MutablePropertySet only.
the contents of this property set stream
throws:
WritingNotSupportedException - if HPSF does not yet support writingof a property's variant type.
throws:
IOException - if an I/O exception occurs. |
|
|
|