public abstract class POIDocument extends Object implements Closeable
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the underlying
POIFSFileSystem from which
the document was read, if any. |
void |
createInformationProperties()
Will create whichever of SummaryInformation
and DocumentSummaryInformation (HPSF) properties
are not already part of your document.
|
DirectoryNode |
getDirectory() |
DocumentSummaryInformation |
getDocumentSummaryInformation()
Fetch the Document Summary Information of the document
|
EncryptionInfo |
getEncryptionInfo() |
SummaryInformation |
getSummaryInformation()
Fetch the Summary Information of the document
|
abstract void |
write()
Writes the document out to the currently open
File , via the
writeable POIFSFileSystem it was opened from. |
abstract void |
write(File newFile)
Writes the document out to the specified new
File . |
abstract void |
write(OutputStream out)
Writes the document out to the specified output stream.
|
public DocumentSummaryInformation getDocumentSummaryInformation()
public SummaryInformation getSummaryInformation()
public void createInformationProperties()
public abstract void write() throws IOException
File
, via the
writeable POIFSFileSystem
it was opened from.
This will fail (with an IllegalStateException
if the
document was opened read-only, opened from an InputStream
instead of a File, or if this is not the root document. For those cases,
you must use write(OutputStream)
or write(File)
to
write to a brand new document.
IOException
- thrown on errors writing to the fileIllegalStateException
- if this isn't from a writable Filepublic abstract void write(File newFile) throws IOException
File
. If the file
exists, it will be replaced, otherwise a new one will be creatednewFile
- The new File to write to.IOException
- thrown on errors writing to the filepublic abstract void write(OutputStream out) throws IOException
File
rather
than an InputStream
, you must write out using
write()
or to a different File. Overwriting the currently
open file via an OutputStream isn't possible.
If stream
is a FileOutputStream
on a networked drive
or has a high cost/latency associated with each written byte,
consider wrapping the OutputStream in a BufferedOutputStream
to improve write performance, or use write()
/ write(File)
if possible.out
- The stream to write to.IOException
- thrown on errors writing to the streampublic void close() throws IOException
POIFSFileSystem
from which
the document was read, if any. Has no effect on documents
opened from an InputStream, or newly created ones.
Once close()
has been called, no further operations
should be called on the document.
close
in interface Closeable
close
in interface AutoCloseable
IOException
@Internal public DirectoryNode getDirectory()
public EncryptionInfo getEncryptionInfo() throws IOException
null
IOException
- If retrieving the encryption information failsCopyright © 2010 - 2020 Adobe. All Rights Reserved