public class POIXMLProperties
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
POIXMLProperties.CoreProperties
The core document properties
|
static class |
POIXMLProperties.CustomProperties
Custom document properties
|
static class |
POIXMLProperties.ExtendedProperties
Extended document properties
|
Constructor and Description |
---|
POIXMLProperties(OPCPackage docPackage) |
Modifier and Type | Method and Description |
---|---|
void |
commit()
Commit changes to the underlying OPC package
|
POIXMLProperties.CoreProperties |
getCoreProperties()
Returns the core document properties
|
POIXMLProperties.CustomProperties |
getCustomProperties()
Returns the custom document properties
|
POIXMLProperties.ExtendedProperties |
getExtendedProperties()
Returns the extended document properties
|
java.lang.String |
getThumbnailFilename()
Returns the name of the Document thumbnail, eg
thumbnail.jpeg , or null if there
isn't one. |
java.io.InputStream |
getThumbnailImage()
Returns the Document thumbnail image data, or
null if there isn't one. |
protected PackagePart |
getThumbnailPart()
Returns the
PackagePart for the Document
Thumbnail, or null if there isn't one |
void |
setThumbnail(java.lang.String filename,
java.io.InputStream imageData)
Sets the Thumbnail for the document, replacing any existing one.
|
public POIXMLProperties(OPCPackage docPackage) throws java.io.IOException, OpenXML4JException, org.apache.xmlbeans.XmlException
java.io.IOException
OpenXML4JException
org.apache.xmlbeans.XmlException
public POIXMLProperties.CoreProperties getCoreProperties()
public POIXMLProperties.ExtendedProperties getExtendedProperties()
public POIXMLProperties.CustomProperties getCustomProperties()
protected PackagePart getThumbnailPart()
PackagePart
for the Document
Thumbnail, or null
if there isn't onepublic java.lang.String getThumbnailFilename()
thumbnail.jpeg
, or null
if there
isn't one.public java.io.InputStream getThumbnailImage() throws java.io.IOException
null
if there isn't one.java.io.IOException
- if the thumbnail can't be readpublic void setThumbnail(java.lang.String filename, java.io.InputStream imageData) throws java.io.IOException
filename
- The filename for the thumbnail image, eg thumbnail.jpg
imageData
- The inputstream to read the thumbnail image fromjava.io.IOException
- if the thumbnail can't be writtenpublic void commit() throws java.io.IOException
java.io.IOException
- if the properties can't be savedPOIXMLException
- if the properties are erroneousCopyright 2020 The Apache Software Foundation or its licensors, as applicable.