loci.poi.hssf.eventusermodel

Class AbortableHSSFListener

java.lang.Object

loci.poi.hssf.eventusermodel.AbortableHSSFListener

All Implemented Interfaces:

HSSFListener

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).

Author:

Carey Sublette (careysub@earthling.net)

See Also:

HSSFEventFactory, HSSFRequest, HSSFUserException

Constructor Summary

Constructors

Constructor and Description
AbortableHSSFListener()

Method Summary

Methods

Modifier and Type	Method and Description
abstract short	abortableProcessRecord(Record record) Process an HSSF Record.
void	processRecord(Record record) This method, inherited from HSSFListener is implemented as a stub.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbortableHSSFListener

public AbortableHSSFListener()

Method Detail

processRecord

public void processRecord(Record record)

This method, inherited from HSSFListener is implemented as a stub. It is never called by HSSFEventFActory or HSSFRequest.

Specified by:

processRecord in interface HSSFListener

abortableProcessRecord

public abstract short abortableProcessRecord(Record record)
                                      throws HSSFUserException

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

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.