Package loci.poi.hssf.eventusermodel
Class AbortableHSSFListener
java.lang.Object
loci.poi.hssf.eventusermodel.AbortableHSSFListener
- All Implemented Interfaces:
HSSFListener
Interface for use with the HSSFRequest and HSSFEventFactory. Users should create
a listener supporting this interface and register it with the HSSFRequest (associating
it with Record SID's).
- Author:
- Carey Sublette (careysub@earthling.net)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract shortabortableProcessRecord(Record record) Process an HSSF Record.voidprocessRecord(Record record) This method, inherited from HSSFListener is implemented as a stub.
-
Constructor Details
-
AbortableHSSFListener
public AbortableHSSFListener()
-
-
Method Details
-
processRecord
This method, inherited from HSSFListener is implemented as a stub. It is never called by HSSFEventFActory or HSSFRequest.- Specified by:
processRecordin interfaceHSSFListener
-
abortableProcessRecord
Process an HSSF Record. Called when a record occurs in an HSSF file. Provides two options for halting the processing of the HSSF file. The return value provides a means of non-error termination with a user-defined result code. A value of zero must be returned to continue processing, any other value will halt processing byHSSFEventFactorywith the code being passed back by its abortable process events methods. Error termination can be done by throwing the HSSFUserException. Note that HSSFEventFactory will not call the inherited process- Returns:
- result code of zero for continued processing.
- Throws:
HSSFUserException- User code can throw this to abort file processing by HSSFEventFactory and return diagnostic information.
-