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 [7/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/MutableSection.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/MutableSection.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/MutableSection.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/MutableSection.html Mon Nov 28 15:43:45 2016
@@ -64,15 +64,15 @@
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Section">Field</a> | </li>
+<li>Field | </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.Section">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">
@@ -102,8 +102,12 @@
<ul class="blockList">
<li class="blockList">
<hr>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>POI 3.16 - use Section as base class instead</i></div>
+</div>
<br>
-<pre>public class <span class="strong">MutableSection</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">MutableSection</span>
extends <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></pre>
<div class="block"><p>Adds writing capability to the <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> class.</p>
@@ -115,21 +119,6 @@ extends <a href="../../../../org/apache/
<div class="summary">
<ul class="blockList">
<li class="blockList">
-<!-- =========== FIELD SUMMARY =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="field_summary">
-<!-- -->
-</a>
-<h3>Field Summary</h3>
-<ul class="blockList">
-<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.hpsf.Section">
-<!-- -->
-</a>
-<h3>Fields inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/Section.html#dictionary">dictionary</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#formatID">formatID</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#offset">offset</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#properties">properties</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#size">size</a></code></li>
-</ul>
-</li>
-</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
@@ -143,14 +132,19 @@ extends <a href="../../../../org/apache/
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#MutableSection()">MutableSection</a></strong>()</code>
-<div class="block">Creates an empty mutable section.</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/MutableSection.html#MutableSection(byte[],%20int)">MutableSection</a></strong>(byte[] src,
+ int offset)</code>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
+</tr>
+<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#MutableSection(org.apache.poi.hpsf.Section)">MutableSection</a></strong>(<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> s)</code>
-<div class="block">Constructs a <code>MutableSection</code> by doing a deep copy of an
- existing <code>Section</code>.</div>
-</td>
+<div class="block"><strong>Deprecated.</strong> </div>
+ </td>
</tr>
</table>
</li>
@@ -161,152 +155,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/MutableSection.html#clear()">clear</a></strong>()</code>
-<div class="block">Removes all properties from the section including 0 (dictionary) and
- 1 (codepage).</div>
-</td>
-</tr>
-<tr class="rowColor">
-<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/MutableSection.html#getProperties()">getProperties</a></strong>()</code>
-<div class="block">Gets this section's properties.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>java.lang.Object</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)">getProperty</a></strong>(long id)</code>
-<div class="block">Gets a property.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#getPropertyCount()">getPropertyCount</a></strong>()</code>
-<div class="block">Overwrites the super class' method to cope with a redundancy:
- the property count is maintained in a separate member variable, but
- shouldn't.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#getSize()">getSize</a></strong>()</code>
-<div class="block">Returns the section's size.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#removeProperty(long)">removeProperty</a></strong>(long id)</code>
-<div class="block">Removes a property.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setCodepage(int)">setCodepage</a></strong>(int codepage)</code>
-<div class="block">Sets the codepage.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setDictionary(java.util.Map)">setDictionary</a></strong>(java.util.Map<java.lang.Long,java.lang.String> dictionary)</code>
-<div class="block">Sets the section's dictionary.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setFormatID(byte[])">setFormatID</a></strong>(byte[] formatID)</code>
-<div class="block">Sets the section's format 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/MutableSection.html#setFormatID(org.apache.poi.hpsf.ClassID)">setFormatID</a></strong>(<a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> formatID)</code>
-<div class="block">Sets the section's format ID.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperties(org.apache.poi.hpsf.Property[])">setProperties</a></strong>(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties)</code>
-<div class="block">Sets this section's properties.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20boolean)">setProperty</a></strong>(int id,
- boolean value)</code>
-<div class="block">Sets the boolean value of the property with the specified ID.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20int)">setProperty</a></strong>(int id,
- int value)</code>
-<div class="block">Sets the int value of the property with the specified 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/MutableSection.html#setProperty(int,%20long)">setProperty</a></strong>(int id,
- long value)</code>
-<div class="block">Sets the long value of the property with the specified ID.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)">setProperty</a></strong>(int id,
- long variantType,
- java.lang.Object value)</code>
-<div class="block">Sets the value and the variant type of the property with the
- specified 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/MutableSection.html#setProperty(int,%20java.lang.Object)">setProperty</a></strong>(int id,
- java.lang.Object value)</code>
-<div class="block">Sets a property.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20java.lang.String)">setProperty</a></strong>(int id,
- java.lang.String value)</code>
-<div class="block">Sets the string value of the property with the specified 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/MutableSection.html#setProperty(org.apache.poi.hpsf.Property)">setProperty</a></strong>(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</code>
-<div class="block">Sets a property.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setPropertyBooleanValue(int,%20boolean)">setPropertyBooleanValue</a></strong>(int id,
- boolean value)</code>
-<div class="block">Sets the value of the boolean property with the specified
- ID.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableSection.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream out)</code>
-<div class="block">Writes this section into an output stream.</div>
-</td>
-</tr>
-</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hpsf.Section">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></h3>
-<code><a href="../../../../org/apache/poi/hpsf/Section.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getCodepage()">getCodepage</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getDictionary()">getDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()">getFormatID</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getOffset()">getOffset</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPIDString(long)">getPIDString</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)">getPropertyIntValue</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull()">wasNull</a></code><
/li>
+<code><a href="../../../../org/apache/poi/hpsf/Section.html#clear()">clear</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getCodepage()">getCodepage</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getDictionary()">getDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()">getFormatID</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getOffset()">getOffset</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPIDString(long)">getPIDString</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getProperties()">getProperties</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)">getProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyCount()">getPropertyCount</a>,
<a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)">getPropertyIntValue</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#getSize()">getSize</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#removeProperty(long)">removeProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setCodepage(int)">setCodepage</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setDictionary(java.util.Map)">setDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setFormatID(byte[])">setFormatID</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setFormatID(org.apache.poi.hpsf.ClassID)">setFormatID</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperties(org.apache.poi.hpsf.Property[])">setProperties</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(int,%20boolean)">setProperty</a>, <a href="../../../..
/org/apache/poi/hpsf/Section.html#setProperty(int,%20int)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(int,%20long)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(int,%20long,%20java.lang.Object)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(int,%20java.lang.Object)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(int,%20java.lang.String)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setProperty(org.apache.poi.hpsf.Property)">setProperty</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#setPropertyBooleanValue(int,%20boolean)">setPropertyBooleanValue</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull()">wasNull</a>, <a href="../../../../org/apache/poi/hpsf/Section.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">
@@ -336,314 +190,31 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>MutableSection</h4>
<pre>public MutableSection()</pre>
-<div class="block"><p>Creates an empty mutable section.</p></div>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
<a name="MutableSection(org.apache.poi.hpsf.Section)">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>MutableSection</h4>
<pre>public MutableSection(<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> s)</pre>
-<div class="block"><p>Constructs a <code>MutableSection</code> by doing a deep copy of an
- existing <code>Section</code>. All nested <code>Property</code>
- instances, will be their mutable counterparts in the new
- <code>MutableSection</code>.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The section 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="setFormatID(org.apache.poi.hpsf.ClassID)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setFormatID</h4>
-<pre>public void setFormatID(<a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> formatID)</pre>
-<div class="block"><p>Sets the section's format ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatID</code> - The section's format ID</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setFormatID(byte[])"><code>setFormatID(byte[])</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()"><code>Section.getFormatID()</code></a></dd></dl>
-</li>
-</ul>
-<a name="setFormatID(byte[])">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setFormatID</h4>
-<pre>public void setFormatID(byte[] formatID)</pre>
-<div class="block"><p>Sets the section's format ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatID</code> - The section's format ID as a byte array. It components
- are in big-endian format.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setFormatID(org.apache.poi.hpsf.ClassID)"><code>setFormatID(ClassID)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()"><code>Section.getFormatID()</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperties(org.apache.poi.hpsf.Property[])">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperties</h4>
-<pre>public void setProperties(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties)</pre>
-<div class="block"><p>Sets this section's properties. Any former values are overwritten.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - This section's new properties.</dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, java.lang.String)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- java.lang.String value)</pre>
-<div class="block"><p>Sets the string value of the property with the specified ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd><dd><code>value</code> - The property's value. It will be written as a Unicode
- string.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, int)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- int value)</pre>
-<div class="block"><p>Sets the int value of the property with the specified ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd><dd><code>value</code> - The property's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- long value)</pre>
-<div class="block"><p>Sets the long value of the property with the specified ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd><dd><code>value</code> - The property's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, boolean)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- boolean value)</pre>
-<div class="block"><p>Sets the boolean value of the property with the specified ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd><dd><code>value</code> - The property's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, long, java.lang.Object)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- long variantType,
- java.lang.Object value)</pre>
-<div class="block"><p>Sets the value and the variant type of the property with the
- specified ID. If a property with this ID is not yet present in
- the section, it will be added. An already present property with
- the specified ID will be overwritten. A default mapping will be
- used to choose the property's type.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID.</dd><dd><code>variantType</code> - The property's variant type.</dd><dd><code>value</code> - The property's value.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20java.lang.String)"><code>setProperty(int, String)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(org.apache.poi.hpsf.Property)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</pre>
-<div class="block"><p>Sets a property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - The property to be set.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a></dd></dl>
-</li>
-</ul>
-<a name="removeProperty(long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>removeProperty</h4>
-<pre>public void removeProperty(long id)</pre>
-<div class="block"><p>Removes a property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The ID of the property to be removed</dd></dl>
-</li>
-</ul>
-<a name="setPropertyBooleanValue(int, boolean)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setPropertyBooleanValue</h4>
-<pre>protected void setPropertyBooleanValue(int id,
- boolean value)</pre>
-<div class="block"><p>Sets the value of the boolean property with the specified
- ID.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd><dd><code>value</code> - The property's value</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/MutableSection.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/MutableSection.html#getProperty(long)"><code>getProperty(long)</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a></dd></dl>
-</li>
-</ul>
-<a name="getSize()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getSize</h4>
-<pre>public int getSize()</pre>
-<div class="block"><p>Returns the section's size.</p></div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/Section.html#getSize()">getSize</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>the section's size.</dd></dl>
+<div class="block"><span class="strong">Deprecated.</span> </div>
</li>
</ul>
-<a name="write(java.io.OutputStream)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>write</h4>
-<pre>public int 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 this section into an output stream.</p>
-
- <p>Internally this is done by writing into three byte array output
- streams: one for the properties, one for the property list and one for
- the section as such. The two former are appended to the latter when they
- have received all their data.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write into.</dd>
-<dt><span class="strong">Returns:</span></dt><dd>The number of bytes written, i.e. the section's size.</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 HPSF does not yet support
- writing a property's variant type.</dd></dl>
-</li>
-</ul>
-<a name="getPropertyCount()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getPropertyCount</h4>
-<pre>public int getPropertyCount()</pre>
-<div class="block"><p>Overwrites the super class' method to cope with a redundancy:
- the property count is maintained in a separate member variable, but
- shouldn't.</p></div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyCount()">getPropertyCount</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>The number of properties in this section</dd></dl>
-</li>
-</ul>
-<a name="getProperties()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getProperties</h4>
-<pre>public <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] getProperties()</pre>
-<div class="block"><p>Gets this section's properties.</p></div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/Section.html#getProperties()">getProperties</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>this section's properties.</dd></dl>
-</li>
-</ul>
-<a name="getProperty(long)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>getProperty</h4>
-<pre>public java.lang.Object getProperty(long id)</pre>
-<div class="block"><p>Gets a property.</p></div>
-<dl>
-<dt><strong>Overrides:</strong></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)">getProperty</a></code> in class <code><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The ID of the property to get</dd>
-<dt><span class="strong">Returns:</span></dt><dd>The property or <code>null</code> if there is no such property</dd></dl>
-</li>
-</ul>
-<a name="setDictionary(java.util.Map)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setDictionary</h4>
-<pre>public void setDictionary(java.util.Map<java.lang.Long,java.lang.String> dictionary)
- throws <a href="../../../../org/apache/poi/hpsf/IllegalPropertySetDataException.html" title="class in org.apache.poi.hpsf">IllegalPropertySetDataException</a></pre>
-<div class="block"><p>Sets the section's dictionary. All keys in the dictionary must be
- <code>Long</code> instances, all values must be
- <code>String</code>s. This method overwrites the properties with IDs
- 0 and 1 since they are reserved for the dictionary and the dictionary's
- codepage. Setting these properties explicitly might have surprising
- effects. An application should never do this but always use this
- method.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dictionary</code> - The dictionary</dd>
-<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="../../../../org/apache/poi/hpsf/IllegalPropertySetDataException.html" title="class in org.apache.poi.hpsf">IllegalPropertySetDataException</a></code> - if the dictionary's key and
- value types are not correct.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/Section.html#getDictionary()"><code>Section.getDictionary()</code></a></dd></dl>
-</li>
-</ul>
-<a name="setProperty(int, java.lang.Object)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>setProperty</h4>
-<pre>public void setProperty(int id,
- java.lang.Object value)</pre>
-<div class="block"><p>Sets a property.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property ID.</dd><dd><code>value</code> - The property's value. The value's class must be one of those
- supported by HPSF.</dd></dl>
-</li>
-</ul>
-<a name="clear()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>clear</h4>
-<pre>public void clear()</pre>
-<div class="block"><p>Removes all properties from the section including 0 (dictionary) and
- 1 (codepage).</p></div>
-</li>
-</ul>
-<a name="setCodepage(int)">
+<a name="MutableSection(byte[], int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
-<h4>setCodepage</h4>
-<pre>public void setCodepage(int codepage)</pre>
-<div class="block"><p>Sets the codepage.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>codepage</code> - the codepage</dd></dl>
+<h4>MutableSection</h4>
+<pre>public MutableSection(byte[] src,
+ int offset)
+ throws java.io.UnsupportedEncodingException</pre>
+<div class="block"><span class="strong">Deprecated.</span> </div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.UnsupportedEncodingException</code></dd></dl>
</li>
</ul>
</li>
@@ -698,15 +269,15 @@ extends <a href="../../../../org/apache/
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Section">Field</a> | </li>
+<li>Field | </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.Section">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/NoFormatIDException.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/NoFormatIDException.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/NoFormatIDException.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/NoFormatIDException.html Mon Nov 28 15:43:45 2016
@@ -124,9 +124,9 @@
<br>
<pre>public class <span class="strong">NoFormatIDException</span>
extends <a href="../../../../org/apache/poi/hpsf/HPSFRuntimeException.html" title="class in org.apache.poi.hpsf">HPSFRuntimeException</a></pre>
-<div class="block"><p>This exception is thrown if a <a href="../../../../org/apache/poi/hpsf/MutablePropertySet.html" title="class in org.apache.poi.hpsf"><code>MutablePropertySet</code></a> is to be written
- but does not have a formatID set (see <a href="../../../../org/apache/poi/hpsf/MutableSection.html#setFormatID(org.apache.poi.hpsf.ClassID)"><code>MutableSection.setFormatID(ClassID)</code></a> or
- <a href="../../../../org/apache/poi/hpsf/MutableSection.html#setFormatID(byte[])"><code>MutableSection.setFormatID(byte[])</code></a>.</div>
+<div class="block">This exception is thrown if a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> is to be written
+ but does not have a formatID set (see <a href="../../../../org/apache/poi/hpsf/Section.html#setFormatID(org.apache.poi.hpsf.ClassID)"><code>Section.setFormatID(ClassID)</code></a> or
+ <a href="../../../../org/apache/poi/hpsf/Section.html#setFormatID(byte[])"><code>Section.setFormatID(byte[])</code></a>.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.poi.hpsf.NoFormatIDException">Serialized Form</a></dd></dl>
</li>
</ul>
@@ -217,7 +217,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>NoFormatIDException</h4>
<pre>public NoFormatIDException()</pre>
-<div class="block"><p>Constructor</p></div>
+<div class="block">Constructor</div>
</li>
</ul>
<a name="NoFormatIDException(java.lang.String)">
@@ -227,7 +227,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>NoFormatIDException</h4>
<pre>public NoFormatIDException(java.lang.String msg)</pre>
-<div class="block"><p>Constructor</p></div>
+<div class="block">Constructor</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - The exception's message string</dd></dl>
</li>
</ul>
@@ -238,7 +238,7 @@ extends <a href="../../../../org/apache/
<li class="blockList">
<h4>NoFormatIDException</h4>
<pre>public NoFormatIDException(java.lang.Throwable reason)</pre>
-<div class="block"><p>Constructor</p></div>
+<div class="block">Constructor</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reason</code> - This exception's underlying reason</dd></dl>
</li>
</ul>
@@ -250,7 +250,7 @@ extends <a href="../../../../org/apache/
<h4>NoFormatIDException</h4>
<pre>public NoFormatIDException(java.lang.String msg,
java.lang.Throwable reason)</pre>
-<div class="block"><p>Constructor</p></div>
+<div class="block">Constructor</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msg</code> - The exception's message string</dd><dd><code>reason</code> - This exception's underlying reason</dd></dl>
</li>
</ul>
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html Mon Nov 28 15:43:45 2016
@@ -104,31 +104,28 @@
<br>
<pre>public class <span class="strong">Property</span>
extends java.lang.Object</pre>
-<div class="block"><p>A property in a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> of a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p>
+<div class="block">A property in a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> of a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.<p>
- <p>The property's <strong>ID</strong> gives the property a meaning
+ The property's <code>ID</code> gives the property a meaning
in the context of its <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>. Each <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> spans
- its own name space of property IDs.</p>
+ its own name space of property IDs.<p>
- <p>The property's <strong>type</strong> determines how its
- <strong>value </strong> is interpreted. For example, if the type is
+ The property's <code>type</code> determines how its
+ <code>value</code> is interpreted. For example, if the type is
<a href="../../../../org/apache/poi/hpsf/Variant.html#VT_LPSTR"><code>Variant.VT_LPSTR</code></a> (byte string), the value consists of a
DWord telling how many bytes the string contains. The bytes follow
immediately, including any null bytes that terminate the
string. The type <a href="../../../../org/apache/poi/hpsf/Variant.html#VT_I4"><code>Variant.VT_I4</code></a> denotes a four-byte integer
- value, <a href="../../../../org/apache/poi/hpsf/Variant.html#VT_FILETIME"><code>Variant.VT_FILETIME</code></a> some date and time (of a
- file).</p>
+ value, <a href="../../../../org/apache/poi/hpsf/Variant.html#VT_FILETIME"><code>Variant.VT_FILETIME</code></a> some date and time (of a file).<p>
- <p>Please note that not all <a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a> types yet. This might change
+ Please note that not all <a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a> types yet. This might change
over time but largely depends on your feedback so that the POI team knows
which variant types are really needed. So please feel free to submit error
- reports or patches for the types you need.</p>
-
- <p>Microsoft documentation: <a
- href="http://msdn.microsoft.com/library/en-us/stg/stg/property_set_display_name_dictionary.asp?frame=true">
- Property Set Display Name Dictionary</a>.</div>
+ reports or patches for the types you need.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>,
-<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a></dd></dl>
+<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a>,
+<a href="https://msdn.microsoft.com/en-us/library/dd942421.aspx">
+ [MS-OLEPS]: Object Linking and Embedding (OLE) Property Set Data Structures</a></dd></dl>
</li>
</ul>
</div>
@@ -148,18 +145,6 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>protected long</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#id">id</a></strong></code>
-<div class="block">The property's ID.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected long</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#type">type</a></strong></code>
-<div class="block">The property's type.</div>
-</td>
-</tr>
-<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#value">value</a></strong></code>
<div class="block">The property's value.</div>
@@ -177,18 +162,15 @@ 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/Property.html#Property()">Property</a></strong>()</code>
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property()">Property</a></strong>()</code>
<div class="block">Creates an empty property.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(long,%20byte[],%20long,%20int,%20int)">Property</a></strong>(long id,
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(long,%20byte[],%20long,%20int,%20int)">Property</a></strong>(long id,
byte[] src,
long offset,
int length,
@@ -198,13 +180,17 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(long,%20long,%20java.lang.Object)">Property</a></strong>(long id,
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(long,%20long,%20java.lang.Object)">Property</a></strong>(long id,
long type,
java.lang.Object value)</code>
<div class="block">Creates a property.</div>
</td>
</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(org.apache.poi.hpsf.Property)">Property</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>Property</code> as a copy of an existing <code>Property</code>.</div>
+</td>
+</tr>
</table>
</li>
</ul>
@@ -264,9 +250,34 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#setID(long)">setID</a></strong>(long id)</code>
+<div class="block">Sets the property's ID.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#setType(long)">setType</a></strong>(long type)</code>
+<div class="block">Sets the property's type.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.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="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#toString()">toString</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/Property.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_java.lang.Object">
@@ -289,26 +300,6 @@ extends java.lang.Object</pre>
<!-- -->
</a>
<h3>Field Detail</h3>
-<a name="id">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>id</h4>
-<pre>protected long id</pre>
-<div class="block"><p>The property's ID.</p></div>
-</li>
-</ul>
-<a name="type">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>type</h4>
-<pre>protected long type</pre>
-<div class="block"><p>The property's type.</p></div>
-</li>
-</ul>
<a name="value">
<!-- -->
</a>
@@ -316,7 +307,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>value</h4>
<pre>protected java.lang.Object value</pre>
-<div class="block"><p>The property's value.</p></div>
+<div class="block">The property's value.</div>
</li>
</ul>
</li>
@@ -327,6 +318,27 @@ extends java.lang.Object</pre>
<!-- -->
</a>
<h3>Constructor Detail</h3>
+<a name="Property()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Property</h4>
+<pre>public Property()</pre>
+<div class="block">Creates an empty property. It must be filled using the set method to be usable.</div>
+</li>
+</ul>
+<a name="Property(org.apache.poi.hpsf.Property)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Property</h4>
+<pre>public Property(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</pre>
+<div class="block">Creates a <code>Property</code> as a copy of an existing <code>Property</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - The property to copy.</dd></dl>
+</li>
+</ul>
<a name="Property(long, long, java.lang.Object)">
<!-- -->
</a>
@@ -336,7 +348,7 @@ extends java.lang.Object</pre>
<pre>public Property(long id,
long type,
java.lang.Object value)</pre>
-<div class="block"><p>Creates a property.</p></div>
+<div class="block">Creates a property.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the property's ID.</dd><dd><code>type</code> - the property's type, see <a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a>.</dd><dd><code>value</code> - the property's value. Only certain types are allowed, see
<a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf"><code>Variant</code></a>.</dd></dl>
</li>
@@ -344,7 +356,7 @@ extends java.lang.Object</pre>
<a name="Property(long, byte[], long, int, int)">
<!-- -->
</a>
-<ul class="blockList">
+<ul class="blockListLast">
<li class="blockList">
<h4>Property</h4>
<pre>public Property(long id,
@@ -353,8 +365,8 @@ extends java.lang.Object</pre>
int length,
int codepage)
throws java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instance by reading its bytes
- from the property set stream.</p></div>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instance by reading its bytes
+ from the property set stream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID.</dd><dd><code>src</code> - The bytes the property set stream consists of.</dd><dd><code>offset</code> - The property's type/value pair's offset in the
section.</dd><dd><code>length</code> - The property's type/value pair's length in bytes.</dd><dd><code>codepage</code> - The section's and thus the property's
codepage. It is needed only when reading string values.</dd>
@@ -363,17 +375,6 @@ extends java.lang.Object</pre>
supported.</dd></dl>
</li>
</ul>
-<a name="Property()">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>Property</h4>
-<pre>protected Property()</pre>
-<div class="block"><p>Creates an empty property. It must be filled using the set method to
- be usable.</p></div>
-</li>
-</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
@@ -389,10 +390,21 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getID</h4>
<pre>public long getID()</pre>
-<div class="block"><p>Returns the property's ID.</p></div>
+<div class="block">Returns the property's ID.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ID value</dd></dl>
</li>
</ul>
+<a name="setID(long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setID</h4>
+<pre>public void setID(long id)</pre>
+<div class="block">Sets the property's ID.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the ID</dd></dl>
+</li>
+</ul>
<a name="getType()">
<!-- -->
</a>
@@ -400,10 +412,21 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getType</h4>
<pre>public long getType()</pre>
-<div class="block"><p>Returns the property's type.</p></div>
+<div class="block">Returns the property's type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The type value</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">Sets the property's type.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the property's type</dd></dl>
+</li>
+</ul>
<a name="getValue()">
<!-- -->
</a>
@@ -411,10 +434,21 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Object getValue()</pre>
-<div class="block"><p>Returns the property's value.</p></div>
+<div class="block">Returns the property's value.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The property's value</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">Sets the property's value.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the property's value</dd></dl>
+</li>
+</ul>
<a name="readDictionary(byte[], long, int, int)">
<!-- -->
</a>
@@ -426,8 +460,8 @@ extends java.lang.Object</pre>
int length,
int codepage)
throws java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Reads a dictionary.</p></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - The byte array containing the bytes making out the dictionary.</dd><dd><code>offset</code> - At this offset within <var>src </var> the dictionary
+<div class="block">Reads a dictionary.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - The byte array containing the bytes making out the dictionary.</dd><dd><code>offset</code> - At this offset within <code>src</code> the dictionary
starts.</dd><dd><code>length</code> - The dictionary contains at most this many bytes.</dd><dd><code>codepage</code> - The codepage of the string values.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The dictonary</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -443,8 +477,7 @@ extends java.lang.Object</pre>
<h4>getSize</h4>
<pre>protected int getSize()
throws <a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></pre>
-<div class="block"><p>Returns the property's size in bytes. This is always a multiple of
- 4.</p></div>
+<div class="block">Returns the property's size in bytes. This is always a multiple of 4.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the property's size in bytes</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 the
@@ -458,10 +491,12 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
-<div class="block"><p>Compares two properties.</p> <p>Please beware that a property with
+<div class="block">Compares two properties.<p>
+
+ Please beware that a property with
ID == 0 is a special case: It does not have a type, and its value is the
section's dictionary. Another special case are strings: Two properties
- may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;</p></div>
+ may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
@@ -484,7 +519,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>
@@ -494,6 +529,25 @@ extends java.lang.Object</pre>
<dt><span class="strong">See Also:</span></dt><dd><code>Object.toString()</code></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">Writes the property to an output stream.</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>
+</li>
+</ul>
</li>
</ul>
</li>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org