View Javadoc

1   /*
2    *  jDTAUS Core SPI
3    *  Copyright (C) 2005 Christian Schulte
4    *  <cs@schulte.it>
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19   *
20   */
21  package org.jdtaus.core.lang.spi;
22  
23  import org.jdtaus.core.lang.ExceptionEvent;
24  import org.jdtaus.core.lang.ExceptionEventSource;
25  
26  /**
27   * Handles exceptions.
28   * <p>jDTAUS Core SPI {@code ExceptionHandler} specification to be used by
29   * implementations to handle exceptions.</p>
30   *
31   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
32   * @version $JDTAUS: ExceptionHandler.java 8641 2012-09-27 06:45:17Z schulte $
33   */
34  public interface ExceptionHandler extends ExceptionEventSource
35  {
36      //--ExceptionHandler--------------------------------------------------------
37  
38      /**
39       * Gets all {@code ExceptionEvent}s handled by the handler.
40       *
41       * @return an array of all {@code ExceptionEvent}s handled by the handler.
42       * @deprecated Starting with version 1.8, the {@code ExceptionListener}s
43       * provided to a system should be used to gather information about handled
44       * exceptions.
45       */
46       ExceptionEvent[] getExceptionEvents();
47  
48      /**
49       * Handles a given exception.
50       *
51       * @param t the {@code Throwable} that was caught.
52       *
53       * @throws NullPointerException if {@code t} is {@code null}.
54       */
55      void handle( Throwable t );
56  
57      //--------------------------------------------------------ExceptionHandler--
58  }