KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > event > SinkException


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12  * implied.
13  *
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */

17 package org.apache.excalibur.event;
18
19 /**
20  * A SourceException is thrown when an enqueue operation fails.
21  *
22  * <p>
23  * The interface design is heavily influenced by
24  * <a HREF="mailto:mdw@cs.berkeley.edu">Matt Welsh</a>'s SandStorm server,
25  * his demonstration of the SEDA architecture. We have deviated where we
26  * felt the design differences where better.
27  * </p>
28  *
29  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
30  */

31 public class SinkException
32     extends Exception JavaDoc
33 {
34     /**
35      * The Throwable that caused this exception to be thrown.
36      */

37     private final Throwable JavaDoc m_throwable;
38
39     /**
40      * Construct a new <code>SinkException</code> instance.
41      *
42      * @param message The detail message for this exception.
43      */

44     public SinkException( final String JavaDoc message )
45     {
46         this( message, null );
47     }
48
49     /**
50      * Construct a new <code>SinkException</code> instance.
51      *
52      * @param message The detail message for this exception.
53      * @param throwable the root cause of the exception
54      */

55     public SinkException( final String JavaDoc message, final Throwable JavaDoc throwable )
56     {
57         super( message );
58         m_throwable = throwable;
59     }
60
61     /**
62      * Retrieve root cause of the exception.
63      *
64      * @return the root cause
65      */

66     public final Throwable JavaDoc getCause()
67     {
68         return m_throwable;
69     }
70 }
71
Popular Tags