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 [9/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/Section.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/Section.html?rev=1771763&r1=1771762&r2=1771763&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/hpsf/Section.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/hpsf/Section.html Mon Nov 28 15:43:45 2016
@@ -64,13 +64,13 @@
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
@@ -104,52 +104,13 @@
<br>
<pre>public class <span class="strong">Section</span>
extends java.lang.Object</pre>
-<div class="block"><p>Represents a section in a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</p></div>
+<div class="block">Represents a section in a <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div>
</li>
</ul>
</div>
<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>
-<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
-<caption><span>Fields</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Field and Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected java.util.Map<java.lang.Long,java.lang.String></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#dictionary">dictionary</a></strong></code>
-<div class="block">Maps property IDs to section-private PID strings.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#formatID">formatID</a></strong></code>
-<div class="block">The section's format ID, <a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()"><code>getFormatID()</code></a>.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected long</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#offset">offset</a></strong></code> </td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>protected <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/Section.html#properties">properties</a></strong></code> </td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>protected int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#size">size</a></strong></code> </td>
-</tr>
-</table>
-</li>
-</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
@@ -159,22 +120,25 @@ 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/Section.html#Section()">Section</a></strong>()</code>
-<div class="block">Creates an empty and uninitialized <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</div>
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#Section()">Section</a></strong>()</code>
+<div class="block">Creates an empty <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colFirst"><code> </code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#Section(byte[],%20int)">Section</a></strong>(byte[] src,
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#Section(byte[],%20int)">Section</a></strong>(byte[] src,
int offset)</code>
<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> instance from a byte array.</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#Section(org.apache.poi.hpsf.Section)">Section</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>Section</code> by doing a deep copy of an
+ existing <code>Section</code>.</div>
+</td>
+</tr>
</table>
</li>
</ul>
@@ -191,94 +155,199 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code>
<div class="block">Checks whether this section is equal to another object.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getCodepage()">getCodepage</a></strong>()</code>
<div class="block">Gets the section's codepage, if any.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>java.util.Map<java.lang.Long,java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getDictionary()">getDictionary</a></strong>()</code>
<div class="block">Gets the section's dictionary.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()">getFormatID</a></strong>()</code>
<div class="block">Returns the format ID.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getOffset()">getOffset</a></strong>()</code>
<div class="block">Returns the offset of the section in the stream.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getPIDString(long)">getPIDString</a></strong>(long pid)</code>
<div class="block">Returns the PID string associated with a property ID.</div>
</td>
</tr>
-<tr class="altColor">
+<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/Section.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">Returns this section's properties.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)">getProperty</a></strong>(long id)</code>
<div class="block">Returns the value of the property with the specified ID.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyBooleanValue(int)">getPropertyBooleanValue</a></strong>(int id)</code>
<div class="block">Returns the value of the boolean property with the specified
ID.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyCount()">getPropertyCount</a></strong>()</code>
<div class="block">Returns the number of properties in this section.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)">getPropertyIntValue</a></strong>(long id)</code>
<div class="block">Returns the value of the numeric property with the specified
ID.</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#getSize()">getSize</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/Section.html#getSize()">getSize</a></strong>()</code>
-<div class="block">Returns the section's size in bytes.</div>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#hashCode()">hashCode</a></strong>()</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#removeProperty(long)">removeProperty</a></strong>(long id)</code>
+<div class="block">Removes a 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/Section.html#setCodepage(int)">setCodepage</a></strong>(int codepage)</code>
+<div class="block">Sets the codepage.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#hashCode()">hashCode</a></strong>()</code> </td>
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#setFormatID(byte[])">setFormatID</a></strong>(byte[] 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/Section.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="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#toString()">toString</a></strong>()</code> </td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.html#wasNull()">wasNull</a></strong>()</code>
<div class="block">Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)"><code>getPropertyIntValue(long)</code></a> or <a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)"><code>getProperty(long)</code></a> tried to access
was available or not.</div>
</td>
</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Section.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_java.lang.Object">
@@ -295,79 +364,34 @@ extends java.lang.Object</pre>
<div class="details">
<ul class="blockList">
<li class="blockList">
-<!-- ============ FIELD DETAIL =========== -->
-<ul class="blockList">
-<li class="blockList"><a name="field_detail">
-<!-- -->
-</a>
-<h3>Field Detail</h3>
-<a name="dictionary">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>dictionary</h4>
-<pre>protected java.util.Map<java.lang.Long,java.lang.String> dictionary</pre>
-<div class="block"><p>Maps property IDs to section-private PID strings. These
- strings can be found in the property with ID 0.</p></div>
-</li>
-</ul>
-<a name="formatID">
-<!-- -->
-</a>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList">
-<h4>formatID</h4>
-<pre>protected <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> formatID</pre>
-<div class="block"><p>The section's format ID, <a href="../../../../org/apache/poi/hpsf/Section.html#getFormatID()"><code>getFormatID()</code></a>.</p></div>
-</li>
-</ul>
-<a name="offset">
+<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>offset</h4>
-<pre>protected long offset</pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/Section.html#getOffset()"><code>getOffset()</code></a></dd></dl>
-</li>
-</ul>
-<a name="size">
+<h3>Constructor Detail</h3>
+<a name="Section()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>size</h4>
-<pre>protected int size</pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/Section.html#getSize()"><code>getSize()</code></a></dd></dl>
-</li>
-</ul>
-<a name="properties">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>properties</h4>
-<pre>protected <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties</pre>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/hpsf/Section.html#getProperties()"><code>getProperties()</code></a></dd></dl>
-</li>
-</ul>
+<h4>Section</h4>
+<pre>public Section()</pre>
+<div class="block">Creates an empty <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</div>
</li>
</ul>
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-<ul class="blockList">
-<li class="blockList"><a name="constructor_detail">
-<!-- -->
-</a>
-<h3>Constructor Detail</h3>
-<a name="Section()">
+<a name="Section(org.apache.poi.hpsf.Section)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Section</h4>
-<pre>protected Section()</pre>
-<div class="block"><p>Creates an empty and uninitialized <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</div>
+<pre>public Section(<a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf">Section</a> s)</pre>
+<div class="block">Constructs a <code>Section</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>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - The section set to copy</dd></dl>
</li>
</ul>
<a name="Section(byte[], int)">
@@ -379,7 +403,7 @@ extends java.lang.Object</pre>
<pre>public Section(byte[] src,
int offset)
throws java.io.UnsupportedEncodingException</pre>
-<div class="block"><p>Creates a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> instance from a byte array.</p></div>
+<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> instance from a byte array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - Contains the complete property set stream.</dd><dd><code>offset</code> - The position in the stream that points to the
section's format ID.</dd>
<dt><span class="strong">Throws:</span></dt>
@@ -402,33 +426,45 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getFormatID</h4>
<pre>public <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> getFormatID()</pre>
-<div class="block"><p>Returns the format ID. The format ID is the "type" of the
+<div class="block">Returns the format ID. The format ID is the "type" of the
section. For example, if the format ID of the first <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a> contains the bytes specified by
<code>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</code>
- the section (and thus the property set) is a SummaryInformation.</p></div>
+ the section (and thus the property set) is a SummaryInformation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The format ID</dd></dl>
</li>
</ul>
-<a name="getOffset()">
+<a name="setFormatID(org.apache.poi.hpsf.ClassID)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getOffset</h4>
-<pre>public long getOffset()</pre>
-<div class="block"><p>Returns the offset of the section in the stream.</p></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The offset of the section in the stream.</dd></dl>
+<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">Sets the section's format ID.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatID</code> - The section's format ID</dd></dl>
</li>
</ul>
-<a name="getSize()">
+<a name="setFormatID(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
-<h4>getSize</h4>
-<pre>public int getSize()</pre>
-<div class="block"><p>Returns the section's size in bytes.</p></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>The section's size in bytes.</dd></dl>
+<h4>setFormatID</h4>
+<pre>public void setFormatID(byte[] formatID)</pre>
+<div class="block">Sets the section's format ID.</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></dl>
+</li>
+</ul>
+<a name="getOffset()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getOffset</h4>
+<pre>public long getOffset()</pre>
+<div class="block">Returns the offset of the section in the stream.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The offset of the section in the stream.</dd></dl>
</li>
</ul>
<a name="getPropertyCount()">
@@ -438,7 +474,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getPropertyCount</h4>
<pre>public int getPropertyCount()</pre>
-<div class="block"><p>Returns the number of properties in this section.</p></div>
+<div class="block">Returns the number of properties in this section.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of properties in this section.</dd></dl>
</li>
</ul>
@@ -449,10 +485,21 @@ extends java.lang.Object</pre>
<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>Returns this section's properties.</p></div>
+<div class="block">Returns this section's properties.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This section's properties.</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">Sets this section's properties. Any former values are overwritten.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - This section's new properties.</dd></dl>
+</li>
+</ul>
<a name="getProperty(long)">
<!-- -->
</a>
@@ -460,14 +507,111 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getProperty</h4>
<pre>public java.lang.Object getProperty(long id)</pre>
-<div class="block"><p>Returns the value of the property with the specified ID. If
+<div class="block">Returns the value of the property with the specified ID. If
the property is not available, <code>null</code> is returned
and a subsequent call to <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull"><code>wasNull</code></a> will return
- <code>true</code>.</p></div>
+ <code>true</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property's value</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">Sets the string value of the property with the specified ID.</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></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">Sets the int value of the property with the specified ID.</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/Section.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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">Sets the long value of the property with the specified ID.</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/Section.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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">Sets the boolean value of the property with the specified ID.</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/Section.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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">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.</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/Section.html#setProperty(int,%20java.lang.String)"><code>setProperty(int, String)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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">Sets a property.</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/Section.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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(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">Sets a property.</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="getPropertyIntValue(long)">
<!-- -->
</a>
@@ -475,11 +619,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getPropertyIntValue</h4>
<pre>protected int getPropertyIntValue(long id)</pre>
-<div class="block"><p>Returns the value of the numeric property with the specified
+<div class="block">Returns the value of the numeric property with the specified
ID. If the property is not available, 0 is returned. A
subsequent call to <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull"><code>wasNull</code></a> will return
<code>true</code> to let the caller distinguish that case from
- a real property value of 0.</p></div>
+ a real property value of 0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property's value</dd></dl>
</li>
@@ -491,15 +635,40 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getPropertyBooleanValue</h4>
<pre>protected boolean getPropertyBooleanValue(int id)</pre>
-<div class="block"><p>Returns the value of the boolean property with the specified
+<div class="block">Returns the value of the boolean property with the specified
ID. If the property is not available, <code>false</code> is
returned. A subsequent call to <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull"><code>wasNull</code></a> will return
<code>true</code> to let the caller distinguish that case from
- a real property value of <code>false</code>.</p></div>
+ a real property value of <code>false</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The property's ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property's value</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">Sets the value of the boolean property with the specified
+ ID.</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/Section.html#setProperty(int,%20long,%20java.lang.Object)"><code>setProperty(int, long, Object)</code></a>,
+<a href="../../../../org/apache/poi/hpsf/Section.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>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the section's size in bytes.</dd></dl>
+</li>
+</ul>
<a name="wasNull()">
<!-- -->
</a>
@@ -507,11 +676,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>wasNull</h4>
<pre>public boolean wasNull()</pre>
-<div class="block"><p>Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)"><code>getPropertyIntValue(long)</code></a> or <a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)"><code>getProperty(long)</code></a> tried to access
+<div class="block">Checks whether the property which the last call to <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)"><code>getPropertyIntValue(long)</code></a> or <a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)"><code>getProperty(long)</code></a> tried to access
was available or not. This information might be important for
callers of <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)"><code>getPropertyIntValue(long)</code></a> since the latter
returns 0 if the property does not exist. Using <a href="../../../../org/apache/poi/hpsf/Section.html#wasNull"><code>wasNull</code></a> the caller can distiguish this case from a property's
- real value of 0.</p></div>
+ real value of 0.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the last call to <a href="../../../../org/apache/poi/hpsf/Section.html#getPropertyIntValue(long)"><code>getPropertyIntValue(long)</code></a> or <a href="../../../../org/apache/poi/hpsf/Section.html#getProperty(long)"><code>getProperty(long)</code></a> tried to access a
property that was not available, else <code>false</code>.</dd></dl>
</li>
@@ -523,13 +692,35 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getPIDString</h4>
<pre>public java.lang.String getPIDString(long pid)</pre>
-<div class="block"><p>Returns the PID string associated with a property ID. The ID
+<div class="block">Returns the PID string associated with a property ID. The ID
is first looked up in the <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>'s private
- dictionary. If it is not found there, the method calls <a href="../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(byte[],%20long)"><code>SectionIDMap.getPIDString(byte[], long)</code></a>.</p></div>
+ dictionary. If it is not found there, the method calls <a href="../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(byte[],%20long)"><code>SectionIDMap.getPIDString(byte[], long)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pid</code> - The property ID</dd>
<dt><span class="strong">Returns:</span></dt><dd>The property ID's string value</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">Removes all properties from the section including 0 (dictionary) and
+ 1 (codepage).</div>
+</li>
+</ul>
+<a name="setCodepage(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setCodepage</h4>
+<pre>public void setCodepage(int codepage)</pre>
+<div class="block">Sets the codepage.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>codepage</code> - the codepage</dd></dl>
+</li>
+</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
@@ -537,22 +728,22 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
-<div class="block"><p>Checks whether this section is equal to another object. The result is
- <code>false</code> if one of the the following conditions holds:</p>
+<div class="block">Checks whether this section is equal to another object. The result is
+ <code>false</code> if one of the the following conditions holds:
<ul>
- <li><p>The other object is not a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</p></li>
+ <li>The other object is not a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</li>
- <li><p>The format IDs of the two sections are not equal.</p></li>
+ <li>The format IDs of the two sections are not equal.</li>
- <li><p>The sections have a different number of properties. However,
- properties with ID 1 (codepage) are not counted.</p></li>
+ <li>The sections have a different number of properties. However,
+ properties with ID 1 (codepage) are not counted.</li>
- <li><p>The other object is not a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</p></li>
+ <li>The other object is not a <a href="../../../../org/apache/poi/hpsf/Section.html" title="class in org.apache.poi.hpsf"><code>Section</code></a>.</li>
- <li><p>The properties have different values. The order of the properties
- is irrelevant.</p></li>
+ <li>The properties have different values. The order of the properties
+ is irrelevant.</li>
</ul></div>
<dl>
@@ -563,6 +754,61 @@ extends java.lang.Object</pre>
not</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">Removes a property.</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="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">Writes this section into an output stream.<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.</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="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">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.</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>getDictionary()</code></a></dd></dl>
+</li>
+</ul>
<a name="hashCode()">
<!-- -->
</a>
@@ -596,11 +842,11 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getDictionary</h4>
<pre>public java.util.Map<java.lang.Long,java.lang.String> getDictionary()</pre>
-<div class="block"><p>Gets the section's dictionary. A dictionary allows an application to
+<div class="block">Gets the section's dictionary. A dictionary allows an application to
use human-readable property names instead of numeric property IDs. It
contains mappings from property IDs to their associated string
values. The dictionary is stored as the property with ID 0. The codepage
- for the strings in the dictionary is defined by property with ID 1.</p></div>
+ for the strings in the dictionary is defined by property with ID 1.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the dictionary or <code>null</code> if the section does not have
a dictionary.</dd></dl>
</li>
@@ -612,7 +858,7 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>getCodepage</h4>
<pre>public int getCodepage()</pre>
-<div class="block"><p>Gets the section's codepage, if any.</p></div>
+<div class="block">Gets the section's codepage, if any.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The section's codepage if one is defined, else -1.</dd></dl>
</li>
</ul>
@@ -668,13 +914,13 @@ extends java.lang.Object</pre>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field_summary">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field_detail">Field</a> | </li>
+<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org