01: /* ====================================================================
02: Licensed to the Apache Software Foundation (ASF) under one or more
03: contributor license agreements. See the NOTICE file distributed with
04: this work for additional information regarding copyright ownership.
05: The ASF licenses this file to You under the Apache License, Version 2.0
06: (the "License"); you may not use this file except in compliance with
07: the License. You may obtain a copy of the License at
08:
09: http://www.apache.org/licenses/LICENSE-2.0
10:
11: Unless required by applicable law or agreed to in writing, software
12: distributed under the License is distributed on an "AS IS" BASIS,
13: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: See the License for the specific language governing permissions and
15: limitations under the License.
16: ==================================================================== */
17:
18: package org.apache.poi.hssf.eventusermodel;
19:
20: import org.apache.poi.hssf.record.Record;
21: import org.apache.poi.hssf.eventusermodel.HSSFUserException;
22:
23: /**
24: * Interface for use with the HSSFRequest and HSSFEventFactory. Users should create
25: * a listener supporting this interface and register it with the HSSFRequest (associating
26: * it with Record SID's).
27: *
28: * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
29: * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
30: * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
31: *
32: * @author Carey Sublette (careysub@earthling.net)
33: *
34: */
35:
36: public abstract class AbortableHSSFListener implements HSSFListener {
37: /**
38: * This method, inherited from HSSFListener is implemented as a stub.
39: * It is never called by HSSFEventFActory or HSSFRequest.
40: *
41: */
42:
43: public void processRecord(Record record) {
44: }
45:
46: /**
47: * Process an HSSF Record. Called when a record occurs in an HSSF file.
48: * Provides two options for halting the processing of the HSSF file.
49: *
50: * The return value provides a means of non-error termination with a
51: * user-defined result code. A value of zero must be returned to
52: * continue processing, any other value will halt processing by
53: * <code>HSSFEventFactory</code> with the code being passed back by
54: * its abortable process events methods.
55: *
56: * Error termination can be done by throwing the HSSFUserException.
57: *
58: * Note that HSSFEventFactory will not call the inherited process
59: *
60: * @return result code of zero for continued processing.
61: *
62: * @throws HSSFUserException User code can throw this to abort
63: * file processing by HSSFEventFactory and return diagnostic information.
64: */
65: public abstract short abortableProcessRecord(Record record)
66: throws HSSFUserException;
67: }
|