Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/MutableProperty.html Tue May 2 23:37:06 2017 @@ -64,7 +64,7 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Property">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.Property">Method</a></li> </ul> @@ -110,7 +110,8 @@ <div class="block"><i>POI 3.16 - use Property as base class instead</i></div> </div> <br> -<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") +<pre>@Deprecated +<a href="../../../../org/apache/poi/util/Removal.html" title="annotation in org.apache.poi.util">@Removal</a>(<a href="../../../../org/apache/poi/util/Removal.html#version()">version</a>="3.18") public class <span class="strong">MutableProperty</span> extends <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></pre> <div class="block"><p>Adds writing capability to the <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> class.</p> @@ -123,6 +124,21 @@ 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.Property"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></h3> +<code><a href="../../../../org/apache/poi/hpsf/Property.html#DEFAULT_CODEPAGE">DEFAULT_CODEPAGE</a></code></li> +</ul> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> @@ -140,6 +156,30 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty(long,%20byte[],%20long,%20int,%20int)">MutableProperty</a></strong>(long id, + byte[] src, + long offset, + int length, + int codepage)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty(long,%20org.apache.poi.util.LittleEndianByteArrayInputStream,%20int,%20int)">MutableProperty</a></strong>(long id, + <a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> leis, + int length, + int codepage)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty(long,%20long,%20java.lang.Object)">MutableProperty</a></strong>(long id, + long type, + java.lang.Object value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/MutableProperty.html#MutableProperty(org.apache.poi.hpsf.Property)">MutableProperty</a></strong>(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</code> <div class="block"><strong>Deprecated.</strong> </div> </td> @@ -158,7 +198,7 @@ extends <a href="../../../../org/apache/ <!-- --> </a> <h3>Methods inherited from class org.apache.poi.hpsf.<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a></h3> -<code><a href="../../../../org/apache/poi/hpsf/Property.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getID()">getID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getSize()">getSize</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getType()">getType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getValue()">getValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#readDictionary(byte[],%20long,%20int,%20int)">readDictionary</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setID(long)">setID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setType(long)">setType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setValue(java.lang.Object)">setValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/P roperty.html#write(java.io.OutputStream,%20int)">write</a></code></li> +<code><a href="../../../../org/apache/poi/hpsf/Property.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getID()">getID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getSize(int)">getSize</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getType()">getType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#getValue()">getValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#hashCode()">hashCode</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setID(long)">setID</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setType(long)">setType</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#setValue(java.lang.Object)">setValue</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#toString()">toString</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#toString(int)">toString</a>, <a href="../../../../org/apache/poi/hpsf/Property.html#write(java.io.OutputS tream,%20int)">write</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -194,13 +234,58 @@ extends <a href="../../../../org/apache/ <a name="MutableProperty(org.apache.poi.hpsf.Property)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>MutableProperty</h4> <pre>public MutableProperty(<a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a> p)</pre> <div class="block"><span class="strong">Deprecated.</span> </div> </li> </ul> +<a name="MutableProperty(long, long, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MutableProperty</h4> +<pre>public MutableProperty(long id, + long type, + java.lang.Object value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="MutableProperty(long, byte[], long, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MutableProperty</h4> +<pre>public MutableProperty(long id, + byte[] src, + long offset, + int length, + int codepage) + 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> +<a name="MutableProperty(long, org.apache.poi.util.LittleEndianByteArrayInputStream, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MutableProperty</h4> +<pre>public MutableProperty(long id, + <a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> leis, + int length, + int codepage) + 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> </ul> </li> @@ -253,7 +338,7 @@ extends <a href="../../../../org/apache/ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#fields_inherited_from_class_org.apache.poi.hpsf.Property">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#methods_inherited_from_class_org.apache.poi.hpsf.Property">Method</a></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=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/Property.html Tue May 2 23:37:06 2017 @@ -64,13 +64,13 @@ <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field_summary">Field</a> | </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>Field | </li> +<li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> @@ -132,6 +132,27 @@ extends java.lang.Object</pre> <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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#DEFAULT_CODEPAGE">DEFAULT_CODEPAGE</a></strong></code> +<div class="block">Default codepage for <code>CodePageStrings</code></div> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> @@ -159,13 +180,22 @@ extends java.lang.Object</pre> </td> </tr> <tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#Property(long,%20org.apache.poi.util.LittleEndianByteArrayInputStream,%20int,%20int)">Property</a></strong>(long id, + <a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> leis, + int length, + int codepage)</code> +<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> +</td> +</tr> +<tr class="rowColor"> <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"> +<tr class="altColor"> <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> @@ -199,7 +229,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>protected int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#getSize()">getSize</a></strong>()</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#getSize(int)">getSize</a></strong>(int codepage)</code> <div class="block">Returns the property's size in bytes.</div> </td> </tr> @@ -220,36 +250,31 @@ extends java.lang.Object</pre> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#hashCode()">hashCode</a></strong>()</code> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>protected java.util.Map<?,?></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#readDictionary(byte[],%20long,%20int,%20int)">readDictionary</a></strong>(byte[] src, - long offset, - int length, - int codepage)</code> -<div class="block">Reads a 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/Property.html#setID(long)">setID</a></strong>(long id)</code> <div class="block">Sets the property's ID.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <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"> +<tr class="altColor"> <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"> +<tr class="rowColor"> <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="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Property.html#toString(int)">toString</a></strong>(int codepage)</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, @@ -273,6 +298,25 @@ 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="DEFAULT_CODEPAGE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_CODEPAGE</h4> +<pre>public static final int DEFAULT_CODEPAGE</pre> +<div class="block">Default codepage for <code>CodePageStrings</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Property.DEFAULT_CODEPAGE">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> @@ -317,7 +361,7 @@ extends java.lang.Object</pre> <a name="Property(long, byte[], long, int, int)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>Property</h4> <pre>public Property(long id, @@ -336,6 +380,26 @@ extends java.lang.Object</pre> supported.</dd></dl> </li> </ul> +<a name="Property(long, org.apache.poi.util.LittleEndianByteArrayInputStream, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(long id, + <a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> leis, + int length, + int codepage) + throws java.io.UnsupportedEncodingException</pre> +<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>leis</code> - The bytes the property set stream consists of.</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> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.UnsupportedEncodingException</code> - if the specified codepage is not + supported.</dd></dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> @@ -410,33 +474,13 @@ extends java.lang.Object</pre> <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> -<ul class="blockList"> -<li class="blockList"> -<h4>readDictionary</h4> -<pre>protected java.util.Map<?,?> readDictionary(byte[] src, - long offset, - int length, - int codepage) - throws java.io.UnsupportedEncodingException</pre> -<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> -<dd><code>java.io.UnsupportedEncodingException</code> - if the dictionary's codepage is not - (yet) supported.</dd></dl> -</li> -</ul> -<a name="getSize()"> +<a name="getSize(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSize</h4> -<pre>protected int getSize() +<pre>protected int getSize(int codepage) throws <a href="../../../../org/apache/poi/hpsf/WritingNotSupportedException.html" title="class in org.apache.poi.hpsf">WritingNotSupportedException</a></pre> <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> @@ -453,7 +497,7 @@ extends java.lang.Object</pre> <h4>equals</h4> <pre>public boolean equals(java.lang.Object o)</pre> <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 @@ -490,6 +534,15 @@ extends java.lang.Object</pre> <dt><span class="strong">See Also:</span></dt><dd><code>Object.toString()</code></dd></dl> </li> </ul> +<a name="toString(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString(int codepage)</pre> +</li> +</ul> <a name="write(java.io.OutputStream, int)"> <!-- --> </a> @@ -561,13 +614,13 @@ extends java.lang.Object</pre> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> -<li>Field | </li> +<li><a href="#field_summary">Field</a> | </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>Field | </li> +<li><a href="#field_detail">Field</a> | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> 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=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/Section.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/Section.html Tue May 2 23:37:06 2017 @@ -524,8 +524,7 @@ extends java.lang.Object</pre> <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> +<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></dl> </li> </ul> <a name="setProperty(int, int)"> @@ -694,7 +693,7 @@ extends java.lang.Object</pre> <pre>public java.lang.String getPIDString(long pid)</pre> <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>.</div> + dictionary. If it is not found there, the method calls <a href="../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(org.apache.poi.hpsf.ClassID,%20long)"><code>SectionIDMap.getPIDString(org.apache.poi.hpsf.ClassID, 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> @@ -710,17 +709,6 @@ extends java.lang.Object</pre> 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> @@ -854,7 +842,7 @@ extends java.lang.Object</pre> <a name="getCodepage()"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getCodepage</h4> <pre>public int getCodepage()</pre> @@ -862,6 +850,17 @@ extends java.lang.Object</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>The section's codepage if one is defined, else -1.</dd></dl> </li> </ul> +<a name="setCodepage(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/SummaryInformation.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/SummaryInformation.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/SummaryInformation.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/SummaryInformation.html Tue May 2 23:37:06 2017 @@ -169,6 +169,11 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/SummaryInformation.html#SummaryInformation(java.io.InputStream)">SummaryInformation</a></strong>(java.io.InputStream stream)</code> +<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> +</td> +</tr> +<tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/SummaryInformation.html#SummaryInformation(org.apache.poi.hpsf.PropertySet)">SummaryInformation</a></strong>(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps)</code> <div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a> from a given <a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a>.</div> </td> @@ -595,7 +600,7 @@ extends <a href="../../../../org/apache/ <a name="SummaryInformation(org.apache.poi.hpsf.PropertySet)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>SummaryInformation</h4> <pre>public SummaryInformation(<a href="../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf">PropertySet</a> ps) @@ -608,6 +613,34 @@ extends <a href="../../../../org/apache/ contain a summary information stream.</dd></dl> </li> </ul> +<a name="SummaryInformation(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SummaryInformation</h4> +<pre>public SummaryInformation(java.io.InputStream stream) + throws <a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a>, + <a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a>, + java.io.IOException, + java.io.UnsupportedEncodingException</pre> +<div class="block">Creates a <a href="../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.<p> + + The constructor reads the first few bytes from the stream + and determines whether it is really a property set stream. If + it is, it parses the rest of the stream. If it is not, it + resets the stream to its beginning in order to let other + components mess around with the data and throws an + exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - Holds the data making out the property set + stream.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/poi/hpsf/MarkUnsupportedException.html" title="class in org.apache.poi.hpsf">MarkUnsupportedException</a></code> - if the stream does not support the <code>InputStream.markSupported()</code> method.</dd> +<dd><code>java.io.IOException</code> - if the <code>InputStream</code> cannot be accessed as needed.</dd> +<dd><code><a href="../../../../org/apache/poi/hpsf/NoPropertySetStreamException.html" title="class in org.apache.poi.hpsf">NoPropertySetStreamException</a></code> - if the input stream does not contain a property set.</dd> +<dd><code>java.io.UnsupportedEncodingException</code> - if a character encoding is not supported.</dd></dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/TypeWriter.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/TypeWriter.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/TypeWriter.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/TypeWriter.html Tue May 2 23:37:06 2017 @@ -97,10 +97,15 @@ <ul class="blockList"> <li class="blockList"> <hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>POI 3.16 beta 2 - use LittleEndian instead</i></div> +</div> <br> -<pre>public class <span class="strong">TypeWriter</span> +<pre>@Deprecated +<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">TypeWriter</span> extends java.lang.Object</pre> -<div class="block"><p>Class for writing little-endian data and more.</p></div> +<div class="block">Class for writing little-endian data and more.</div> </li> </ul> </div> @@ -119,7 +124,9 @@ extends java.lang.Object</pre> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#TypeWriter()">TypeWriter</a></strong>()</code> </td> +<td class="colOne"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#TypeWriter()">TypeWriter</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> </tr> </table> </li> @@ -140,6 +147,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20org.apache.poi.hpsf.ClassID)">writeToStream</a></strong>(java.io.OutputStream out, <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a 16-byte <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf"><code>ClassID</code></a> to an output stream.</div> </td> </tr> @@ -147,6 +155,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20double)">writeToStream</a></strong>(java.io.OutputStream out, double n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a double value value to an output stream.</div> </td> </tr> @@ -154,6 +163,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20int)">writeToStream</a></strong>(java.io.OutputStream out, int n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a four-byte value to an output stream.</div> </td> </tr> @@ -161,6 +171,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20long)">writeToStream</a></strong>(java.io.OutputStream out, long n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a eight-byte value to an output stream.</div> </td> </tr> @@ -169,6 +180,7 @@ extends java.lang.Object</pre> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20org.apache.poi.hpsf.Property[],%20int)">writeToStream</a></strong>(java.io.OutputStream out, <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties, int codepage)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes an array of <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instances to an output stream according to the Horrible Property Stream Format.</div> </td> @@ -177,6 +189,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20short)">writeToStream</a></strong>(java.io.OutputStream out, short n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a two-byte value (short) to an output stream.</div> </td> </tr> @@ -184,6 +197,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeUIntToStream(java.io.OutputStream,%20long)">writeUIntToStream</a></strong>(java.io.OutputStream out, long n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes an unsigned four-byte value to an output stream.</div> </td> </tr> @@ -191,6 +205,7 @@ extends java.lang.Object</pre> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/TypeWriter.html#writeUShortToStream(java.io.OutputStream,%20int)">writeUShortToStream</a></strong>(java.io.OutputStream out, int n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes an unsigned two-byte value to an output stream.</div> </td> </tr> @@ -223,6 +238,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>TypeWriter</h4> <pre>public TypeWriter()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> </li> </ul> </li> @@ -242,6 +258,7 @@ extends java.lang.Object</pre> <pre>public static int writeToStream(java.io.OutputStream out, short n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes a two-byte value (short) to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd><dd><code>n</code> - The value to write.</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes that have been written.</dd> @@ -258,6 +275,7 @@ extends java.lang.Object</pre> <pre>public static int writeToStream(java.io.OutputStream out, int n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes a four-byte value to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd><dd><code>n</code> - The value to write.</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes written to the output stream.</dd> @@ -274,6 +292,7 @@ extends java.lang.Object</pre> <pre>public static int writeToStream(java.io.OutputStream out, long n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes a eight-byte value to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd><dd><code>n</code> - The value to write.</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes written to the output stream.</dd> @@ -290,6 +309,7 @@ extends java.lang.Object</pre> <pre>public static void writeUShortToStream(java.io.OutputStream out, int n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes an unsigned two-byte value to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to</dd><dd><code>n</code> - The value to write</dd> <dt><span class="strong">Throws:</span></dt> @@ -305,6 +325,7 @@ extends java.lang.Object</pre> <pre>public static int writeUIntToStream(java.io.OutputStream out, long n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes an unsigned four-byte value to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd><dd><code>n</code> - The value to write.</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes that have been written to the output stream.</dd> @@ -321,6 +342,7 @@ extends java.lang.Object</pre> <pre>public static int writeToStream(java.io.OutputStream out, <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes a 16-byte <a href="../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf"><code>ClassID</code></a> to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to</dd><dd><code>n</code> - The value to write</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes written</dd> @@ -339,6 +361,7 @@ extends java.lang.Object</pre> int codepage) throws java.io.IOException, <a href="../../../../org/apache/poi/hpsf/UnsupportedVariantTypeException.html" title="class in org.apache.poi.hpsf">UnsupportedVariantTypeException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes an array of <a href="../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instances to an output stream according to the Horrible Property Stream Format.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to</dd><dd><code>properties</code> - The array to write to the stream</dd><dd><code>codepage</code> - The codepage number to use for writing strings</dd> @@ -357,6 +380,7 @@ extends java.lang.Object</pre> <pre>public static int writeToStream(java.io.OutputStream out, double n) throws java.io.IOException</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> <div class="block"><p>Writes a double value value to an output stream.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write to.</dd><dd><code>n</code> - The value to write.</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of bytes written to the output stream.</dd> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/Util.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/Util.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/Util.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/Util.html Tue May 2 23:37:06 2017 @@ -167,33 +167,26 @@ extends java.lang.Object</pre> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>static boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Util.html#equals(java.lang.Object[],%20java.lang.Object[])">equals</a></strong>(java.lang.Object[] c1, - java.lang.Object[] c2)</code> -<div class="block">Compares to object arrays with regarding the objects' order.</div> -</td> -</tr> -<tr class="altColor"> <td class="colFirst"><code>static java.util.Date</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Util.html#filetimeToDate(int,%20int)">filetimeToDate</a></strong>(int high, int low)</code> <div class="block">Converts a Windows FILETIME into a <code>Date</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static java.util.Date</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Util.html#filetimeToDate(long)">filetimeToDate</a></strong>(long filetime)</code> <div class="block">Converts a Windows FILETIME into a <code>Date</code>.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Util.html#pad4(byte[])">pad4</a></strong>(byte[] ba)</code> <div class="block">Pads a byte array with 0x00 bytes so that its length is a multiple of 4.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Util.html#toString(java.lang.Throwable)">toString</a></strong>(java.lang.Throwable t)</code> <div class="block">Returns a textual representation of a <code>Throwable</code>, including a @@ -310,21 +303,6 @@ extends java.lang.Object</pre> <a href="../../../../org/apache/poi/hpsf/Util.html#filetimeToDate(int,%20int)"><code>filetimeToDate(int, int)</code></a></dd></dl> </li> </ul> -<a name="equals(java.lang.Object[], java.lang.Object[])"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>equals</h4> -<pre>public static boolean equals(java.lang.Object[] c1, - java.lang.Object[] c2)</pre> -<div class="block"><p>Compares to object arrays with regarding the objects' order. For - example, [1, 2, 3] and [2, 1, 3] are equal.</p></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c1</code> - The first object array.</dd><dd><code>c2</code> - The second object array.</dd> -<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the object arrays are equal, - <code>false</code> if they are not.</dd></dl> -</li> -</ul> <a name="pad4(byte[])"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/Variant.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/Variant.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/Variant.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/Variant.html Tue May 2 23:37:06 2017 @@ -104,16 +104,15 @@ <br> <pre>public class <span class="strong">Variant</span> extends java.lang.Object</pre> -<div class="block"><p>The <em>Variant</em> types as defined by Microsoft's COM. I - found this information in <a - href="http://www.marin.clara.net/COM/variant_type_definitions.htm";> - http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.</p> +<div class="block">The <code>Variant</code> types as defined by Microsoft's COM. - <p>In the variant types descriptions the following shortcuts are - used: <strong> [V]</strong> - may appear in a VARIANT, - <strong>[T]</strong> - may appear in a TYPEDESC, - <strong>[P]</strong> - may appear in an OLE property set, - <strong>[S]</strong> - may appear in a Safe Array.</p></div> + In the variant types descriptions the following shortcuts are used: + <ul> + <li>[V] - may appear in a VARIANT + <li>[T] - may appear in a TYPEDESC + <li>[P] - may appear in an OLE property set + <li>[S] - may appear in a Safe Array + </ul></div> </li> </ul> </div> @@ -243,7 +242,7 @@ extends java.lang.Object</pre> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_DISPATCH">VT_DISPATCH</a></strong></code> -<div class="block">[V][T][P][S] IDispatch *.</div> +<div class="block">[V][T][P][S] IDispatch</div> </td> </tr> <tr class="rowColor"> @@ -255,7 +254,7 @@ extends java.lang.Object</pre> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_ERROR">VT_ERROR</a></strong></code> -<div class="block">[V][T][S] SCODE.</div> +<div class="block">[V][T][S] SCODE</div> </td> </tr> <tr class="rowColor"> @@ -296,15 +295,11 @@ extends java.lang.Object</pre> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_ILLEGAL">VT_ILLEGAL</a></strong></code> -<div class="block">FIXME (3): Document this!</div> -</td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_ILLEGAL">VT_ILLEGAL</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_ILLEGALMASKED">VT_ILLEGALMASKED</a></strong></code> -<div class="block">FIXME (3): Document this!</div> -</td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_ILLEGALMASKED">VT_ILLEGALMASKED</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> @@ -350,9 +345,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_RESERVED">VT_RESERVED</a></strong></code> -<div class="block">FIXME (3): Document this!</div> -</td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_RESERVED">VT_RESERVED</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> @@ -386,9 +379,7 @@ extends java.lang.Object</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_TYPEMASK">VT_TYPEMASK</a></strong></code> -<div class="block">FIXME (3): Document this!</div> -</td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_TYPEMASK">VT_TYPEMASK</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> @@ -423,7 +414,7 @@ extends java.lang.Object</pre> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_UNKNOWN">VT_UNKNOWN</a></strong></code> -<div class="block">[V][T][S] IUnknown *.</div> +<div class="block">[V][T][S] IUnknown</div> </td> </tr> <tr class="rowColor"> @@ -435,7 +426,7 @@ extends java.lang.Object</pre> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/Variant.html#VT_VARIANT">VT_VARIANT</a></strong></code> -<div class="block">[V][T][P][S] VARIANT *.</div> +<div class="block">[V][T][P][S] VARIANT</div> </td> </tr> <tr class="rowColor"> @@ -530,7 +521,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_EMPTY</h4> <pre>public static final int VT_EMPTY</pre> -<div class="block"><p>[V][P] Nothing, i.e. not a single byte of data.</p></div> +<div class="block">[V][P] Nothing, i.e. not a single byte of data.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_EMPTY">Constant Field Values</a></dd></dl> </li> </ul> @@ -541,7 +532,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_NULL</h4> <pre>public static final int VT_NULL</pre> -<div class="block"><p>[V][P] SQL style Null.</p></div> +<div class="block">[V][P] SQL style Null.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_NULL">Constant Field Values</a></dd></dl> </li> </ul> @@ -552,7 +543,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_I2</h4> <pre>public static final int VT_I2</pre> -<div class="block"><p>[V][T][P][S] 2 byte signed int.</p></div> +<div class="block">[V][T][P][S] 2 byte signed int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_I2">Constant Field Values</a></dd></dl> </li> </ul> @@ -563,7 +554,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_I4</h4> <pre>public static final int VT_I4</pre> -<div class="block"><p>[V][T][P][S] 4 byte signed int.</p></div> +<div class="block">[V][T][P][S] 4 byte signed int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_I4">Constant Field Values</a></dd></dl> </li> </ul> @@ -574,7 +565,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_R4</h4> <pre>public static final int VT_R4</pre> -<div class="block"><p>[V][T][P][S] 4 byte real.</p></div> +<div class="block">[V][T][P][S] 4 byte real.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_R4">Constant Field Values</a></dd></dl> </li> </ul> @@ -585,7 +576,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_R8</h4> <pre>public static final int VT_R8</pre> -<div class="block"><p>[V][T][P][S] 8 byte real.</p></div> +<div class="block">[V][T][P][S] 8 byte real.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_R8">Constant Field Values</a></dd></dl> </li> </ul> @@ -596,9 +587,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_CY</h4> <pre>public static final int VT_CY</pre> -<div class="block"><p>[V][T][P][S] currency. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[V][T][P][S] currency.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_CY">Constant Field Values</a></dd></dl> </li> </ul> @@ -609,9 +598,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_DATE</h4> <pre>public static final int VT_DATE</pre> -<div class="block"><p>[V][T][P][S] date. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[V][T][P][S] date.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_DATE">Constant Field Values</a></dd></dl> </li> </ul> @@ -622,9 +609,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_BSTR</h4> <pre>public static final int VT_BSTR</pre> -<div class="block"><p>[V][T][P][S] OLE Automation string. <span - style="background-color: #ffff00">How long is this? How is it - to be interpreted?</span></p></div> +<div class="block">[V][T][P][S] OLE Automation string.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_BSTR">Constant Field Values</a></dd></dl> </li> </ul> @@ -635,9 +620,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_DISPATCH</h4> <pre>public static final int VT_DISPATCH</pre> -<div class="block"><p>[V][T][P][S] IDispatch *. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[V][T][P][S] IDispatch</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_DISPATCH">Constant Field Values</a></dd></dl> </li> </ul> @@ -648,8 +631,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_ERROR</h4> <pre>public static final int VT_ERROR</pre> -<div class="block"><p>[V][T][S] SCODE. <span style="background-color: #ffff00">How - long is this? How is it to be interpreted?</span></p></div> +<div class="block">[V][T][S] SCODE</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_ERROR">Constant Field Values</a></dd></dl> </li> </ul> @@ -660,7 +642,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_BOOL</h4> <pre>public static final int VT_BOOL</pre> -<div class="block"><p>[V][T][P][S] True=-1, False=0.</p></div> +<div class="block">[V][T][P][S] True=-1, False=0.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_BOOL">Constant Field Values</a></dd></dl> </li> </ul> @@ -671,9 +653,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_VARIANT</h4> <pre>public static final int VT_VARIANT</pre> -<div class="block"><p>[V][T][P][S] VARIANT *. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[V][T][P][S] VARIANT</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_VARIANT">Constant Field Values</a></dd></dl> </li> </ul> @@ -684,9 +664,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UNKNOWN</h4> <pre>public static final int VT_UNKNOWN</pre> -<div class="block"><p>[V][T][S] IUnknown *. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[V][T][S] IUnknown</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UNKNOWN">Constant Field Values</a></dd></dl> </li> </ul> @@ -697,7 +675,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_DECIMAL</h4> <pre>public static final int VT_DECIMAL</pre> -<div class="block"><p>[V][T][S] 16 byte fixed point.</p></div> +<div class="block">[V][T][S] 16 byte fixed point.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_DECIMAL">Constant Field Values</a></dd></dl> </li> </ul> @@ -708,7 +686,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_I1</h4> <pre>public static final int VT_I1</pre> -<div class="block"><p>[T] signed char.</p></div> +<div class="block">[T] signed char.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_I1">Constant Field Values</a></dd></dl> </li> </ul> @@ -719,7 +697,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UI1</h4> <pre>public static final int VT_UI1</pre> -<div class="block"><p>[V][T][P][S] unsigned char.</p></div> +<div class="block">[V][T][P][S] unsigned char.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UI1">Constant Field Values</a></dd></dl> </li> </ul> @@ -730,7 +708,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UI2</h4> <pre>public static final int VT_UI2</pre> -<div class="block"><p>[T][P] unsigned short.</p></div> +<div class="block">[T][P] unsigned short.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UI2">Constant Field Values</a></dd></dl> </li> </ul> @@ -741,7 +719,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UI4</h4> <pre>public static final int VT_UI4</pre> -<div class="block"><p>[T][P] unsigned int.</p></div> +<div class="block">[T][P] unsigned int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UI4">Constant Field Values</a></dd></dl> </li> </ul> @@ -752,7 +730,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_I8</h4> <pre>public static final int VT_I8</pre> -<div class="block"><p>[T][P] signed 64-bit int.</p></div> +<div class="block">[T][P] signed 64-bit int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_I8">Constant Field Values</a></dd></dl> </li> </ul> @@ -763,7 +741,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UI8</h4> <pre>public static final int VT_UI8</pre> -<div class="block"><p>[T][P] unsigned 64-bit int.</p></div> +<div class="block">[T][P] unsigned 64-bit int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UI8">Constant Field Values</a></dd></dl> </li> </ul> @@ -774,7 +752,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_INT</h4> <pre>public static final int VT_INT</pre> -<div class="block"><p>[T] signed machine int.</p></div> +<div class="block">[T] signed machine int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_INT">Constant Field Values</a></dd></dl> </li> </ul> @@ -785,7 +763,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_UINT</h4> <pre>public static final int VT_UINT</pre> -<div class="block"><p>[T] unsigned machine int.</p></div> +<div class="block">[T] unsigned machine int.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_UINT">Constant Field Values</a></dd></dl> </li> </ul> @@ -796,7 +774,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_VOID</h4> <pre>public static final int VT_VOID</pre> -<div class="block"><p>[T] C style void.</p></div> +<div class="block">[T] C style void.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_VOID">Constant Field Values</a></dd></dl> </li> </ul> @@ -807,9 +785,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_HRESULT</h4> <pre>public static final int VT_HRESULT</pre> -<div class="block"><p>[T] Standard return type. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[T] Standard return type.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_HRESULT">Constant Field Values</a></dd></dl> </li> </ul> @@ -820,9 +796,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_PTR</h4> <pre>public static final int VT_PTR</pre> -<div class="block"><p>[T] pointer type. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[T] pointer type.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_PTR">Constant Field Values</a></dd></dl> </li> </ul> @@ -833,7 +807,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_SAFEARRAY</h4> <pre>public static final int VT_SAFEARRAY</pre> -<div class="block"><p>[T] (use VT_ARRAY in VARIANT).</p></div> +<div class="block">[T] (use VT_ARRAY in VARIANT).</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_SAFEARRAY">Constant Field Values</a></dd></dl> </li> </ul> @@ -844,9 +818,9 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_CARRAY</h4> <pre>public static final int VT_CARRAY</pre> -<div class="block"><p>[T] C style array. <span style="background-color: +<div class="block">[T] C style array. <span style="background-color: #ffff00">How long is this? How is it to be - interpreted?</span></p></div> + interpreted?</span></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_CARRAY">Constant Field Values</a></dd></dl> </li> </ul> @@ -857,9 +831,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_USERDEFINED</h4> <pre>public static final int VT_USERDEFINED</pre> -<div class="block"><p>[T] user defined type. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[T] user defined type.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_USERDEFINED">Constant Field Values</a></dd></dl> </li> </ul> @@ -870,7 +842,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_LPSTR</h4> <pre>public static final int VT_LPSTR</pre> -<div class="block"><p>[T][P] null terminated string.</p></div> +<div class="block">[T][P] null terminated string.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_LPSTR">Constant Field Values</a></dd></dl> </li> </ul> @@ -881,7 +853,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_LPWSTR</h4> <pre>public static final int VT_LPWSTR</pre> -<div class="block"><p>[T][P] wide (Unicode) null terminated string.</p></div> +<div class="block">[T][P] wide (Unicode) null terminated string.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_LPWSTR">Constant Field Values</a></dd></dl> </li> </ul> @@ -892,11 +864,11 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_FILETIME</h4> <pre>public static final int VT_FILETIME</pre> -<div class="block"><p>[P] FILETIME. The FILETIME structure holds a date and time +<div class="block">[P] FILETIME. The FILETIME structure holds a date and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. This 64-bit value is split - into the two dwords stored in the structure.</p></div> + into the two dwords stored in the structure.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_FILETIME">Constant Field Values</a></dd></dl> </li> </ul> @@ -907,7 +879,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_BLOB</h4> <pre>public static final int VT_BLOB</pre> -<div class="block"><p>[P] Length prefixed bytes.</p></div> +<div class="block">[P] Length prefixed bytes.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_BLOB">Constant Field Values</a></dd></dl> </li> </ul> @@ -918,7 +890,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_STREAM</h4> <pre>public static final int VT_STREAM</pre> -<div class="block"><p>[P] Name of the stream follows.</p></div> +<div class="block">[P] Name of the stream follows.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_STREAM">Constant Field Values</a></dd></dl> </li> </ul> @@ -929,7 +901,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_STORAGE</h4> <pre>public static final int VT_STORAGE</pre> -<div class="block"><p>[P] Name of the storage follows.</p></div> +<div class="block">[P] Name of the storage follows.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_STORAGE">Constant Field Values</a></dd></dl> </li> </ul> @@ -940,9 +912,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_STREAMED_OBJECT</h4> <pre>public static final int VT_STREAMED_OBJECT</pre> -<div class="block"><p>[P] Stream contains an object. <span - style="background-color: #ffff00"> How long is this? How is it - to be interpreted?</span></p></div> +<div class="block">[P] Stream contains an object.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_STREAMED_OBJECT">Constant Field Values</a></dd></dl> </li> </ul> @@ -953,9 +923,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_STORED_OBJECT</h4> <pre>public static final int VT_STORED_OBJECT</pre> -<div class="block"><p>[P] Storage contains an object. <span - style="background-color: #ffff00"> How long is this? How is it - to be interpreted?</span></p></div> +<div class="block">[P] Storage contains an object.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_STORED_OBJECT">Constant Field Values</a></dd></dl> </li> </ul> @@ -966,9 +934,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_BLOB_OBJECT</h4> <pre>public static final int VT_BLOB_OBJECT</pre> -<div class="block"><p>[P] Blob contains an object. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[P] Blob contains an object.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_BLOB_OBJECT">Constant Field Values</a></dd></dl> </li> </ul> @@ -979,9 +945,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_CF</h4> <pre>public static final int VT_CF</pre> -<div class="block"><p>[P] Clipboard format. <span style="background-color: - #ffff00">How long is this? How is it to be - interpreted?</span></p></div> +<div class="block">[P] Clipboard format.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_CF">Constant Field Values</a></dd></dl> </li> </ul> @@ -992,35 +956,31 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_CLSID</h4> <pre>public static final int VT_CLSID</pre> -<div class="block"><p>[P] A Class ID.</p> +<div class="block">[P] A Class ID.<p> - <p>It consists of a 32 bit unsigned integer indicating the size + It consists of a 32 bit unsigned integer indicating the size of the structure, a 32 bit signed integer indicating (Clipboard Format Tag) indicating the type of data that it contains, and - then a byte array containing the data.</p> + then a byte array containing the data.<p> - <p>The valid Clipboard Format Tags are:</p> + The valid Clipboard Format Tags are: <ul> - <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_WINDOWS"><code>Thumbnail.CFTAG_WINDOWS</code></a></li> - <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_MACINTOSH"><code>Thumbnail.CFTAG_MACINTOSH</code></a></li> - <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_NODATA"><code>Thumbnail.CFTAG_NODATA</code></a></li> - <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_FMTID"><code>Thumbnail.CFTAG_FMTID</code></a></li> + <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_WINDOWS"><code>Thumbnail.CFTAG_WINDOWS</code></a> + <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_MACINTOSH"><code>Thumbnail.CFTAG_MACINTOSH</code></a> + <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_NODATA"><code>Thumbnail.CFTAG_NODATA</code></a> + <li><a href="../../../../org/apache/poi/hpsf/Thumbnail.html#CFTAG_FMTID"><code>Thumbnail.CFTAG_FMTID</code></a> </ul> - <pre>typedef struct tagCLIPDATA { + <pre><code>typedef struct tagCLIPDATA { // cbSize is the size of the buffer pointed to // by pClipData, plus sizeof(ulClipFmt) ULONG cbSize; long ulClipFmt; BYTE* pClipData; - } CLIPDATA;</pre> - - <p>See <a - href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp" - target="_blank"> - msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.</p></div> -<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_CLSID">Constant Field Values</a></dd></dl> + } CLIPDATA;</code></pre></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa380072(v=vs.85).aspx">PROPVARIANT structure</a>, +<a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_CLSID">Constant Field Values</a></dd></dl> </li> </ul> <a name="VT_VERSIONED_STREAM"> @@ -1044,9 +1004,9 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_VECTOR</h4> <pre>public static final int VT_VECTOR</pre> -<div class="block"><p>[P] simple counted array. <span style="background-color: +<div class="block">[P] simple counted array. <span style="background-color: #ffff00">How long is this? How is it to be - interpreted?</span></p></div> + interpreted?</span></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_VECTOR">Constant Field Values</a></dd></dl> </li> </ul> @@ -1057,8 +1017,8 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_ARRAY</h4> <pre>public static final int VT_ARRAY</pre> -<div class="block"><p>[V] SAFEARRAY*. <span style="background-color: #ffff00">How - long is this? How is it to be interpreted?</span></p></div> +<div class="block">[V] SAFEARRAY*. <span style="background-color: #ffff00">How + long is this? How is it to be interpreted?</span></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_ARRAY">Constant Field Values</a></dd></dl> </li> </ul> @@ -1069,9 +1029,9 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_BYREF</h4> <pre>public static final int VT_BYREF</pre> -<div class="block"><p>[V] void* for local use. <span style="background-color: +<div class="block">[V] void* for local use. <span style="background-color: #ffff00">How long is this? How is it to be - interpreted?</span></p></div> + interpreted?</span></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_BYREF">Constant Field Values</a></dd></dl> </li> </ul> @@ -1082,7 +1042,6 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_RESERVED</h4> <pre>public static final int VT_RESERVED</pre> -<div class="block"><p>FIXME (3): Document this!</p></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_RESERVED">Constant Field Values</a></dd></dl> </li> </ul> @@ -1093,7 +1052,6 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_ILLEGAL</h4> <pre>public static final int VT_ILLEGAL</pre> -<div class="block"><p>FIXME (3): Document this!</p></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_ILLEGAL">Constant Field Values</a></dd></dl> </li> </ul> @@ -1104,7 +1062,6 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_ILLEGALMASKED</h4> <pre>public static final int VT_ILLEGALMASKED</pre> -<div class="block"><p>FIXME (3): Document this!</p></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_ILLEGALMASKED">Constant Field Values</a></dd></dl> </li> </ul> @@ -1115,7 +1072,6 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>VT_TYPEMASK</h4> <pre>public static final int VT_TYPEMASK</pre> -<div class="block"><p>FIXME (3): Document this!</p></div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.poi.hpsf.Variant.VT_TYPEMASK">Constant Field Values</a></dd></dl> </li> </ul> @@ -1126,7 +1082,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_UNKNOWN</h4> <pre>public static final java.lang.Integer LENGTH_UNKNOWN</pre> -<div class="block"><p>Denotes a variant type with a length that is unknown to HPSF yet.</p></div> +<div class="block">Denotes a variant type with a length that is unknown to HPSF yet.</div> </li> </ul> <a name="LENGTH_VARIABLE"> @@ -1136,7 +1092,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_VARIABLE</h4> <pre>public static final java.lang.Integer LENGTH_VARIABLE</pre> -<div class="block"><p>Denotes a variant type with a variable length.</p></div> +<div class="block">Denotes a variant type with a variable length.</div> </li> </ul> <a name="LENGTH_0"> @@ -1146,7 +1102,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_0</h4> <pre>public static final java.lang.Integer LENGTH_0</pre> -<div class="block"><p>Denotes a variant type with a length of 0 bytes.</p></div> +<div class="block">Denotes a variant type with a length of 0 bytes.</div> </li> </ul> <a name="LENGTH_2"> @@ -1156,7 +1112,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_2</h4> <pre>public static final java.lang.Integer LENGTH_2</pre> -<div class="block"><p>Denotes a variant type with a length of 2 bytes.</p></div> +<div class="block">Denotes a variant type with a length of 2 bytes.</div> </li> </ul> <a name="LENGTH_4"> @@ -1166,7 +1122,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_4</h4> <pre>public static final java.lang.Integer LENGTH_4</pre> -<div class="block"><p>Denotes a variant type with a length of 4 bytes.</p></div> +<div class="block">Denotes a variant type with a length of 4 bytes.</div> </li> </ul> <a name="LENGTH_8"> @@ -1176,7 +1132,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>LENGTH_8</h4> <pre>public static final java.lang.Integer LENGTH_8</pre> -<div class="block"><p>Denotes a variant type with a length of 8 bytes.</p></div> +<div class="block">Denotes a variant type with a length of 8 bytes.</div> </li> </ul> </li> @@ -1211,8 +1167,8 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getVariantName</h4> <pre>public static java.lang.String getVariantName(long variantType)</pre> -<div class="block"><p>Returns the variant type name associated with a variant type - number.</p></div> +<div class="block">Returns the variant type name associated with a variant type + number.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>variantType</code> - The variant type number</dd> <dt><span class="strong">Returns:</span></dt><dd>The variant type name or the string "unknown variant type"</dd></dl> </li> @@ -1224,7 +1180,7 @@ extends java.lang.Object</pre> <li class="blockList"> <h4>getVariantLength</h4> <pre>public static int getVariantLength(long variantType)</pre> -<div class="block"><p>Returns a variant type's length.</p></div> +<div class="block">Returns a variant type's length.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>variantType</code> - The variant type number</dd> <dt><span class="strong">Returns:</span></dt><dd>The length of the variant type's data in bytes. If the length is variable, i.e. the length of a string, -1 is returned. If HPSF does not Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/VariantSupport.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/VariantSupport.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/VariantSupport.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/VariantSupport.html Tue May 2 23:37:06 2017 @@ -214,13 +214,20 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>static java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/VariantSupport.html#read(org.apache.poi.util.LittleEndianByteArrayInputStream,%20int,%20long,%20int)">read</a></strong>(<a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> lei, + int length, + long type, + int codepage)</code> </td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/VariantSupport.html#setLogUnsupportedTypes(boolean)">setLogUnsupportedTypes</a></strong>(boolean logUnsupportedTypes)</code> <div class="block">Specifies whether warnings about unsupported variant types are to be written to <code>System.err</code> or not.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/VariantSupport.html#write(java.io.OutputStream,%20long,%20java.lang.Object,%20int)">write</a></strong>(java.io.OutputStream out, long type, @@ -229,7 +236,7 @@ extends <a href="../../../../org/apache/ <div class="block">Writes a variant value to an output stream.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>protected static void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/hpsf/VariantSupport.html#writeUnsupportedTypeMessage(org.apache.poi.hpsf.UnsupportedVariantTypeException)">writeUnsupportedTypeMessage</a></strong>(<a href="../../../../org/apache/poi/hpsf/UnsupportedVariantTypeException.html" title="class in org.apache.poi.hpsf">UnsupportedVariantTypeException</a> ex)</code> <div class="block">Writes a warning to <code>System.err</code> that a variant type is @@ -379,13 +386,31 @@ extends <a href="../../../../org/apache/ supported.</dd><dt><span class="strong">See Also:</span></dt><dd><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="read(org.apache.poi.util.LittleEndianByteArrayInputStream, int, long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public static java.lang.Object read(<a href="../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> lei, + int length, + long type, + int codepage) + throws <a href="../../../../org/apache/poi/hpsf/ReadingNotSupportedException.html" title="class in org.apache.poi.hpsf">ReadingNotSupportedException</a>, + java.io.UnsupportedEncodingException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/poi/hpsf/ReadingNotSupportedException.html" title="class in org.apache.poi.hpsf">ReadingNotSupportedException</a></code></dd> +<dd><code>java.io.UnsupportedEncodingException</code></dd></dl> +</li> +</ul> <a name="codepageToEncoding(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>codepageToEncoding</h4> -<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") +<pre>@Deprecated +<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 static java.lang.String codepageToEncoding(int codepage) throws java.io.UnsupportedEncodingException</pre> <div class="block"><span class="strong">Deprecated.</span> <i>POI 3.16 - use <a href="../../../../org/apache/poi/util/CodePageUtil.html#codepageToEncoding(int)"><code>CodePageUtil.codepageToEncoding(int)</code></a></i></div> @@ -414,12 +439,7 @@ public static java.lang.String  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 a variant value to an output stream. This method ensures that - always a multiple of 4 bytes is written.<p> - - If the codepage is UTF-16, which is encouraged, strings - <strong>must</strong> always be written as <a href="../../../../org/apache/poi/hpsf/Variant.html#VT_LPWSTR"><code>Variant.VT_LPWSTR</code></a> - strings, not as <a href="../../../../org/apache/poi/hpsf/Variant.html#VT_LPSTR"><code>Variant.VT_LPSTR</code></a> strings. This method ensure this - by converting strings appropriately, if needed.</div> + always a multiple of 4 bytes is written.<p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - The stream to write the value to.</dd><dd><code>type</code> - The variant's type.</dd><dd><code>value</code> - The variant's value.</dd><dd><code>codepage</code> - The codepage to use to write non-wide strings</dd> <dt><span class="strong">Returns:</span></dt><dd>The number of entities that have been written. In many cases an "entity" is a byte but this is not always the case.</dd> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
