Package loci.poi.poifs.eventfilesystem
Class POIFSReader
- java.lang.Object
-
- loci.poi.poifs.eventfilesystem.POIFSReader
-
public class POIFSReader extends Object
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.- Author:
- Marc Johnson (mjohnson at apache dot org)
-
-
Constructor Summary
Constructors Constructor Description POIFSReader()
Create a POIFSReader
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
main(String[] args)
read in filesvoid
read(loci.common.RandomAccessInputStream stream, int size)
Read from an InputStream and process the documents we getvoid
registerListener(POIFSReaderListener listener)
Register a POIFSReaderListener for all documentsvoid
registerListener(POIFSReaderListener listener, String name)
Register a POIFSReaderListener for a document in the root directoryvoid
registerListener(POIFSReaderListener listener, POIFSDocumentPath path, String name)
Register a POIFSReaderListener for a document in the specified directory
-
-
-
Method Detail
-
read
public void read(loci.common.RandomAccessInputStream stream, int size) throws IOException
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
-
registerListener
public void registerListener(POIFSReaderListener listener)
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
public void registerListener(POIFSReaderListener listener, String name)
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
public void registerListener(POIFSReaderListener listener, POIFSDocumentPath path, String name)
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
-
main
public static void main(String[] args) throws IOException
read in files- Parameters:
args
- names of the files- Throws:
IOException
-
-