KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > mbtf > v1 > IError


1 /*
2  * @(#)IError.java
3  *
4  * Copyright (C) 2002-2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Part of the GroboUtils package at:
9  * http://groboutils.sourceforge.net
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  */
29 package net.sourceforge.groboutils.mbtf.v1;
30
31
32 /**
33  * Contains all information relating to when an error (or warning) was
34  * reported to <tt>IErrors</tt>. Implementations should have toString()
35  * for aid in IErrors outputs.
36  *
37  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
38  * @version $Date: 2003/02/10 22:52:24 $
39  * @since June 12, 2002
40  */
41 public interface IError
42 {
43     /**
44      * The path history at the time of the error, if any history was known.
45      *
46      * @return the path history, or <tt>null</tt>.
47      */
48     public IPathHistory getPathHistory();
49     
50     
51     /**
52      * Returns the <tt>Throwable</tt> registered with the error report, if
53      * any.
54      *
55      * @return the registered throwable, or <tt>null</tt>.
56      */
57     public Throwable JavaDoc getThrowable();
58     
59     
60     /**
61      * Returns the human-readable message associated with the error, if any.
62      *
63      * @return the human-readable message, or <tt>null</tt>.
64      */
65     public String JavaDoc getMessage();
66 }
67
68
Popular Tags