ExceptionHolder


1   /*===========================================================================
2   
3   ObjectWeb Util API
4   Copyright (C) 2002 USTL - LIFL - GOAL
5   Contact: architecture@objectweb.org
6   
7   This library is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Lesser General Public
9   License as published by the Free Software Foundation; either
10  version 2.1 of the License, or any later version.
11  
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  Lesser General Public License for more details.
16  
17  You should have received a copy of the GNU Lesser General Public
18  License along with this library; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
20  USA
21  
22  Initial developer(s): Philippe Merle.
23  Contributor(s): ______________________________________.
24  
25  ===========================================================================*/
26  
27  package org.objectweb.util.browser.core.api;
28  
29  /**
30   * Specifies an exception holder.
31   *
32   * This interface provides methods to get and set an exception,
33   * i.e. getOWException and setOWException methods.
34   *
35   * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
36   * @version 0.1
37   */
38  public interface ExceptionHolder {
39  
40      /**
41       * Returns the stored exception.
42       *
43       * This method does not update the stored exception.
44       *
45       * @return The stored exception.
46       *
47       * @postcondition return == getOWException();
48       */
49      java.lang.Exception   getOWException();
50  
51      /**
52       * Sets the stored exception.
53       *
54       * This method sets the stored exception to the given exception.
55       *
56       * @param exception The exception to store.
57       *
58       * @postcondition getOWException() == exception;
59       */
60      void setOWException(java.lang.Exception   exception);
61  
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags