Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hpsf » [javadoc | source]
org.apache.poi.hpsf
public class: MutablePropertySet [javadoc | source]
java.lang.Object
   org.apache.poi.hpsf.PropertySet
      org.apache.poi.hpsf.MutablePropertySet

Direct Known Subclasses:
    DocumentSummaryInformation, SpecialPropertySet, SummaryInformation

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.

Fields inherited from org.apache.poi.hpsf.PropertySet:
BYTE_ORDER_ASSERTION,  byteOrder,  FORMAT_ASSERTION,  format,  osVersion,  OS_WIN16,  OS_MACINTOSH,  OS_WIN32,  classID,  sections
Constructor:
 public MutablePropertySet() 
 public MutablePropertySet(PropertySet ps) 

    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
Method from org.apache.poi.hpsf.MutablePropertySet Summary:
addSection,   clearSections,   setByteOrder,   setClassID,   setFormat,   setOSVersion,   toInputStream,   write,   write
Methods from org.apache.poi.hpsf.PropertySet:
equals,   getByteOrder,   getClassID,   getFirstSection,   getFormat,   getOSVersion,   getProperties,   getProperty,   getPropertyBooleanValue,   getPropertyIntValue,   getSectionCount,   getSections,   getSingleSection,   hashCode,   isDocumentSummaryInformation,   isPropertySetStream,   isPropertySetStream,   isSummaryInformation,   toString,   wasNull
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hpsf.MutablePropertySet Detail:
 public  void addSection(Section section) 

    Adds a section to this property set.

 public  void clearSections() 

    Removes all sections from this property set.

 public  void setByteOrder(int byteOrder) 

    Sets the "byteOrder" property.

 public  void setClassID(ClassID classID) 

    Sets the property set stream's low-level "class ID" field.

 public  void setFormat(int format) 

    Sets the "format" property.

 public  void setOSVersion(int osVersion) 

    Sets the "osVersion" property.

 public InputStream toInputStream() throws IOException, WritingNotSupportedException 

    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.

 public  void write(OutputStream out) throws IOException, WritingNotSupportedException 

    Writes the property set to an output stream.

 public  void write(DirectoryEntry dir,
    String name) throws IOException, WritingNotSupportedException 

    Writes a property set to a document in a POI filesystem directory.