You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2016/11/28 15:43:46 UTC
svn commit: r1771763 [8/13] - in /poi/site/publish: ./ apidocs/
apidocs/org/apache/poi/class-use/ apidocs/org/apache/poi/hdgf/chunks/
apidocs/org/apache/poi/hdgf/pointers/ apidocs/org/apache/poi/hpbf/model/
apidocs/org/apache/poi/hpbf/model/qcbits/ api...
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySet.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySet.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySet.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySet.html Mon Nov 28 15:43:45 2016
@@ -104,28 +104,31 @@
<br>
<pre>public class <span class="strong">PropertySet</span>
extends java.lang.Object</pre>
-<div class="block"><p>Represents a property set in the Horrible Property Set Format
+<div class="block">Represents a property set in the Horrible Property Set Format
(HPSF). These are usually metadata of a Microsoft Office
- document.</p>
+ document.<p>
- <p>An application that wants to access these metadata should create
+ An application that wants to access these metadata should create
an instance of this class or one of its subclasses by calling the
factory method <a href="../../../../org/apache/poi/hpsf/PropertySetFactory.html#create(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)"><code>PropertySetFactory.create(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String)</code></a> and then retrieve
- the information its needs by calling appropriate methods.</p>
+ the information its needs by calling appropriate methods.<p>
- <p><a href="../../../../org/apache/poi/hpsf/PropertySetFactory.html#create(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)"><code>PropertySetFactory.create(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String)</code></a> does its work by calling one
+ <a href="../../../../org/apache/poi/hpsf/PropertySetFactory.html#create(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)"><code>PropertySetFactory.create(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String)</code></a> does its work by calling one
of the constructors <a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(java.io.InputStream)"><code>PropertySet(InputStream)</code></a> or
<a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[])"><code>PropertySet(byte[])</code></a>. If the constructor's
argument is not in the Horrible Property Set Format, i.e. not a
property set stream, or if any other error occurs, an appropriate
- exception is thrown.</p>
+ exception is thrown.<p>
- <p>A <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has a list of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s, and each
+ A <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has a list of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s, and each
<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> has a <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array. Use <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()"><code>getSections()</code></a> to retrieve the <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s, then call <a href="../../../../org/apache/poi/hpsf/Section.html#getProperties()"><code>Section.getProperties()</code></a> for each <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> to get hold of the
- <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> arrays.</p> Since the vast majority of <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>s contains only a single <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>, the
- convenience method <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()"><code>getProperties()</code></a> returns the properties of
- a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> (throwing a <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf"><code>NoSingleSectionException</code></a> if the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> contains more
- (or less) than exactly one <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>).</div>
+ <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> arrays.<p>
+
+ Since the vast majority of <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>s contains only a single
+ <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>, the convenience method <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()"><code>getProperties()</code></a> returns
+ the properties of a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> (throwing a
+ <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf"><code>NoSingleSectionException</code></a> if the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> contains
+ more (or less) than exactly one <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>).</div>
</li>
</ul>
</div>
@@ -145,57 +148,26 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#byteOrder">byteOrder</a></strong></code>
-<div class="block">Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s byte order.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#classID">classID</a></strong></code>
-<div class="block">Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s "classID" field.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#format">format</a></strong></code>
-<div class="block">Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s format.</div>
-</td>
-</tr>
-<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_MACINTOSH">OS_MACINTOSH</a></strong></code>
<div class="block">If the OS version field holds this value the property set stream was
created on a Macintosh system.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN16">OS_WIN16</a></strong></code>
<div class="block">If the OS version field holds this value the property set stream was
created on a 16-bit Windows system.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN32">OS_WIN32</a></strong></code>
<div class="block">If the OS version field holds this value the property set stream was
created on a 32-bit Windows system.</div>
</td>
</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#osVersion">osVersion</a></strong></code>
-<div class="block">Specifies the version of the operating system that created
- this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected java.util.List<<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a>></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#sections">sections</a></strong></code>
-<div class="block">The sections in this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
-</td>
-</tr>
</table>
</li>
</ul>
@@ -208,39 +180,38 @@ extends java.lang.Object</pre>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
-<th class="colFirst" scope="col">Modifier</th>
-<th class="colLast" scope="col">Constructor and Description</th>
+<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet()">PropertySet</a></strong>()</code>
-<div class="block">Creates an empty (uninitialized) <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet()">PropertySet</a></strong>()</code>
+<div class="block">Constructs a <code>PropertySet</code> instance.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[])">PropertySet</a></strong>(byte[] stream)</code>
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[])">PropertySet</a></strong>(byte[] stream)</code>
<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array
- that represents a stream in the Horrible Property Set
- Format.</div>
+ that represents a stream in the Horrible Property Set Format.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[],%20int,%20int)">PropertySet</a></strong>(byte[] stream,
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[],%20int,%20int)">PropertySet</a></strong>(byte[] stream,
int offset,
int length)</code>
-<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array
- that represents a stream in the Horrible Property Set
- Format.</div>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array that
+ represents a stream in the Horrible Property Set Format.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(java.io.InputStream)">PropertySet</a></strong>(java.io.InputStream stream)</code>
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(java.io.InputStream)">PropertySet</a></strong>(java.io.InputStream stream)</code>
<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(org.apache.poi.hpsf.PropertySet)">PropertySet</a></strong>(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)</code>
+<div class="block">Constructs a <code>PropertySet</code> by doing a deep copy of
+ an existing <code>PropertySet</code>.</div>
+</td>
+</tr>
</table>
</li>
</ul>
@@ -257,6 +228,18 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#addSection(org.apache.poi.hpsf.Section)">addSection</a></strong>(<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> section)</code>
+<div class="block">Adds a section to this property set.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#clearSections()">clearSections</a></strong>()</code>
+<div class="block">Removes all sections from this property set.</div>
+</td>
+</tr>
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code>
<div class="block">Returns <code>true</code> if the <code>PropertySet</code> is equal
@@ -265,17 +248,11 @@ extends java.lang.Object</pre>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getByteOrder()">getByteOrder</a></strong>()</code>
-<div class="block">Returns the property set stream's low-level "byte order"
- field.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getByteOrder()">getByteOrder</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()">getClassID</a></strong>()</code>
-<div class="block">Returns the property set stream's low-level "class ID"
- field.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()">getClassID</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></td>
@@ -285,37 +262,30 @@ extends java.lang.Object</pre>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFormat()">getFormat</a></strong>()</code>
-<div class="block">Returns the property set stream's low-level "format"
- field.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFormat()">getFormat</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getOSVersion()">getOSVersion</a></strong>()</code>
-<div class="block">Returns the property set stream's low-level "OS version"
- field.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getOSVersion()">getOSVersion</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()">getProperties</a></strong>()</code>
-<div class="block">Convenience method returning the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array
- contained in this property set.</div>
+<div class="block">Convenience method returning the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array contained in this
+ property set.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)">getProperty</a></strong>(int id)</code>
-<div class="block">Convenience method returning the value of the property with
- the specified ID.</div>
+<div class="block">Convenience method returning the value of the property with the specified ID.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a></strong>(int id)</code>
-<div class="block">Convenience method returning the value of a boolean property
- with the specified ID.</div>
+<div class="block">Convenience method returning the value of a boolean property with the
+ specified ID.</div>
</td>
</tr>
<tr class="rowColor">
@@ -326,70 +296,147 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSectionCount()">getSectionCount</a></strong>()</code>
-<div class="block">Returns the number of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property
- set.</div>
+<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertySetIDMap()">getPropertySetIDMap</a></strong>()</code>
+<div class="block">The id to name mapping of the properties in this set.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a>></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()">getSections</a></strong>()</code>
-<div class="block">Returns the <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property set.</div>
+<td class="colFirst"><code>protected java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(int)">getPropertyStringValue</a></strong>(int propertyId)</code>
+<div class="block">Fetches the property with the given ID, then does its
+ best to return it as a String</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(java.lang.Object)">getPropertyStringValue</a></strong>(java.lang.Object propertyValue)</code>
+<div class="block">Return the string representation of a property value</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSectionCount()">getSectionCount</a></strong>()</code> </td>
+</tr>
<tr class="altColor">
+<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()">getSections</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSingleSection()">getSingleSection</a></strong>()</code>
-<div class="block">If the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has only a single section this
- method returns it.</div>
+<div class="block">If the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has only a single section this method returns it.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#isDocumentSummaryInformation()">isDocumentSummaryInformation</a></strong>()</code>
-<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> is a Document
- Summary Information.</div>
+<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> is a Document Summary Information.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(byte[],%20int,%20int)">isPropertySetStream</a></strong>(byte[] src,
int offset,
int length)</code>
-<div class="block">Checks whether a byte array is in the Horrible Property Set
- Format.</div>
+<div class="block">Checks whether a byte array is in the Horrible Property Set Format.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(java.io.InputStream)">isPropertySetStream</a></strong>(java.io.InputStream stream)</code>
<div class="block">Checks whether an <code>InputStream</code> is in the Horrible
Property Set Format.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#isSummaryInformation()">isSummaryInformation</a></strong>()</code>
-<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> represents a Summary
- Information.</div>
+<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> represents a Summary Information.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#remove1stProperty(long)">remove1stProperty</a></strong>(long id)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20boolean)">set1stProperty</a></strong>(long id,
+ boolean value)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20byte[])">set1stProperty</a></strong>(long id,
+ byte[] value)</code> </td>
+</tr>
<tr class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20int)">set1stProperty</a></strong>(long id,
+ int value)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20java.lang.String)">set1stProperty</a></strong>(long id,
+ java.lang.String value)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#setByteOrder(int)">setByteOrder</a></strong>(int byteOrder)</code>
+<div class="block">Returns the property set stream's low-level "byte order" field.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#setClassID(org.apache.poi.hpsf.ClassID)">setClassID</a></strong>(<a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> classID)</code>
+<div class="block">Sets the property set stream's low-level "class ID" field.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#setFormat(int)">setFormat</a></strong>(int format)</code>
+<div class="block">Sets the property set stream's low-level "format" field.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#setOSVersion(int)">setOSVersion</a></strong>(int osVersion)</code>
+<div class="block">Sets the property set stream's low-level "OS version" field.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.io.InputStream</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#toInputStream()">toInputStream</a></strong>()</code>
+<div class="block">Returns the contents of this property set stream as an input stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#toString()">toString</a></strong>()</code> </td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()">wasNull</a></strong>()</code>
<div class="block">Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)"><code>getPropertyIntValue(int)</code></a> or <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)"><code>getProperty(int)</code></a> tried to access
was available or not.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)">write</a></strong>(<a href="../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a> dir,
+ java.lang.String name)</code>
+<div class="block">Writes a property set to a document in a POI filesystem directory.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream out)</code>
+<div class="block">Writes the property set to an output stream.</div>
+</td>
+</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -412,40 +459,6 @@ extends java.lang.Object</pre>
<!-- -->
</a>
<h3>Field Detail</h3>
-<a name="byteOrder">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>byteOrder</h4>
-<pre>protected int byteOrder</pre>
-<div class="block"><p>Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s byte order. See the
- HPFS documentation for details!</p></div>
-</li>
-</ul>
-<a name="format">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>format</h4>
-<pre>protected int format</pre>
-<div class="block"><p>Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s format. See the HPFS
- documentation for details!</p></div>
-</li>
-</ul>
-<a name="osVersion">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>osVersion</h4>
-<pre>protected int osVersion</pre>
-<div class="block"><p>Specifies the version of the operating system that created
- this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>. See the HPFS documentation for
- details!</p></div>
-</li>
-</ul>
<a name="OS_WIN16">
<!-- -->
</a>
@@ -453,8 +466,8 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>OS_WIN16</h4>
<pre>public static final int OS_WIN16</pre>
-<div class="block"><p>If the OS version field holds this value the property set stream was
- created on a 16-bit Windows system.</p></div>
+<div class="block">If the OS version field holds this value the property set stream was
+ created on a 16-bit Windows system.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.PropertySet.OS_WIN16">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -465,44 +478,23 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>OS_MACINTOSH</h4>
<pre>public static final int OS_MACINTOSH</pre>
-<div class="block"><p>If the OS version field holds this value the property set stream was
- created on a Macintosh system.</p></div>
+<div class="block">If the OS version field holds this value the property set stream was
+ created on a Macintosh system.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.PropertySet.OS_MACINTOSH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="OS_WIN32">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
<h4>OS_WIN32</h4>
<pre>public static final int OS_WIN32</pre>
-<div class="block"><p>If the OS version field holds this value the property set stream was
- created on a 32-bit Windows system.</p></div>
+<div class="block">If the OS version field holds this value the property set stream was
+ created on a 32-bit Windows system.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.PropertySet.OS_WIN32">Constant Field Values</a></dd></dl>
</li>
</ul>
-<a name="classID">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>classID</h4>
-<pre>protected <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> classID</pre>
-<div class="block"><p>Specifies this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s "classID" field. See
- the HPFS documentation for details!</p></div>
-</li>
-</ul>
-<a name="sections">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>sections</h4>
-<pre>protected java.util.List<<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a>> sections</pre>
-<div class="block"><p>The sections in this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p></div>
-</li>
-</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
@@ -517,13 +509,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>PropertySet</h4>
-<pre>protected PropertySet()</pre>
-<div class="block"><p>Creates an empty (uninitialized) <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p>
-
- <p><strong>Please note:</strong> For the time being this
- constructor is protected since it is used for internal purposes
- only, but expect it to become public once the property set's
- writing functionality is implemented.</p></div>
+<pre>public PropertySet()</pre>
+<div class="block">Constructs a <code>PropertySet</code> instance. Its
+ primary task is to initialize the field with their proper values.
+ It also sets fields that might change to reasonable defaults.</div>
</li>
</ul>
<a name="PropertySet(java.io.InputStream)">
@@ -537,25 +526,21 @@ extends java.lang.Object</pre>
<a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a>,
java.io.IOException,
java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</p>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.<p>
- <p>The constructor reads the first few bytes from the stream
+ The constructor reads the first few bytes from the stream
and determines whether it is really a property set stream. If
it is, it parses the rest of the stream. If it is not, it
resets the stream to its beginning in order to let other
components mess around with the data and throws an
- exception.</p></div>
+ exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - Holds the data making out the property set
stream.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a></code> - if the stream does not support
- the <code>InputStream.markSupported()</code> method.</dd>
-<dd><code>java.io.IOException</code> - if the <code>InputStream</code> cannot be
- accessed as needed.</dd>
-<dd><code><a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a></code> - if the input stream does not
- contain a property set.</dd>
-<dd><code>java.io.UnsupportedEncodingException</code> - if a character encoding is not
- supported.</dd></dl>
+<dd><code><a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a></code> - if the stream does not support the <code>InputStream.markSupported()</code> method.</dd>
+<dd><code>java.io.IOException</code> - if the <code>InputStream</code> cannot be accessed as needed.</dd>
+<dd><code><a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a></code> - if the input stream does not contain a property set.</dd>
+<dd><code>java.io.UnsupportedEncodingException</code> - if a character encoding is not supported.</dd></dl>
</li>
</ul>
<a name="PropertySet(byte[], int, int)">
@@ -569,12 +554,11 @@ extends java.lang.Object</pre>
int length)
throws <a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a>,
java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array
- that represents a stream in the Horrible Property Set
- Format.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The byte array holding the stream data.</dd><dd><code>offset</code> - The offset in <var>stream</var> where the stream
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array that
+ represents a stream in the Horrible Property Set Format.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The byte array holding the stream data.</dd><dd><code>offset</code> - The offset in <code>stream</code> where the stream
data begin. If the stream data begin with the first byte in the
- array, the <var>offset</var> is 0.</dd><dd><code>length</code> - The length of the stream data.</dd>
+ array, the <code>offset</code> is 0.</dd><dd><code>length</code> - The length of the stream data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a></code> - if the byte array is not a
property set stream.</dd>
@@ -584,15 +568,14 @@ extends java.lang.Object</pre>
<a name="PropertySet(byte[])">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>PropertySet</h4>
<pre>public PropertySet(byte[] stream)
throws <a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a>,
java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array
- that represents a stream in the Horrible Property Set
- Format.</p></div>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array
+ that represents a stream in the Horrible Property Set Format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The byte array holding the stream data. The
complete byte array contents is the stream data.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -601,6 +584,20 @@ extends java.lang.Object</pre>
<dd><code>java.io.UnsupportedEncodingException</code> - if the codepage is not supported.</dd></dl>
</li>
</ul>
+<a name="PropertySet(org.apache.poi.hpsf.PropertySet)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>PropertySet</h4>
+<pre>public PropertySet(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)</pre>
+<div class="block">Constructs a <code>PropertySet</code> by doing a deep copy of
+ an existing <code>PropertySet</code>. All nested elements, i.e.
+ <code>Section</code>s and <code>Property</code> instances, will be their
+ counterparts in the new <code>PropertySet</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ps</code> - The property set to copy</dd></dl>
+</li>
+</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
@@ -616,9 +613,18 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getByteOrder</h4>
<pre>public int getByteOrder()</pre>
-<div class="block"><p>Returns the property set stream's low-level "byte order"
- field. It is always <tt>0xFFFE</tt> .</p></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "byte order" field.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "byte order" field. It is always <code>0xFFFE</code>.</dd></dl>
+</li>
+</ul>
+<a name="setByteOrder(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setByteOrder</h4>
+<pre>public void setByteOrder(int byteOrder)</pre>
+<div class="block">Returns the property set stream's low-level "byte order" field.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>byteOrder</code> - The property set stream's low-level "byte order" field.</dd></dl>
</li>
</ul>
<a name="getFormat()">
@@ -628,9 +634,18 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getFormat</h4>
<pre>public int getFormat()</pre>
-<div class="block"><p>Returns the property set stream's low-level "format"
- field. It is always <tt>0x0000</tt> .</p></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "format" field.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "format" field. It is always <code>0x0000</code>.</dd></dl>
+</li>
+</ul>
+<a name="setFormat(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setFormat</h4>
+<pre>public void setFormat(int format)</pre>
+<div class="block">Sets the property set stream's low-level "format" field.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - The property set stream's low-level "format" field.</dd></dl>
</li>
</ul>
<a name="getOSVersion()">
@@ -640,11 +655,20 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getOSVersion</h4>
<pre>public int getOSVersion()</pre>
-<div class="block"><p>Returns the property set stream's low-level "OS version"
- field.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "OS version" field.</dd></dl>
</li>
</ul>
+<a name="setOSVersion(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setOSVersion</h4>
+<pre>public void setOSVersion(int osVersion)</pre>
+<div class="block">Sets the property set stream's low-level "OS version" field.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>osVersion</code> - The property set stream's low-level "OS version" field.</dd></dl>
+</li>
+</ul>
<a name="getClassID()">
<!-- -->
</a>
@@ -652,11 +676,20 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getClassID</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> getClassID()</pre>
-<div class="block"><p>Returns the property set stream's low-level "class ID"
- field.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The property set stream's low-level "class ID" field.</dd></dl>
</li>
</ul>
+<a name="setClassID(org.apache.poi.hpsf.ClassID)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setClassID</h4>
+<pre>public void setClassID(<a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> classID)</pre>
+<div class="block">Sets the property set stream's low-level "class ID" field.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classID</code> - The property set stream's low-level "class ID" field.</dd></dl>
+</li>
+</ul>
<a name="getSectionCount()">
<!-- -->
</a>
@@ -664,8 +697,6 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getSectionCount</h4>
<pre>public int getSectionCount()</pre>
-<div class="block"><p>Returns the number of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property
- set.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property set.</dd></dl>
</li>
</ul>
@@ -676,8 +707,41 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getSections</h4>
<pre>public java.util.List<<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a>> getSections()</pre>
-<div class="block"><p>Returns the <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property set.</p></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property set.</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The unmodifiable list of <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s in the property set.</dd></dl>
+</li>
+</ul>
+<a name="addSection(org.apache.poi.hpsf.Section)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addSection</h4>
+<pre>public void addSection(<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> section)</pre>
+<div class="block">Adds a section to this property set.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>section</code> - The <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> to add. It will be appended
+ after any sections that are already present in the property set
+ and thus become the last section.</dd></dl>
+</li>
+</ul>
+<a name="clearSections()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>clearSections</h4>
+<pre>public void clearSections()</pre>
+<div class="block">Removes all sections from this property set.</div>
+</li>
+</ul>
+<a name="getPropertySetIDMap()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPropertySetIDMap</h4>
+<pre>public <a href="../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> getPropertySetIDMap()</pre>
+<div class="block">The id to name mapping of the properties in this set.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the id to name mapping of the properties in this set or <code>null</code> if not applicable</dd></dl>
</li>
</ul>
<a name="isPropertySetStream(java.io.InputStream)">
@@ -689,8 +753,8 @@ extends java.lang.Object</pre>
<pre>public static boolean isPropertySetStream(java.io.InputStream stream)
throws <a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a>,
java.io.IOException</pre>
-<div class="block"><p>Checks whether an <code>InputStream</code> is in the Horrible
- Property Set Format.</p></div>
+<div class="block">Checks whether an <code>InputStream</code> is in the Horrible
+ Property Set Format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - The <code>InputStream</code> to check. In order to
perform the check, the method reads the first bytes from the
stream. After reading, the stream is reset to the position it
@@ -713,14 +777,96 @@ extends java.lang.Object</pre>
<pre>public static boolean isPropertySetStream(byte[] src,
int offset,
int length)</pre>
-<div class="block"><p>Checks whether a byte array is in the Horrible Property Set
- Format.</p></div>
+<div class="block">Checks whether a byte array is in the Horrible Property Set Format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - The byte array to check.</dd><dd><code>offset</code> - The offset in the byte array.</dd><dd><code>length</code> - The significant number of bytes in the byte
array. Only this number of bytes will be checked.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the byte array is a property set
stream, <code>false</code> if not.</dd></dl>
</li>
</ul>
+<a name="write(java.io.OutputStream)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public void write(java.io.OutputStream out)
+ throws <a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a>,
+ java.io.IOException</pre>
+<div class="block">Writes the property set to an output stream.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - the output stream to write the section to</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if an error when writing to the output stream
+ occurs</dd>
+<dd><code><a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></code> - if HPSF does not yet support
+ writing a property's variant type.</dd></dl>
+</li>
+</ul>
+<a name="write(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>write</h4>
+<pre>public void write(<a href="../../../../org/apache/poi/poifs/filesystem/DirectoryEntry.html" title="interface in org.apache.poi.poifs.filesystem">DirectoryEntry</a> dir,
+ java.lang.String name)
+ throws <a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a>,
+ java.io.IOException</pre>
+<div class="block">Writes a property set to a document in a POI filesystem directory.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - The directory in the POI filesystem to write the document to.</dd><dd><code>name</code> - The document's name. If there is already a document with the
+ same name in the directory the latter will be overwritten.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></code> - if the filesystem doesn't support writing</dd>
+<dd><code>java.io.IOException</code> - if the old entry can't be deleted or the new entry be written</dd></dl>
+</li>
+</ul>
+<a name="toInputStream()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>toInputStream</h4>
+<pre>public java.io.InputStream toInputStream()
+ throws java.io.IOException,
+ <a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></pre>
+<div class="block">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 <a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html" title="class in org.apache.poi.hpsf"><code>MutablePropertySet</code></a> only.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the contents of this property set stream</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></code> - if HPSF does not yet support writing
+ of a property's variant type.</dd>
+<dd><code>java.io.IOException</code> - if an I/O exception occurs.</dd></dl>
+</li>
+</ul>
+<a name="getPropertyStringValue(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPropertyStringValue</h4>
+<pre>protected java.lang.String getPropertyStringValue(int propertyId)</pre>
+<div class="block">Fetches the property with the given ID, then does its
+ best to return it as a String</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyId</code> - the property id</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The property as a String, or null if unavailable</dd></dl>
+</li>
+</ul>
+<a name="getPropertyStringValue(java.lang.Object)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPropertyStringValue</h4>
+<pre>public static java.lang.String getPropertyStringValue(java.lang.Object propertyValue)</pre>
+<div class="block">Return the string representation of a property value</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyValue</code> - the property value</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The property value as a String, or null if unavailable</dd></dl>
+</li>
+</ul>
<a name="isSummaryInformation()">
<!-- -->
</a>
@@ -728,8 +874,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>isSummaryInformation</h4>
<pre>public boolean isSummaryInformation()</pre>
-<div class="block"><p>Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> represents a Summary
- Information.</p></div>
+<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> represents a Summary Information.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>
represents a Summary Information, else <code>false</code>.</dd></dl>
</li>
@@ -741,8 +886,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>isDocumentSummaryInformation</h4>
<pre>public boolean isDocumentSummaryInformation()</pre>
-<div class="block"><p>Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> is a Document
- Summary Information.</p></div>
+<div class="block">Checks whether this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> is a Document Summary Information.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>
represents a Document Summary Information, else <code>false</code>.</dd></dl>
</li>
@@ -755,10 +899,10 @@ extends java.lang.Object</pre>
<h4>getProperties</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] getProperties()
throws <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf">NoSingleSectionException</a></pre>
-<div class="block"><p>Convenience method returning the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array
- contained in this property set. It is a shortcut for getting
- the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s list and then
- getting the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array from the first <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</p></div>
+<div class="block">Convenience method returning the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array contained in this
+ property set. It is a shortcut for getting he <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s
+ <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>s list and then getting the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> array from the
+ first <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The properties of the only <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> of this
<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -774,9 +918,9 @@ extends java.lang.Object</pre>
<h4>getProperty</h4>
<pre>protected java.lang.Object getProperty(int id)
throws <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf">NoSingleSectionException</a></pre>
-<div class="block"><p>Convenience method returning the value of the property with
- the specified ID. If the property is not available,
- <code>null</code> is returned and a subsequent call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a> will return <code>true</code> .</p></div>
+<div class="block">Convenience method returning the value of the property with the specified ID.
+ If the property is not available, <code>null</code> is returned and a subsequent
+ call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a> will return <code>true</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property value</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -792,11 +936,10 @@ extends java.lang.Object</pre>
<h4>getPropertyBooleanValue</h4>
<pre>protected boolean getPropertyBooleanValue(int id)
throws <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf">NoSingleSectionException</a></pre>
-<div class="block"><p>Convenience method returning the value of a boolean property
- with the specified ID. If the property is not available,
- <code>false</code> is returned. A subsequent call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a> will return <code>true</code> to let the caller
- distinguish that case from a real property value of
- <code>false</code>.</p></div>
+<div class="block">Convenience method returning the value of a boolean property with the
+ specified ID. If the property is not available, <code>false</code> is returned.
+ A subsequent call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a> will return <code>true</code> to let the
+ caller distinguish that case from a real property value of <code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property value</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -812,11 +955,11 @@ extends java.lang.Object</pre>
<h4>getPropertyIntValue</h4>
<pre>protected int getPropertyIntValue(int id)
throws <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf">NoSingleSectionException</a></pre>
-<div class="block"><p>Convenience method returning the value of the numeric
+<div class="block">Convenience method returning the value of the numeric
property with the specified ID. If the property is not
available, 0 is returned. A subsequent call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a>
will return <code>true</code> to let the caller distinguish
- that case from a real property value of 0.</p></div>
+ that case from a real property value of 0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The propertyIntValue value</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -832,11 +975,11 @@ extends java.lang.Object</pre>
<h4>wasNull</h4>
<pre>public boolean wasNull()
throws <a href="../../../../org/apache/poi/hpsf/NoSingleSectionException.html" title="class in org.apache.poi.hpsf">NoSingleSectionException</a></pre>
-<div class="block"><p>Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)"><code>getPropertyIntValue(int)</code></a> or <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)"><code>getProperty(int)</code></a> tried to access
+<div class="block">Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)"><code>getPropertyIntValue(int)</code></a> or <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)"><code>getProperty(int)</code></a> tried to access
was available or not. This information might be important for
callers of <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)"><code>getPropertyIntValue(int)</code></a> since the latter
returns 0 if the property does not exist. Using <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()"><code>wasNull()</code></a>, the caller can distiguish this case from a
- property's real value of 0.</p></div>
+ property's real value of 0.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the last call to <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)"><code>getPropertyIntValue(int)</code></a> or <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)"><code>getProperty(int)</code></a> tried to access a
property that was not available, else <code>false</code>.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -851,7 +994,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getFirstSection</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> getFirstSection()</pre>
-<div class="block"><p>Gets the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s first section.</p></div>
+<div class="block">Gets the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s first section.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>'s first section.</dd></dl>
</li>
</ul>
@@ -862,8 +1005,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getSingleSection</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> getSingleSection()</pre>
-<div class="block"><p>If the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has only a single section this
- method returns it.</p></div>
+<div class="block">If the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> has only a single section this method returns it.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The singleSection value</dd></dl>
</li>
</ul>
@@ -874,8 +1016,8 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
-<div class="block"><p>Returns <code>true</code> if the <code>PropertySet</code> is equal
- to the specified parameter, else <code>false</code>.</p></div>
+<div class="block">Returns <code>true</code> if the <code>PropertySet</code> is equal
+ to the specified parameter, else <code>false</code>.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
@@ -900,7 +1042,7 @@ extends java.lang.Object</pre>
<a name="toString()">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
@@ -910,6 +1052,55 @@ extends java.lang.Object</pre>
<dt><span class="strong">See Also:</span></dt><dd><code>Object.toString()</code></dd></dl>
</li>
</ul>
+<a name="remove1stProperty(long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>remove1stProperty</h4>
+<pre>protected void remove1stProperty(long id)</pre>
+</li>
+</ul>
+<a name="set1stProperty(long, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>set1stProperty</h4>
+<pre>protected void set1stProperty(long id,
+ java.lang.String value)</pre>
+</li>
+</ul>
+<a name="set1stProperty(long, int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>set1stProperty</h4>
+<pre>protected void set1stProperty(long id,
+ int value)</pre>
+</li>
+</ul>
+<a name="set1stProperty(long, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>set1stProperty</h4>
+<pre>protected void set1stProperty(long id,
+ boolean value)</pre>
+</li>
+</ul>
+<a name="set1stProperty(long, byte[])">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>set1stProperty</h4>
+<pre>protected void set1stProperty(long id,
+ byte[] value)</pre>
+</li>
+</ul>
</li>
</ul>
</li>
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySetFactory.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySetFactory.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySetFactory.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/PropertySetFactory.html Mon Nov 28 15:43:45 2016
@@ -100,8 +100,8 @@
<br>
<pre>public class <span class="strong">PropertySetFactory</span>
extends java.lang.Object</pre>
-<div class="block"><p>Factory class to create instances of <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a>,
- <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> and <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p></div>
+<div class="block">Factory class to create instances of <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a>,
+ <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> and <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
</li>
</ul>
</div>
@@ -214,11 +214,11 @@ extends java.lang.Object</pre>
<a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a>,
java.io.IOException,
java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates the most specific <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> from an entry
+<div class="block">Creates the most specific <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> from an entry
in the specified POIFS Directory. This is preferrably a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> or a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a>. If
the specified entry does not contain a property set stream, an
exception is thrown. If no entry is found with the given name,
- an exception is thrown.</p></div>
+ an exception is thrown.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - The directory to find the PropertySet in</dd><dd><code>name</code> - The name of the entry containing the PropertySet</dd>
<dt><span class="strong">Returns:</span></dt><dd>The created <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -241,10 +241,10 @@ extends java.lang.Object</pre>
<a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a>,
java.io.UnsupportedEncodingException,
java.io.IOException</pre>
-<div class="block"><p>Creates the most specific <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> from an <code>InputStream</code>. This is preferrably a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> or a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a>. If
+<div class="block">Creates the most specific <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> from an <code>InputStream</code>. This is preferrably a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> or a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a>. If
the specified <code>InputStream</code> does not contain a property
set stream, an exception is thrown and the <code>InputStream</code>
- is repositioned at its beginning.</p></div>
+ is repositioned at its beginning.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - Contains the property set stream's data.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The created <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -264,7 +264,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>newSummaryInformation</h4>
<pre>public static <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf">SummaryInformation</a> newSummaryInformation()</pre>
-<div class="block"><p>Creates a new summary information.</p></div>
+<div class="block">Creates a new summary information.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new summary information.</dd></dl>
</li>
</ul>
@@ -275,7 +275,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>newDocumentSummaryInformation</h4>
<pre>public static <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf">DocumentSummaryInformation</a> newDocumentSummaryInformation()</pre>
-<div class="block"><p>Creates a new document summary information.</p></div>
+<div class="block">Creates a new document summary information.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the new document summary information.</dd></dl>
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org