1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.eventusermodel;
57   
58   import org.apache.poi.hssf.record.Record;
59   import org.apache.poi.hssf.eventusermodel.HSSFUserException;
60   
61   /**
62    * Interface for use with the HSSFRequest and HSSFEventFactory.  Users should create
63    * a listener supporting this interface and register it with the HSSFRequest (associating
64    * it with Record SID's).
65    *
66    * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
67    * @see org.apache.poi.hssf.eventmodel.HSSFRequest
68    * @see org.apache.poi.hssf.HSSFUserException
69    *
70    * @author Carey Sublette (careysub@earthling.net)
71    *
72    */
73   
74   public abstract class AbortableHSSFListener implements HSSFListener
75   {
76       /**
77        * This method, inherited from HSSFListener is implemented as a stub.
78        * It is never called by HSSFEventFActory or HSSFRequest.
79        *
80        */
81        
82   	public void processRecord(Record record)
83   	{
84   	}
85   
86      /**
87   	 * Process an HSSF Record. Called when a record occurs in an HSSF file. 
88   	 * Provides two options for halting the processing of the HSSF file.
89   	 *
90   	 * The return value provides a means of non-error termination with a 
91   	 * user-defined result code. A value of zero must be returned to 
92   	 * continue processing, any other value will halt processing by
93   	 * <code>HSSFEventFactory</code> with the code being passed back by 
94   	 * its abortable process events methods.
95   	 * 
96   	 * Error termination can be done by throwing the HSSFUserException.
97   	 *
98   	 * Note that HSSFEventFactory will not call the inherited process 
99   	 *
100       * @return result code of zero for continued processing.
101       *
102  	 * @throws HSSFUserException User code can throw this to abort 
103  	 * file processing by HSSFEventFactory and return diagnostic information.
104       */
105      public abstract short abortableProcessRecord(Record record) throws HSSFUserException;
106  }
107