You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2017/09/18 18:28:48 UTC
svn commit: r1808757 - in /poi/site/src/documentation/content/xdocs:
hpsf/how-to.xml spreadsheet/quick-guide.xml status.xml
Author: fanningpj
Date: Mon Sep 18 18:28:47 2017
New Revision: 1808757
URL: http://svn.apache.org/viewvc?rev=1808757&view=rev
Log:
update release notes
Modified:
poi/site/src/documentation/content/xdocs/hpsf/how-to.xml
poi/site/src/documentation/content/xdocs/spreadsheet/quick-guide.xml
poi/site/src/documentation/content/xdocs/status.xml
Modified: poi/site/src/documentation/content/xdocs/hpsf/how-to.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/hpsf/how-to.xml?rev=1808757&r1=1808756&r2=1808757&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/hpsf/how-to.xml (original)
+++ poi/site/src/documentation/content/xdocs/hpsf/how-to.xml Mon Sep 18 18:28:47 2017
@@ -1193,13 +1193,8 @@ No property set stream: "/1Table"</sourc
</ul>
<p>HPSF's writing capabilities come with the classes
- <code>MutablePropertySet</code>, <code>MutableSection</code>,
- <code>MutableProperty</code>, and some helper classes. The "mutable"
- classes extend their respective superclasses <code>PropertySet</code>,
- <code>Section</code>, and <code>Property</code> and provide "set" and
- "write" methods, following the <link
- href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator
- pattern</link>.</p>
+ <code>PropertySet</code>, <code>Section</code>,
+ <code>Property</code>, and some helper classes.</p>
</section>
@@ -1208,26 +1203,25 @@ No property set stream: "/1Table"</sourc
to perform the following steps:</p>
<ol>
- <li>Create a <code>MutablePropertySet</code> instance.</li>
+ <li>Create a <code>PropertySet</code> instance.</li>
- <li>Get hold of a <code>MutableSection</code>. You can either retrieve
- the one that is always present in a new <code>MutablePropertySet</code>,
- or you have to create a new <code>MutableSection</code> and add it to
- the <code>MutablePropertySet</code>.
+ <li>Get hold of a <code>Section</code>. You can either retrieve
+ the one that is always present in a new <code>PropertySet</code>,
+ or you have to create a new <code>Section</code> and add it to
+ the <code>PropertySet</code>.
</li>
<li>Set any <code>Section</code> fields as you like.</li>
- <li>Create as many <code>MutableProperty</code> objects as you need. Set
+ <li>Create as many <code>Property</code> objects as you need. Set
each property's ID, type, and value. Add the
- <code>MutableProperty</code> objects to the
- <code>MutableSection</code>.
+ <code>Property</code> objects to the <code>Section</code>.
</li>
- <li>Create further <code>MutableSection</code>s if you need them.</li>
+ <li>Create further <code>Section</code>s if you need them.</li>
<li>Eventually retrieve the property set as a byte stream using
- <code>MutablePropertySet.toInputStream()</code> and write it to a POIFS
+ <code>PropertySet.toInputStream()</code> and write it to a POIFS
document.</li>
</ol>
</section>
@@ -1256,9 +1250,10 @@ import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
-import org.apache.poi.hpsf.MutableProperty;
-import org.apache.poi.hpsf.MutablePropertySet;
-import org.apache.poi.hpsf.MutableSection;
+import org.apache.poi.hpsf.Property;
+import org.apache.poi.hpsf.PropertySet;
+import org.apache.poi.hpsf.Section;
+import org.apache.poi.hpsf.Section;
import org.apache.poi.hpsf.SummaryInformation;
import org.apache.poi.hpsf.Variant;
import org.apache.poi.hpsf.WritingNotSupportedException;
@@ -1299,10 +1294,10 @@ public class WriteTitle
/* Create a mutable property set. Initially it contains a single section
* with no properties. */
- final MutablePropertySet mps = new MutablePropertySet();
+ final PropertySet mps = new PropertySet();
/* Retrieve the section the property set already contains. */
- final MutableSection ms = (MutableSection) mps.getSections().get(0);
+ final Section ms = mps.getSections().get(0);
/* Turn the property set into a summary information property. This is
* done by setting the format ID of its first section to
@@ -1310,7 +1305,7 @@ public class WriteTitle
ms.setFormatID(SectionIDMap.SUMMARY_INFORMATION_ID);
/* Create an empty property. */
- final MutableProperty p = new MutableProperty();
+ final Property p = new Property();
/* Fill the property with appropriate settings so that it specifies the
* document's title. */
@@ -1360,46 +1355,36 @@ final String fileName = args[0];</source
methods to modify its contents, i.e. to write sections containing
properties into it.</p>
- <p>The class to use is <code>MutablePropertySet</code>. It is a subclass
- of <code>PropertySet</code>. The sample application calls its no-args
+ <p>The class to use is <code>PropertySet</code>. The sample application calls its no-args
constructor in order to establish an empty property set:</p>
- <source>final MutablePropertySet mps = new MutablePropertySet();</source>
+ <source>final PropertySet mps = new PropertySet();</source>
<p>As said, we have an empty property set now. Later we will put some
contents into it.</p>
- <p>By the way, the <code>MutablePropertySet</code> class has another
- constructor taking a <code>PropertySet</code> as parameter. It creates a
- mutable deep copy of the property set given to it.</p>
-
- <p>The <code>MutablePropertySet</code> created by the no-args constructor
+ <p>The <code>PropertySet</code> created by the no-args constructor
is not really empty: It contains a single section without properties. We
can either retrieve that section and fill it with properties or we can
replace it by another section. We can also add further sections to the
property set. The sample application decides to retrieve the section
being already there:</p>
- <source>final MutableSection ms = (MutableSection) mps.getSections().get(0);</source>
+ <source>final Section ms = mps.getSections().get(0);</source>
<p>The <code>getSections()</code> method returns the property set's
sections as a list, i.e. an instance of
<code>java.util.List</code>. Calling <code>get(0)</code> returns the
- list's first (or zeroth, if you prefer) element. The <code>Section</code>
- returned is a <code>MutableSection</code>: a subclass of
- <code>Section</code> you can modify.</p>
+ list's first (or zeroth, if you prefer) element.</p>
- <p>The alternative to retrieving the <code>MutableSection</code> being
+ <p>The alternative to retrieving the <code>Section</code> being
already there would have been to create an new
- <code>MutableSection</code> like this:</p>
-
- <source>MutableSection s = new MutableSection();</source>
+ <code>Section</code> like this:</p>
- <p>There is also a constructor which takes a <code>Section</code> as
- parameter and creates a mutable deep copy of it.</p>
+ <source>Section s = new Section();</source>
- <p>The <code>MutableSection</code> the sample application retrieved from
- the <code>MutablePropertySet</code> is still empty. It contains no
+ <p>The <code>Section</code> the sample application retrieved from
+ the <code>PropertySet</code> is still empty. It contains no
properties and does not have a format ID. As you have read <link
href="#sec3">above</link> the format ID of the first section in a
property set determines the property set's type. Since our property set
@@ -1413,13 +1398,9 @@ final String fileName = args[0];</source
<source>ms.setFormatID(SectionIDMap.SUMMARY_INFORMATION_ID);</source>
- <p>Now it is time to create a property. As you might expect there is a
- subclass of <code>Property</code> called
- <code>MutableProperty</code> with a no-args constructor:</p>
-
- <source>final MutableProperty p = new MutableProperty();</source>
+ <source>final Property p = new Property();</source>
- <p>A <code>MutableProperty</code> object must have an ID, a type, and a
+ <p>A <code>Property</code> object must have an ID, a type, and a
value (see <link href="#sec3">above</link> for details). The class
provides methods to set these attributes:</p>
@@ -1427,13 +1408,13 @@ final String fileName = args[0];</source
p.setType(Variant.VT_LPWSTR);
p.setValue("Sample title");</source>
- <p>The <code>MutableProperty</code> class has a constructor which you can
+ <p>The <code>Property</code> class has a constructor which you can
use to pass in all three attributes in a single call. See the Javadoc API
documentation for details!</p>
<p>The sample property set is complete now. We have a
- <code>MutablePropertySet</code> containing a <code>MutableSection</code>
- containing a <code>MutableProperty</code>. Of course we could have added
+ <code>PropertySet</code> containing a <code>Section</code>
+ containing a <code>Property</code>. Of course we could have added
more sections to the property set and more properties to the sections but
we wanted to keep things simple.</p>
@@ -1443,7 +1424,7 @@ p.setValue("Sample title");</source>
<source>final POIFSFileSystem poiFs = new POIFSFileSystem();</source>
<p>Writing the property set includes the step of converting it into a
- sequence of bytes. The <code>MutablePropertySet</code> class has the
+ sequence of bytes. The <code>PropertySet</code> class has the
method <code>toInputStream()</code> for this purpose. It returns the
bytes making out the property set stream as an
<code>InputStream</code>:</p>
Modified: poi/site/src/documentation/content/xdocs/spreadsheet/quick-guide.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/spreadsheet/quick-guide.xml?rev=1808757&r1=1808756&r2=1808757&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/spreadsheet/quick-guide.xml (original)
+++ poi/site/src/documentation/content/xdocs/spreadsheet/quick-guide.xml Mon Sep 18 18:28:47 2017
@@ -412,7 +412,7 @@
System.out.println(text);
// Alternatively, get the value and format it yourself
- switch (cell.getCellTypeEnum()) {
+ switch (cell.getCellType()) {
case CellType.STRING:
System.out.println(cell.getRichStringCellValue().getString());
break;
Modified: poi/site/src/documentation/content/xdocs/status.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/status.xml?rev=1808757&r1=1808756&r2=1808757&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/status.xml (original)
+++ poi/site/src/documentation/content/xdocs/status.xml Mon Sep 18 18:28:47 2017
@@ -57,7 +57,13 @@
-->
<release version="4.0.0-SNAPSHOT" date="2017-12-??">
+ <summary>
+ <summary-item>Removed support for Java 6 and 7 making Java 8 the minimum version supported</summary-item>
+ <summary-item>Removal of deprecated classes and methods that were marked for removal in v4.0</summary-item>
+ <summary-item>Removal of deprecated classes and methods that were marked for removal in v3.18</summary-item>
+ </summary>
<actions>
+ <action dev="PD" type="add" fixes-bug="github-69" module="SS Common">Support matrix functions</action>
<action dev="PD" type="fix" fixes-bug="60499" module="OPC">Deleting a picture that is used twice on a slide corrupt the slide</action>
<action dev="PD" type="fix" fixes-bug="60279" module="POI">Back-off to brute-force search for macro content if macro offset is incorrect.</action>
</actions>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org