FileDocCategorySizeDatePackage
AbortableHSSFListener.javaAPI DocApache Poi 3.0.12744Mon Jan 01 12:39:36 GMT 2007org.apache.poi.hssf.eventusermodel

AbortableHSSFListener

public abstract class AbortableHSSFListener extends Object implements 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).
see
org.apache.poi.hssf.eventusermodel.HSSFEventFactory
see
org.apache.poi.hssf.eventusermodel.HSSFRequest
see
org.apache.poi.hssf.eventusermodel.HSSFUserException
author
Carey Sublette (careysub@earthling.net)

Fields Summary
Constructors Summary
Methods Summary
public abstract shortabortableProcessRecord(org.apache.poi.hssf.record.Record record)
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 by HSSFEventFactory with 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

return
result code of zero for continued processing.
throws
HSSFUserException User code can throw this to abort file processing by HSSFEventFactory and return diagnostic information.

public voidprocessRecord(org.apache.poi.hssf.record.Record record)
This method, inherited from HSSFListener is implemented as a stub.
It is never called by HSSFEventFActory or HSSFRequest.