View Javadoc

1   /*
2    * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3    * the spring framework, http://el4j.sf.net
4    * Copyright (C) 2005 by ELCA Informatique SA, Av. de la Harpe 22-24,
5    * 1000 Lausanne, Switzerland, http://www.elca.ch
6    *
7    * EL4J is published under the GNU Lesser General Public License (LGPL)
8    * Version 2.1. See http://www.gnu.org/licenses/
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU Lesser General Public License for more details.
14   *
15   * For alternative licensing, please contact info@elca.ch
16   */
17  package ch.elca.el4j.services.gui.swing.exceptions;
18  
19  /**
20   * The interface Exception handlers must implement. It has two methods that
21   * contain the logic for each of its 2 concerns: (1) recognizing Exceptions
22   * it can handle and (2) handling those Exceptions appropriately.
23   *
24   * @svnLink $Revision: 3875 $;$Date: 2009-08-04 14:35:53 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/swing/src/main/java/ch/elca/el4j/services/gui/swing/exceptions/Handler.java $
25   *
26   * @author Stefan Wismer (SWI)
27   */
28  public interface Handler {
29  	/**
30  	 * @param e    the thrown exception
31  	 * @return     <tt>true</tt> if this Handler can handle the given
32  	 *             Exception; <tt>false</tt> otherwise.
33  	 */
34  	public boolean recognize(Exception e);
35  	
36  	/**
37  	 * @return    the priority of this handler. The larger the priority value to earlier it gets executed.
38  	 */
39  	public int getPriority();
40  
41  	/**
42  	 * React to the given Exception in any way seen fit. This may include
43  	 * notifying the user, writing to a log, or any other valid logic.
44  	 *
45  	 * @param e    the thrown exception
46  	 * @return     whether exception handling should be stopped (<code>true</code>) or the next handler should be
47  	 *             executed (<code>false</code>).
48  	 */
49  	public boolean handle(Exception e);
50  }