Provide an alternate method to get the OLE2 thumbnail that decodes

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1749526 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/hpsf/SummaryInformation.java b/src/java/org/apache/poi/hpsf/SummaryInformation.java
index d25aa58e27cc04b44e3accd52e0dad6e9584e513..5c260187c08942206b56fe497d763f4f446845c9 100644 (file)
--- a/src/java/org/apache/poi/hpsf/SummaryInformation.java
+++ b/src/java/org/apache/poi/hpsf/SummaryInformation.java
@@ -620,10 +620,9 @@ public final class SummaryInformation extends SpecialPropertySet {
      * method is implemented. Please note that the return type is likely to
      * change!</strong></p>
      *
-     * <p><strong>Hint to developers:</strong> Drew Varner &lt;Drew.Varner
-     * -at- sc.edu&gt; said that this is an image in WMF or Clipboard (BMP?)
-     * format. However, we won't do any conversion into any image type but
-     * instead just return a byte array.</p>
+     * <p>To process this data, you may wish to make use of the
+     *  {@link Thumbnail} class. The raw data is generally 
+     *  an image in WMF or Clipboard (BMP?) format</p>
      *
      * @return The thumbnail or <code>null</code>
      */
@@ -632,6 +631,20 @@ public final class SummaryInformation extends SpecialPropertySet {
         return (byte[]) getProperty(PropertyIDMap.PID_THUMBNAIL);
     }
 
+    /**
+     * <p>Returns the thumbnail (or <code>null</code>), processed
+     *  as an object which is (largely) able to unpack the thumbnail
+     *  image data.</p>
+     *
+     * @return The thumbnail or <code>null</code>
+     */
+    public Thumbnail getThumbnailThumbnail()
+    {
+        byte[] data = getThumbnail();
+        if (data == null) return null;
+        return new Thumbnail(data);
+    }
+
 
 
     /**