KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > framework > component > ComponentException


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.component;
56
57 import org.apache.avalon.framework.CascadingException;
58
59 /**
60  * The exception thrown to indicate a problem with Components.
61  * It is usually thrown by ComponentManager or ComponentSelector.
62  *
63  * <p>
64  * <span style="color: red">Deprecated: </span><i>
65  * Use {@link org.apache.avalon.framework.service.ServiceException} instead.
66  * </i>
67  * </p>
68  *
69  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
70  * @version CVS $Revision: 1.20 $ $Date: 2003/02/11 15:58:38 $
71  */
72 public class ComponentException
73     extends CascadingException
74 {
75     private final String JavaDoc m_key;
76
77     /**
78      * Construct a new <code>ComponentException</code> instance.
79      * @param key the lookup key
80      * @param message the exception message
81      * @param throwable the throwable
82      */
83     public ComponentException( final String JavaDoc key,
84                                final String JavaDoc message,
85                                final Throwable JavaDoc throwable )
86     {
87         super( message, throwable );
88         m_key = key;
89     }
90
91     /**
92      * Construct a new <code>ComponentException</code> instance.
93      *
94      * @deprecated use the String, String, Throwable version to record the role
95      * @param message the exception message
96      * @param throwable the throwable
97      */
98     public ComponentException( final String JavaDoc message, final Throwable JavaDoc throwable )
99     {
100         this( null, message, throwable );
101     }
102
103     /**
104      * Construct a new <code>ComponentException</code> instance.
105      *
106      * @deprecated use the String, String version to record the role
107      * @param message the exception message
108      */
109     public ComponentException( final String JavaDoc message )
110     {
111         this( null, message, null );
112     }
113
114     /**
115      * Construct a new <code>ComponentException</code> instance.
116      * @param key the lookup key
117      * @param message the exception message
118      */
119     public ComponentException( final String JavaDoc key, final String JavaDoc message )
120     {
121         this( key, message, null );
122     }
123
124     /**
125      * Get the key which let to the exception. May be null.
126      *
127      * @return The key which let to the exception.
128      */
129     public final String JavaDoc getKey()
130     {
131         return m_key;
132     }
133
134     /**
135      * Get the key which let to the exception. May be null.
136      *
137      * @return The key which let to the exception.
138      * @deprecated Use getKey instead
139      */
140     public final String JavaDoc getRole()
141     {
142         return getKey();
143     }
144
145     /**
146      * Return a message describing the exception.
147      *
148      * @return exception message.
149      */
150     public String JavaDoc getMessage()
151     {
152         if( m_key == null )
153         {
154             return super.getMessage();
155         }
156         else
157         {
158             return super.getMessage() + " (key [" + m_key + "])";
159         }
160     }
161 }
162
Popular Tags