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 [6/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/DocumentSummaryInformation.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/DocumentSummaryInformation.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/DocumentSummaryInformation.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/DocumentSummaryInformation.html Mon Nov 28 15:43:45 2016
@@ -115,8 +115,8 @@
<br>
<pre>public class <span class="strong">DocumentSummaryInformation</span>
extends <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html" title="class in org.apache.poi.hpsf">SpecialPropertySet</a></pre>
-<div class="block"><p>Convenience class representing a DocumentSummary Information stream in a
- Microsoft Office document.</p></div>
+<div class="block">Convenience class representing a DocumentSummary Information stream in a
+ Microsoft Office document.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a></dd></dl>
</li>
</ul>
@@ -149,7 +149,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Fields inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#byteOrder">byteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#classID">classID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#format">format</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_MACINTOSH">OS_MACINTOSH</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN16">OS_WIN16</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN32">OS_WIN32</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#osVersion">osVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#sections">sections</a></code></li>
+<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_MACINTOSH">OS_MACINTOSH</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN16">OS_WIN16</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN32">OS_WIN32</a></code></li>
</ul>
</li>
</ul>
@@ -165,6 +165,11 @@ extends <a href="../../../../org/apache/
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html#DocumentSummaryInformation()">DocumentSummaryInformation</a></strong>()</code>
+<div class="block">Creates an empty <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html#DocumentSummaryInformation(org.apache.poi.hpsf.PropertySet)">DocumentSummaryInformation</a></strong>(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)</code>
<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> from a given
<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
@@ -642,18 +647,11 @@ extends <a href="../../../../org/apache/
</tr>
</table>
<ul class="blockList">
-<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hpsf.SpecialPropertySet">
-<!-- -->
-</a>
-<h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html" title="class in org.apache.poi.hpsf">SpecialPropertySet</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#addSection(org.apache.poi.hpsf.Section)">addSection</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#clearSections()">clearSections</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getByteOrder()">getByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getClassID()">getClassID</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getFirstSection()">getFirstSection</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getFormat()">getFormat</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getOSVersion()">getOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPrope
rty(int)">getProperty</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertyIntValue(int)">getPropertyIntValue</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertyStringValue(int)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertyStringValue(java.lang.Object)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getSectionCount()">getSectionCount</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getSections()">getSections</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#isDocumentSummaryInformation()">isDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/SpecialP
ropertySet.html#isSummaryInformation()">isSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#setByteOrder(int)">setByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#setClassID(org.apache.poi.hpsf.ClassID)">setClassID</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#setFormat(int)">setFormat</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#setOSVersion(int)">setOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#toInputStream()">toInputStream</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#wasNull()">wasNull</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#write(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)">write</a>, <a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#write(java.i
o.OutputStream)">write</a></code></li>
-</ul>
-<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hpsf.PropertySet">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSingleSection()">getSingleSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(byte[],%20int,%20int)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(java.io.InputStream)">isPropertySetStream</a></code></li>
+<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#addSection(org.apache.poi.hpsf.Section)">addSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#clearSections()">clearSections</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getByteOrder()">getByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()">getClassID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFirstSection()">getFirstSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFormat()">getFormat</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getOSVersion()">getOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)">getProperty</a>, <a href="../../../../org/apache/poi/hpsf/Pr
opertySet.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)">getPropertyIntValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(int)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(java.lang.Object)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSectionCount()">getSectionCount</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()">getSections</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSingleSection()">getSingleSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isDocumentSummaryInformation()">isDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStre
am(byte[],%20int,%20int)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(java.io.InputStream)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isSummaryInformation()">isSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#remove1stProperty(long)">remove1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20boolean)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20byte[])">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20int)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20java.lang.String)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setByteOrder(int)">setByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setCla
ssID(org.apache.poi.hpsf.ClassID)">setClassID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setFormat(int)">setFormat</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setOSVersion(int)">setOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#toInputStream()">toInputStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()">wasNull</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)">write</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(java.io.OutputStream)">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -683,8 +681,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>DEFAULT_STREAM_NAME</h4>
<pre>public static final java.lang.String DEFAULT_STREAM_NAME</pre>
-<div class="block"><p>The document name a document summary information stream
- usually has in a POIFS filesystem.</p></div>
+<div class="block">The document name a document summary information stream
+ usually has in a POIFS filesystem.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.DocumentSummaryInformation.DEFAULT_STREAM_NAME">Constant Field Values</a></dd></dl>
</li>
</ul>
@@ -696,6 +694,16 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="DocumentSummaryInformation()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>DocumentSummaryInformation</h4>
+<pre>public DocumentSummaryInformation()</pre>
+<div class="block">Creates an empty <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a>.</div>
+</li>
+</ul>
<a name="DocumentSummaryInformation(org.apache.poi.hpsf.PropertySet)">
<!-- -->
</a>
@@ -704,12 +712,12 @@ extends <a href="../../../../org/apache/
<h4>DocumentSummaryInformation</h4>
<pre>public DocumentSummaryInformation(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)
throws <a href="../../../../org/apache/poi/hpsf/UnexpectedPropertySetTypeException.html" title="class in org.apache.poi.hpsf">UnexpectedPropertySetTypeException</a></pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> from a given
- <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p></div>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> from a given
+ <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ps</code> - A property set which should be created from a
document summary information stream.</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/UnexpectedPropertySetTypeException.html" title="class in org.apache.poi.hpsf">UnexpectedPropertySetTypeException</a></code> - if <var>ps</var>
+<dd><code><a href="../../../../org/apache/poi/hpsf/UnexpectedPropertySetTypeException.html" title="class in org.apache.poi.hpsf">UnexpectedPropertySetTypeException</a></code> - if <code>ps</code>
does not contain a document summary information stream.</dd></dl>
</li>
</ul>
@@ -728,12 +736,12 @@ extends <a href="../../../../org/apache/
<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"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertySetIDMap()">SpecialPropertySet</a></code></strong></div>
+<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertySetIDMap()">PropertySet</a></code></strong></div>
<div class="block">The id to name mapping of the properties in this set.</div>
<dl>
-<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html#getPropertySetIDMap()">getPropertySetIDMap</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html" title="class in org.apache.poi.hpsf">SpecialPropertySet</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>the id to name mapping of the properties in this set</dd></dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertySetIDMap()">getPropertySetIDMap</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></code></dd>
+<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="getCategory()">
@@ -743,7 +751,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getCategory</h4>
<pre>public java.lang.String getCategory()</pre>
-<div class="block"><p>Returns the category (or <code>null</code>).</p></div>
+<div class="block">Returns the category (or <code>null</code>).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The category value</dd></dl>
</li>
</ul>
@@ -754,7 +762,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setCategory</h4>
<pre>public void setCategory(java.lang.String category)</pre>
-<div class="block"><p>Sets the category.</p></div>
+<div class="block">Sets the category.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - The category to set.</dd></dl>
</li>
</ul>
@@ -765,7 +773,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeCategory</h4>
<pre>public void removeCategory()</pre>
-<div class="block"><p>Removes the category.</p></div>
+<div class="block">Removes the category.</div>
</li>
</ul>
<a name="getPresentationFormat()">
@@ -775,8 +783,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getPresentationFormat</h4>
<pre>public java.lang.String getPresentationFormat()</pre>
-<div class="block"><p>Returns the presentation format (or
- <code>null</code>).</p></div>
+<div class="block">Returns the presentation format (or
+ <code>null</code>).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The presentation format value</dd></dl>
</li>
</ul>
@@ -787,7 +795,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setPresentationFormat</h4>
<pre>public void setPresentationFormat(java.lang.String presentationFormat)</pre>
-<div class="block"><p>Sets the presentation format.</p></div>
+<div class="block">Sets the presentation format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>presentationFormat</code> - The presentation format to set.</dd></dl>
</li>
</ul>
@@ -798,7 +806,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removePresentationFormat</h4>
<pre>public void removePresentationFormat()</pre>
-<div class="block"><p>Removes the presentation format.</p></div>
+<div class="block">Removes the presentation format.</div>
</li>
</ul>
<a name="getByteCount()">
@@ -808,7 +816,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getByteCount</h4>
<pre>public int getByteCount()</pre>
-<div class="block"><p>Returns the byte count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a byte count.</p></div>
+<div class="block">Returns the byte count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a byte count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The byteCount value</dd></dl>
</li>
</ul>
@@ -819,7 +827,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setByteCount</h4>
<pre>public void setByteCount(int byteCount)</pre>
-<div class="block"><p>Sets the byte count.</p></div>
+<div class="block">Sets the byte count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>byteCount</code> - The byte count to set.</dd></dl>
</li>
</ul>
@@ -830,7 +838,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeByteCount</h4>
<pre>public void removeByteCount()</pre>
-<div class="block"><p>Removes the byte count.</p></div>
+<div class="block">Removes the byte count.</div>
</li>
</ul>
<a name="getLineCount()">
@@ -840,7 +848,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getLineCount</h4>
<pre>public int getLineCount()</pre>
-<div class="block"><p>Returns the line count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a line count.</p></div>
+<div class="block">Returns the line count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a line count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The line count value</dd></dl>
</li>
</ul>
@@ -851,7 +859,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setLineCount</h4>
<pre>public void setLineCount(int lineCount)</pre>
-<div class="block"><p>Sets the line count.</p></div>
+<div class="block">Sets the line count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lineCount</code> - The line count to set.</dd></dl>
</li>
</ul>
@@ -862,7 +870,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeLineCount</h4>
<pre>public void removeLineCount()</pre>
-<div class="block"><p>Removes the line count.</p></div>
+<div class="block">Removes the line count.</div>
</li>
</ul>
<a name="getParCount()">
@@ -872,7 +880,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getParCount</h4>
<pre>public int getParCount()</pre>
-<div class="block"><p>Returns the par count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a par count.</p></div>
+<div class="block">Returns the par count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a par count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The par count value</dd></dl>
</li>
</ul>
@@ -883,7 +891,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setParCount</h4>
<pre>public void setParCount(int parCount)</pre>
-<div class="block"><p>Sets the par count.</p></div>
+<div class="block">Sets the par count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parCount</code> - The par count to set.</dd></dl>
</li>
</ul>
@@ -894,7 +902,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeParCount</h4>
<pre>public void removeParCount()</pre>
-<div class="block"><p>Removes the par count.</p></div>
+<div class="block">Removes the par count.</div>
</li>
</ul>
<a name="getSlideCount()">
@@ -904,7 +912,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getSlideCount</h4>
<pre>public int getSlideCount()</pre>
-<div class="block"><p>Returns the slide count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a slide count.</p></div>
+<div class="block">Returns the slide count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a slide count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The slide count value</dd></dl>
</li>
</ul>
@@ -915,7 +923,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setSlideCount</h4>
<pre>public void setSlideCount(int slideCount)</pre>
-<div class="block"><p>Sets the slideCount.</p></div>
+<div class="block">Sets the slideCount.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>slideCount</code> - The slide count to set.</dd></dl>
</li>
</ul>
@@ -926,7 +934,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeSlideCount</h4>
<pre>public void removeSlideCount()</pre>
-<div class="block"><p>Removes the slide count.</p></div>
+<div class="block">Removes the slide count.</div>
</li>
</ul>
<a name="getNoteCount()">
@@ -936,7 +944,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getNoteCount</h4>
<pre>public int getNoteCount()</pre>
-<div class="block"><p>Returns the note count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a note count.</p></div>
+<div class="block">Returns the note count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a note count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The note count value</dd></dl>
</li>
</ul>
@@ -947,7 +955,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setNoteCount</h4>
<pre>public void setNoteCount(int noteCount)</pre>
-<div class="block"><p>Sets the note count.</p></div>
+<div class="block">Sets the note count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>noteCount</code> - The note count to set.</dd></dl>
</li>
</ul>
@@ -958,7 +966,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeNoteCount</h4>
<pre>public void removeNoteCount()</pre>
-<div class="block"><p>Removes the noteCount.</p></div>
+<div class="block">Removes the noteCount.</div>
</li>
</ul>
<a name="getHiddenCount()">
@@ -968,8 +976,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getHiddenCount</h4>
<pre>public int getHiddenCount()</pre>
-<div class="block"><p>Returns the hidden count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a hidden
- count.</p></div>
+<div class="block">Returns the hidden count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a hidden
+ count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The hidden count value</dd></dl>
</li>
</ul>
@@ -980,7 +988,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setHiddenCount</h4>
<pre>public void setHiddenCount(int hiddenCount)</pre>
-<div class="block"><p>Sets the hidden count.</p></div>
+<div class="block">Sets the hidden count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hiddenCount</code> - The hidden count to set.</dd></dl>
</li>
</ul>
@@ -991,7 +999,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeHiddenCount</h4>
<pre>public void removeHiddenCount()</pre>
-<div class="block"><p>Removes the hidden count.</p></div>
+<div class="block">Removes the hidden count.</div>
</li>
</ul>
<a name="getMMClipCount()">
@@ -1001,8 +1009,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getMMClipCount</h4>
<pre>public int getMMClipCount()</pre>
-<div class="block"><p>Returns the mmclip count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a mmclip
- count.</p></div>
+<div class="block">Returns the mmclip count or 0 if the <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain a mmclip
+ count.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The mmclip count value</dd></dl>
</li>
</ul>
@@ -1013,7 +1021,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setMMClipCount</h4>
<pre>public void setMMClipCount(int mmClipCount)</pre>
-<div class="block"><p>Sets the mmclip count.</p></div>
+<div class="block">Sets the mmclip count.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mmClipCount</code> - The mmclip count to set.</dd></dl>
</li>
</ul>
@@ -1024,7 +1032,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeMMClipCount</h4>
<pre>public void removeMMClipCount()</pre>
-<div class="block"><p>Removes the mmclip count.</p></div>
+<div class="block">Removes the mmclip count.</div>
</li>
</ul>
<a name="getScale()">
@@ -1034,8 +1042,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getScale</h4>
<pre>public boolean getScale()</pre>
-<div class="block"><p>Returns <code>true</code> when scaling of the thumbnail is
- desired, <code>false</code> if cropping is desired.</p></div>
+<div class="block">Returns <code>true</code> when scaling of the thumbnail is
+ desired, <code>false</code> if cropping is desired.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The scale value</dd></dl>
</li>
</ul>
@@ -1046,7 +1054,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setScale</h4>
<pre>public void setScale(boolean scale)</pre>
-<div class="block"><p>Sets the scale.</p></div>
+<div class="block">Sets the scale.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scale</code> - The scale to set.</dd></dl>
</li>
</ul>
@@ -1057,7 +1065,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeScale</h4>
<pre>public void removeScale()</pre>
-<div class="block"><p>Removes the scale.</p></div>
+<div class="block">Removes the scale.</div>
</li>
</ul>
<a name="getHeadingPair()">
@@ -1080,7 +1088,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setHeadingPair</h4>
<pre>public void setHeadingPair(byte[] headingPair)</pre>
-<div class="block"><p>Sets the heading pair.</p></div>
+<div class="block">Sets the heading pair.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>headingPair</code> - The heading pair to set.</dd></dl>
</li>
</ul>
@@ -1091,7 +1099,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeHeadingPair</h4>
<pre>public void removeHeadingPair()</pre>
-<div class="block"><p>Removes the heading pair.</p></div>
+<div class="block">Removes the heading pair.</div>
</li>
</ul>
<a name="getDocparts()">
@@ -1114,7 +1122,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setDocparts</h4>
<pre>public void setDocparts(byte[] docparts)</pre>
-<div class="block"><p>Sets the doc parts.</p></div>
+<div class="block">Sets the doc parts.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>docparts</code> - The doc parts to set.</dd></dl>
</li>
</ul>
@@ -1125,7 +1133,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeDocparts</h4>
<pre>public void removeDocparts()</pre>
-<div class="block"><p>Removes the doc parts.</p></div>
+<div class="block">Removes the doc parts.</div>
</li>
</ul>
<a name="getManager()">
@@ -1135,7 +1143,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getManager</h4>
<pre>public java.lang.String getManager()</pre>
-<div class="block"><p>Returns the manager (or <code>null</code>).</p></div>
+<div class="block">Returns the manager (or <code>null</code>).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The manager value</dd></dl>
</li>
</ul>
@@ -1146,7 +1154,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setManager</h4>
<pre>public void setManager(java.lang.String manager)</pre>
-<div class="block"><p>Sets the manager.</p></div>
+<div class="block">Sets the manager.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>manager</code> - The manager to set.</dd></dl>
</li>
</ul>
@@ -1157,7 +1165,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeManager</h4>
<pre>public void removeManager()</pre>
-<div class="block"><p>Removes the manager.</p></div>
+<div class="block">Removes the manager.</div>
</li>
</ul>
<a name="getCompany()">
@@ -1167,7 +1175,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getCompany</h4>
<pre>public java.lang.String getCompany()</pre>
-<div class="block"><p>Returns the company (or <code>null</code>).</p></div>
+<div class="block">Returns the company (or <code>null</code>).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The company value</dd></dl>
</li>
</ul>
@@ -1178,7 +1186,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setCompany</h4>
<pre>public void setCompany(java.lang.String company)</pre>
-<div class="block"><p>Sets the company.</p></div>
+<div class="block">Sets the company.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>company</code> - The company to set.</dd></dl>
</li>
</ul>
@@ -1189,7 +1197,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeCompany</h4>
<pre>public void removeCompany()</pre>
-<div class="block"><p>Removes the company.</p></div>
+<div class="block">Removes the company.</div>
</li>
</ul>
<a name="getLinksDirty()">
@@ -1199,7 +1207,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getLinksDirty</h4>
<pre>public boolean getLinksDirty()</pre>
-<div class="block"><p>Returns <code>true</code> if the custom links are dirty.</p> <p></div>
+<div class="block">Returns <code>true</code> if the custom links are dirty. <p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The links dirty value</dd></dl>
</li>
</ul>
@@ -1210,7 +1218,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setLinksDirty</h4>
<pre>public void setLinksDirty(boolean linksDirty)</pre>
-<div class="block"><p>Sets the linksDirty.</p></div>
+<div class="block">Sets the linksDirty.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>linksDirty</code> - The links dirty value to set.</dd></dl>
</li>
</ul>
@@ -1221,7 +1229,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeLinksDirty</h4>
<pre>public void removeLinksDirty()</pre>
-<div class="block"><p>Removes the links dirty.</p></div>
+<div class="block">Removes the links dirty.</div>
</li>
</ul>
<a name="getCharCountWithSpaces()">
@@ -1231,8 +1239,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getCharCountWithSpaces</h4>
<pre>public int getCharCountWithSpaces()</pre>
-<div class="block"><p>Returns the character count including whitespace, or 0 if the
- <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain this char count.</p>
+<div class="block">Returns the character count including whitespace, or 0 if the
+ <a href="../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> does not contain this char count.
<p>This is the whitespace-including version of <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html#getCharCount()"><code>SummaryInformation.getCharCount()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The character count or <code>null</code></dd></dl>
</li>
@@ -1350,8 +1358,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setVBADigitalSignature</h4>
<pre>public void setVBADigitalSignature(byte[] signature)</pre>
-<div class="block"><p>Sets the VBA digital signature for the VBA project
- embedded in the document.</p></div>
+<div class="block">Sets the VBA digital signature for the VBA project
+ embedded in the document.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>signature</code> - VBA Digital Signature for the project</dd></dl>
</li>
</ul>
@@ -1468,8 +1476,8 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getDocumentVersion</h4>
<pre>public java.lang.String getDocumentVersion()</pre>
-<div class="block"><p>Gets the document version as a string, which is normally unset and empty
- (or <code>null</code>).</p></div>
+<div class="block">Gets the document version as a string, which is normally unset and empty
+ (or <code>null</code>).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the document verion</dd></dl>
</li>
</ul>
@@ -1501,7 +1509,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>getCustomProperties</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/CustomProperties.html" title="class in org.apache.poi.hpsf">CustomProperties</a> getCustomProperties()</pre>
-<div class="block"><p>Gets the custom properties.</p></div>
+<div class="block">Gets the custom properties.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The custom properties.</dd></dl>
</li>
</ul>
@@ -1512,7 +1520,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>setCustomProperties</h4>
<pre>public void setCustomProperties(<a href="../../../../org/apache/poi/hpsf/CustomProperties.html" title="class in org.apache.poi.hpsf">CustomProperties</a> customProperties)</pre>
-<div class="block"><p>Sets the custom properties.</p></div>
+<div class="block">Sets the custom properties.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>customProperties</code> - The custom properties</dd></dl>
</li>
</ul>
@@ -1523,7 +1531,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>removeCustomProperties</h4>
<pre>public void removeCustomProperties()</pre>
-<div class="block"><p>Removes the custom properties.</p></div>
+<div class="block">Removes the custom properties.</div>
</li>
</ul>
</li>
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html Mon Nov 28 15:43:45 2016
@@ -66,13 +66,13 @@
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Property">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.Property">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li>Method</li>
</ul>
</div>
<a name="skip-navbar_top">
@@ -106,8 +106,12 @@
<dd><a href="../../../../org/apache/poi/hpsf/CustomProperty.html" title="class in org.apache.poi.hpsf">CustomProperty</a></dd>
</dl>
<hr>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>POI 3.16 - use Property as base class instead</i></div>
+</div>
<br>
-<pre>public class <span class="strong">MutableProperty</span>
+<pre><a href="../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../org/apache/poi/util/Removal.html#version()">version</a>="3.18")
+public class <span class="strong">MutableProperty</span>
extends <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></pre>
<div class="block"><p>Adds writing capability to the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> class.</p>
@@ -130,7 +134,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Fields inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/Property.html#id">id</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#type">type</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#value">value</a></code></li>
+<code><a href="../../../../org/apache/poi/hpsf/Property.html#value">value</a></code></li>
</ul>
</li>
</ul>
@@ -147,14 +151,13 @@ extends <a href="../../../../org/apache/
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty()">MutableProperty</a></strong>()</code>
-<div class="block">Creates an empty property.</div>
-</td>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty(org.apache.poi.hpsf.Property)">MutableProperty</a></strong>(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</code>
-<div class="block">Creates a <code>MutableProperty</code> as a copy of an existing
- <code>Property</code>.</div>
-</td>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
</tr>
</table>
</li>
@@ -165,44 +168,12 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Method Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span>Methods</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<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/MutableProperty.html#setID(long)">setID</a></strong>(long id)</code>
-<div class="block">Sets the property's ID.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#setType(long)">setType</a></strong>(long type)</code>
-<div class="block">Sets the property's type.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#setValue(java.lang.Object)">setValue</a></strong>(java.lang.Object value)</code>
-<div class="block">Sets the property's 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/MutableProperty.html#write(java.io.OutputStream,%20int)">write</a></strong>(java.io.OutputStream out,
- int codepage)</code>
-<div class="block">Writes the property to an output stream.</div>
-</td>
-</tr>
-</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hpsf.Property">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/Property.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getID()">getID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getSize()">getSize</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getType()">getType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getValue()">getValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#readDictionary(byte[],%20long,%20int,%20int)">readDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#toString()">toString</a></code></li>
+<code><a href="../../../../org/apache/poi/hpsf/Property.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getID()">getID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getSize()">getSize</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getType()">getType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getValue()">getValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#readDictionary(byte[],%20long,%20int,%20int)">readDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setID(long)">setID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setType(long)">setType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setValue(java.lang.Object)">setValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/P
roperty.html#write(java.io.OutputStream,%20int)">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -232,8 +203,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>MutableProperty</h4>
<pre>public MutableProperty()</pre>
-<div class="block"><p>Creates an empty property. It must be filled using the set method to
- be usable.</p></div>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
<a name="MutableProperty(org.apache.poi.hpsf.Property)">
@@ -243,69 +213,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>MutableProperty</h4>
<pre>public MutableProperty(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</pre>
-<div class="block"><p>Creates a <code>MutableProperty</code> as a copy of an existing
- <code>Property</code>.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - The property to copy.</dd></dl>
-</li>
-</ul>
-</li>
-</ul>
-<!-- ============ METHOD DETAIL ========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method_detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a name="setID(long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setID</h4>
-<pre>public void setID(long id)</pre>
-<div class="block"><p>Sets the property's ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the ID</dd></dl>
-</li>
-</ul>
-<a name="setType(long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setType</h4>
-<pre>public void setType(long type)</pre>
-<div class="block"><p>Sets the property's type.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the property's type</dd></dl>
-</li>
-</ul>
-<a name="setValue(java.lang.Object)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setValue</h4>
-<pre>public void setValue(java.lang.Object value)</pre>
-<div class="block"><p>Sets the property's value.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the property's value</dd></dl>
-</li>
-</ul>
-<a name="write(java.io.OutputStream, int)">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>write</h4>
-<pre>public int write(java.io.OutputStream out,
- int codepage)
- 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"><p>Writes the property to an output stream.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The output stream to write to.</dd><dd><code>codepage</code> - The codepage to use for writing non-wide strings</dd>
-<dt><span class="strong">Returns:</span></dt><dd>the number of bytes written to the stream</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - if an I/O error occurs</dd>
-<dd><code><a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></code> - if a variant type is to be
- written that is not yet supported</dd></dl>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
</li>
@@ -362,13 +270,13 @@ extends <a href="../../../../org/apache/
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Property">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.Property">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li>Method</li>
</ul>
</div>
<a name="skip-navbar_bottom">
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/MutablePropertySet.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/MutablePropertySet.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/MutablePropertySet.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/MutablePropertySet.html Mon Nov 28 15:43:45 2016
@@ -66,13 +66,13 @@
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.PropertySet">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.PropertySet">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li>Method</li>
</ul>
</div>
<a name="skip-navbar_top">
@@ -106,13 +106,17 @@
<dd><a href="../../../../org/apache/poi/hpsf/SpecialPropertySet.html" title="class in org.apache.poi.hpsf">SpecialPropertySet</a></dd>
</dl>
<hr>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>POI 3.16 - use PropertySet as base class instead</i></div>
+</div>
<br>
-<pre>public class <span class="strong">MutablePropertySet</span>
+<pre><a href="../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../org/apache/poi/util/Removal.html#version()">version</a>="3.18")
+public class <span class="strong">MutablePropertySet</span>
extends <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></pre>
-<div class="block"><p>Adds writing support to the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> class.</p>
+<div class="block">dds writing support to the <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> class.<p>
- <p>Please be aware that this class' functionality will be merged into the
- <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> class at a later time, so the API will change.</p></div>
+ Please be aware that this class' functionality will be merged into the
+ <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> class at a later time, so the API will change.</div>
</li>
</ul>
</div>
@@ -130,7 +134,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Fields inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#byteOrder">byteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#classID">classID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#format">format</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_MACINTOSH">OS_MACINTOSH</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN16">OS_WIN16</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN32">OS_WIN32</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#osVersion">osVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#sections">sections</a></code></li>
+<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_MACINTOSH">OS_MACINTOSH</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN16">OS_WIN16</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#OS_WIN32">OS_WIN32</a></code></li>
</ul>
</li>
</ul>
@@ -147,14 +151,13 @@ extends <a href="../../../../org/apache/
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html#MutablePropertySet()">MutablePropertySet</a></strong>()</code>
-<div class="block">Constructs a <code>MutablePropertySet</code> instance.</div>
-</td>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html#MutablePropertySet(org.apache.poi.hpsf.PropertySet)">MutablePropertySet</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>MutablePropertySet</code> by doing a deep copy of
- an existing <code>PropertySet</code>.</div>
-</td>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
</tr>
</table>
</li>
@@ -165,75 +168,12 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Method Summary</h3>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span>Methods</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<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/MutablePropertySet.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/MutablePropertySet.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>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html#setByteOrder(int)">setByteOrder</a></strong>(int byteOrder)</code>
-<div class="block">Sets the "byteOrder" property.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.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/MutablePropertySet.html#setFormat(int)">setFormat</a></strong>(int format)</code>
-<div class="block">Sets the "format" property.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html#setOSVersion(int)">setOSVersion</a></strong>(int osVersion)</code>
-<div class="block">Sets the "osVersion" property.</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/MutablePropertySet.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>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutablePropertySet.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/MutablePropertySet.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_org.apache.poi.hpsf.PropertySet">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getByteOrder()">getByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()">getClassID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFirstSection()">getFirstSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFormat()">getFormat</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getOSVersion()">getOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)">getProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)">getPropertyIntValue</a>, <a href="../../../../org/a
pache/poi/hpsf/PropertySet.html#getSectionCount()">getSectionCount</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()">getSections</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSingleSection()">getSingleSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isDocumentSummaryInformation()">isDocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(byte[],%20int,%20int)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(java.io.InputStream)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isSummaryInformation()">isSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()">wasNull</a></co
de></li>
+<code><a href="../../../../org/apache/poi/hpsf/PropertySet.html#addSection(org.apache.poi.hpsf.Section)">addSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#clearSections()">clearSections</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getByteOrder()">getByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()">getClassID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFirstSection()">getFirstSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getFormat()">getFormat</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getOSVersion()">getOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getProperty(int)">getProperty</a>, <a href="../../../../org/apache/poi/hpsf/Pr
opertySet.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyIntValue(int)">getPropertyIntValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertySetIDMap()">getPropertySetIDMap</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(int)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getPropertyStringValue(java.lang.Object)">getPropertyStringValue</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSectionCount()">getSectionCount</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSections()">getSections</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#getSingleSection()">getSingleSection</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isDocumentSummaryInformation()">isD
ocumentSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(byte[],%20int,%20int)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isPropertySetStream(java.io.InputStream)">isPropertySetStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#isSummaryInformation()">isSummaryInformation</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#remove1stProperty(long)">remove1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20boolean)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20byte[])">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20int)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#set1stProperty(long,%20java.lang.String)">set1stProperty</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.
html#setByteOrder(int)">setByteOrder</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setClassID(org.apache.poi.hpsf.ClassID)">setClassID</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setFormat(int)">setFormat</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#setOSVersion(int)">setOSVersion</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#toInputStream()">toInputStream</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#wasNull()">wasNull</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(org.apache.poi.poifs.filesystem.DirectoryEntry,%20java.lang.String)">write</a>, <a href="../../../../org/apache/poi/hpsf/PropertySet.html#write(java.io.OutputStream)">write</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@@ -263,9 +203,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>MutablePropertySet</h4>
<pre>public MutablePropertySet()</pre>
-<div class="block"><p>Constructs a <code>MutablePropertySet</code> instance. Its
- primary task is to initialize the immutable field with their proper
- values. It also sets fields that might change to reasonable defaults.</p></div>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
<a name="MutablePropertySet(org.apache.poi.hpsf.PropertySet)">
@@ -275,145 +213,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>MutablePropertySet</h4>
<pre>public MutablePropertySet(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)</pre>
-<div class="block"><p>Constructs a <code>MutablePropertySet</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
- mutable counterparts in the new <code>MutablePropertySet</code>.</p></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 ========== -->
-<ul class="blockList">
-<li class="blockList"><a name="method_detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a name="setByteOrder(int)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setByteOrder</h4>
-<pre>public void setByteOrder(int byteOrder)</pre>
-<div class="block"><p>Sets the "byteOrder" property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>byteOrder</code> - the byteOrder value to set</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"><p>Sets the "format" property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>format</code> - the format value to set</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"><p>Sets the "osVersion" property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>osVersion</code> - the osVersion value to set</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"><p>Sets the property set stream's low-level "class ID"
- field.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classID</code> - The property set stream's low-level "class ID" field.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/PropertySet.html#getClassID()"><code>PropertySet.getClassID()</code></a></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"><p>Removes all sections from this property set.</p></div>
-</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"><p>Adds a section to this property set.</p></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="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"><p>Writes the property set to an output stream.</p></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="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"><p>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.</p></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="write(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String)">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<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"><p>Writes a property set to a document in a POI filesystem directory.</p></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>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
</li>
@@ -470,13 +270,13 @@ extends <a href="../../../../org/apache/
<li>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.PropertySet">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
-<li><a href="#method_summary">Method</a></li>
+<li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.PropertySet">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
-<li><a href="#method_detail">Method</a></li>
+<li>Method</li>
</ul>
</div>
<a name="skip-navbar_bottom">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org