Class POIFSReader
java.lang.Object
org.apache.poi.poifs.eventfilesystem.POIFSReader
An event-driven reader for POIFS file systems. Users of this class
first create an instance of it, then use the registerListener
methods to register POIFSReaderListener instances for specific
documents. Once all the listeners have been registered, the read()
method is called, which results in the listeners being notified as
their documents are read.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidread in filesvoidRead from a File and process the documents we getvoidread(InputStream stream) Read from an InputStream and process the documents we getvoidread(POIFSFileSystem poifs) Read from a NPOIFSFileSystem and process the documents we getvoidregisterListener(POIFSReaderListener listener) Register a POIFSReaderListener for all documentsvoidregisterListener(POIFSReaderListener listener, String name) Register a POIFSReaderListener for a document in the root directoryvoidregisterListener(POIFSReaderListener listener, POIFSDocumentPath path, String name) Register a POIFSReaderListener for a document in the specified directoryvoidsetNotifyEmptyDirectories(boolean notifyEmptyDirectories) Activates the notification of empty directories.
-
Constructor Details
-
POIFSReader
public POIFSReader()
-
-
Method Details
-
read
Read from an InputStream and process the documents we get- Parameters:
stream- the InputStream from which to read the data- Throws:
IOException- on errors reading, or on invalid data
-
read
Read from a File and process the documents we get- Parameters:
poifsFile- the file from which to read the data- Throws:
IOException- on errors reading, or on invalid data
-
read
Read from a NPOIFSFileSystem and process the documents we get- Parameters:
poifs- the NPOIFSFileSystem from which to read the data- Throws:
IOException- on errors reading, or on invalid data
-
registerListener
Register a POIFSReaderListener for all documents- Parameters:
listener- the listener to be registered- Throws:
NullPointerException- if listener is nullIllegalStateException- if read() has already been called
-
registerListener
Register a POIFSReaderListener for a document in the root directory- Parameters:
listener- the listener to be registeredname- the document name- Throws:
NullPointerException- if listener is null or name is null or emptyIllegalStateException- if read() has already been called
-
registerListener
Register a POIFSReaderListener for a document in the specified directory- Parameters:
listener- the listener to be registeredpath- the document path; if null, the root directory is assumedname- the document name- Throws:
NullPointerException- if listener is null or name is null or emptyIllegalStateException- if read() has already been called
-
setNotifyEmptyDirectories
public void setNotifyEmptyDirectories(boolean notifyEmptyDirectories) Activates the notification of empty directories.If this flag is activated, the
listenerreceivesPOIFSReaderEventswith nullednameandstream- Parameters:
notifyEmptyDirectories- iftrue, empty directories will be notified
-
main
read in files- Parameters:
args- names of the files- Throws:
IOException- if the files can't be read or have invalid content
-