View Javadoc

1   /*
2    *  jDTAUS Core Utilities
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.util;
22  
23  import org.jdtaus.core.text.Message;
24  
25  /**
26   * Resolves {@code Message}s for given exceptions.
27   *
28   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
29   * @version $JDTAUS: ExceptionMessageResolver.java 8641 2012-09-27 06:45:17Z schulte $
30   *
31   * @see ExceptionMessageProducer#onException(ExceptionEvent)
32   */
33  public interface ExceptionMessageResolver
34  {
35      //--ExceptionMessageResolver------------------------------------------------
36  
37      /**
38       * Resolves {@code Message}s for a given exception.
39       *
40       * @param exception the exception to resolve any messages for.
41       *
42       * @return an array of application messages resolved for {@code exception}
43       * or {@code null} if the implementation cannot resolve any application
44       * messages for {@code exception}.
45       *
46       * @throws NullPointerException if {@code exception} is {@code null}.
47       *
48       * @see ExceptionMessageProducer#onException(ExceptionEvent)
49       */
50      Message[] resolve( Exception exception );
51  
52      //------------------------------------------------ExceptionMessageResolver--
53  }