KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > framework > service > ServiceException


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 1997-2003 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software
24  * itself, if and wherever such third-party acknowledgments
25  * normally appear.
26  *
27  * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55 package org.apache.avalon.framework.service;
56
57 import org.apache.avalon.framework.CascadingException;
58
59 /**
60  * The exception thrown to indicate a problem with service.
61  * It is usually thrown by ServiceManager or ServiceSelector.
62  *
63  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
64  * @version CVS $Revision: 1.19 $ $Date: 2003/02/11 15:58:42 $
65  */
66 public class ServiceException
67     extends CascadingException
68 {
69     private final String JavaDoc m_key;
70
71     /**
72      * Construct a new <code>ServiceException</code> instance.
73      *
74      * @deprecated use the String,String,Throwable version instead
75      * @param message the exception message
76      * @param throwable the throwable
77      */
78     public ServiceException( final String JavaDoc message, final Throwable JavaDoc throwable )
79     {
80         this( null, message, throwable );
81     }
82
83     /**
84      * Construct a new <code>ServiceException</code> instance.
85      *
86      * @param key the lookup key
87      * @param message the exception message
88      * @param throwable the throwable
89      */
90     public ServiceException( final String JavaDoc key, final String JavaDoc message, final Throwable JavaDoc throwable )
91     {
92         super( message, throwable );
93         m_key = key;
94     }
95
96     /**
97      * Construct a new <code>ServiceException</code> instance.
98      *
99      * @deprecated use the String,String version instead
100      * @param message the exception message
101      */
102     public ServiceException( final String JavaDoc message )
103     {
104         this( null, message, null );
105     }
106
107     /**
108      * Construct a new <code>ServiceException</code> instance.
109      *
110      * @param key the lookup key
111      * @param message the exception message
112      */
113     public ServiceException( final String JavaDoc key, final String JavaDoc message )
114     {
115         this( key, message, null );
116     }
117
118     /**
119      * Return the key that caused the exception.
120      * @return the lookup key triggering the exception
121      */
122     public String JavaDoc getKey()
123     {
124         return m_key;
125     }
126
127     /**
128      * Return the role that caused the exception
129      *
130      * @deprecated Use getKey() instead
131      * @return the the lookup key triggering the exception
132      */
133     public String JavaDoc getRole()
134     {
135         return getKey();
136     }
137
138     /**
139      * Override super's message to add role if applicable.
140      * @return a message.
141      */
142     public String JavaDoc getMessage()
143     {
144         if( m_key == null )
145         {
146             return super.getMessage();
147         }
148         else
149         {
150             return super.getMessage() + " (Key='" + m_key + "')";
151         }
152     }
153 }
154
Popular Tags