public class POIFSFileSystem extends BlockStore implements POIFSViewable, Closeable
This is the main class of the POIFS system; it manages the entire life cycle of the filesystem.
This is the new NIO version, which uses less memory
Constructor and Description |
---|
POIFSFileSystem()
Constructor, intended for writing
|
POIFSFileSystem(File file)
Creates a POIFSFileSystem from a File.
|
POIFSFileSystem(File file,
boolean readOnly)
Creates a POIFSFileSystem from a File.
|
POIFSFileSystem(FileChannel channel)
Creates a POIFSFileSystem from an open FileChannel.
|
POIFSFileSystem(FileChannel channel,
boolean readOnly)
Creates a POIFSFileSystem from an open FileChannel.
|
POIFSFileSystem(InputStream stream)
Create a POIFSFileSystem from an InputStream.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the FileSystem, freeing any underlying files, streams
and buffers.
|
static POIFSFileSystem |
create(File file)
Creates a new
POIFSFileSystem in a new File . |
DirectoryEntry |
createDirectory(String name)
create a new DirectoryEntry in the root directory
|
DocumentEntry |
createDocument(InputStream stream,
String name)
Create a new document to be added to the root directory
|
DocumentEntry |
createDocument(String name,
int size,
POIFSWriterListener writer)
create a new DocumentEntry in the root entry; the data will be
provided later
|
DocumentInputStream |
createDocumentInputStream(String documentName)
open a document in the root entry's list of entries
|
DocumentEntry |
createOrUpdateDocument(InputStream stream,
String name)
Set the contents of a document in the root directory,
creating if needed, otherwise updating
|
int |
getBigBlockSize() |
POIFSBigBlockSize |
getBigBlockSizeDetails() |
HeaderBlock |
getHeaderBlock() |
PropertyTable |
getPropertyTable() |
DirectoryNode |
getRoot()
Get the root entry
|
String |
getShortDescription()
Provides a short description of the object, to be used when a
POIFSViewable object has not provided its contents.
|
Object[] |
getViewableArray()
Get an array of objects, some of which may implement
POIFSViewable
|
Iterator<Object> |
getViewableIterator()
Get an Iterator of objects, some of which may implement
POIFSViewable
|
boolean |
isInPlaceWriteable()
Does the filesystem support an in-place write via
writeFilesystem() ? If false, only writing out to
a brand new file via writeFilesystem(OutputStream)
is supported. |
static void |
main(String[] args)
read in a file and write it back out again
|
boolean |
preferArray()
Give viewers a hint as to whether to call getViewableArray or
getViewableIterator
|
void |
writeFilesystem()
Write the filesystem out to the open file.
|
void |
writeFilesystem(OutputStream stream)
Write the filesystem out
|
public POIFSFileSystem()
public POIFSFileSystem(File file) throws IOException
Creates a POIFSFileSystem from a File. This uses less memory than creating from an InputStream. The File will be opened read-only
Note that with this constructor, you will need to call close()
when you're done to have the underlying file closed, as the file is
kept open during normal operation to read the data out.
file
- the File from which to read the dataIOException
- on errors reading, or on invalid datapublic POIFSFileSystem(File file, boolean readOnly) throws IOException
Creates a POIFSFileSystem from a File. This uses less memory than creating from an InputStream.
Note that with this constructor, you will need to call close()
when you're done to have the underlying file closed, as the file is
kept open during normal operation to read the data out.
file
- the File from which to read or read/write the datareadOnly
- whether the POIFileSystem will only be used in read-only modeIOException
- on errors reading, or on invalid datapublic POIFSFileSystem(FileChannel channel) throws IOException
Creates a POIFSFileSystem from an open FileChannel. This uses less memory than creating from an InputStream. The stream will be used in read-only mode.
Note that with this constructor, you will need to call close()
when you're done to have the underlying Channel closed, as the channel is
kept open during normal operation to read the data out.
channel
- the FileChannel from which to read the dataIOException
- on errors reading, or on invalid datapublic POIFSFileSystem(FileChannel channel, boolean readOnly) throws IOException
Creates a POIFSFileSystem from an open FileChannel. This uses less memory than creating from an InputStream.
Note that with this constructor, you will need to call close()
when you're done to have the underlying Channel closed, as the channel is
kept open during normal operation to read the data out.
channel
- the FileChannel from which to read or read/write the datareadOnly
- whether the POIFileSystem will only be used in read-only modeIOException
- on errors reading, or on invalid datapublic POIFSFileSystem(InputStream stream) throws IOException
Some streams are usable after reaching EOF (typically those that return true
for markSupported()). In the unlikely case that the caller has such a stream
and needs to use it after this constructor completes, a work around is to wrap the
stream in order to trap the close() call. A convenience method (
createNonClosingInputStream()) has been provided for this purpose:
InputStream wrappedStream = POIFSFileSystem.createNonClosingInputStream(is); HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); is.reset(); doSomethingElse(is);Note also the special case of ByteArrayInputStream for which the close() method does nothing.
ByteArrayInputStream bais = ... HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.close() ! bais.reset(); // no problem doSomethingElse(bais);
stream
- the InputStream from which to read the dataIOException
- on errors reading, or on invalid datapublic DocumentEntry createDocument(InputStream stream, String name) throws IOException
stream
- the InputStream from which the document's data
will be obtainedname
- the name of the new POIFSDocumentIOException
- on error creating the new POIFSDocumentpublic DocumentEntry createDocument(String name, int size, POIFSWriterListener writer) throws IOException
name
- the name of the new DocumentEntrysize
- the size of the new DocumentEntrywriter
- the writer of the new DocumentEntryIOException
- if the writer exceeds the given sizepublic DirectoryEntry createDirectory(String name) throws IOException
name
- the name of the new DirectoryEntryIOException
- on name duplicationpublic DocumentEntry createOrUpdateDocument(InputStream stream, String name) throws IOException
stream
- the InputStream from which the document's data
will be obtainedname
- the name of the new or existing POIFSDocumentIOException
- on error populating the POIFSDocumentpublic boolean isInPlaceWriteable()
writeFilesystem()
? If false, only writing out to
a brand new file via writeFilesystem(OutputStream)
is supported.public void writeFilesystem() throws IOException
IllegalArgumentException
if opened from an
InputStream
.IOException
- thrown on errors writing to the streampublic void writeFilesystem(OutputStream stream) throws IOException
stream
- the OutputStream to which the filesystem will be
writtenIOException
- thrown on errors writing to the streampublic void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
public static void main(String[] args) throws IOException
args
- names of the files; arg[ 0 ] is the input file,
arg[ 1 ] is the output fileIOException
public DirectoryNode getRoot()
public DocumentInputStream createDocumentInputStream(String documentName) throws IOException
documentName
- the name of the document to be openedIOException
- if the document does not exist or the
name is that of a DirectoryEntrypublic Object[] getViewableArray()
getViewableArray
in interface POIFSViewable
public Iterator<Object> getViewableIterator()
getViewableIterator
in interface POIFSViewable
public boolean preferArray()
preferArray
in interface POIFSViewable
public String getShortDescription()
getShortDescription
in interface POIFSViewable
public int getBigBlockSize()
public POIFSBigBlockSize getBigBlockSizeDetails()
public static POIFSFileSystem create(File file) throws IOException
POIFSFileSystem
in a new File
.
Use POIFSFileSystem(File)
to open an existing File,
this should only be used to create a new empty filesystem.file
- The file to create and openPOIFSFileSystem
IOException
@Internal public PropertyTable getPropertyTable()
@Internal public HeaderBlock getHeaderBlock()
Copyright © 2010 - 2020 Adobe. All Rights Reserved