KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > framework > availability > UnavailableException


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.avalon.framework.availability;
18  
19 /** Exception to signal component is not available.
20  *
21  * UnavailableException is thrown in any method to another component,
22  * but only if the caller implements AvailabilityAware.
23  *
24  * @since 4.5
25  *
26  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
27  * @version $Id$
28  */
29 public class UnavailableException extends RuntimeException JavaDoc
30 {
31     private String JavaDoc m_Key;
32     
33     /** Constructor.
34      * @param message The non-localized message to be embedded into the
35      * exception.
36      *
37      * @param key The key that the caller used to lookup the component
38      * with.
39      */
40     public UnavailableException( String JavaDoc message, String JavaDoc key )
41     {
42         super( message );
43         m_Key = key;
44     }
45    
46     /** Returns the key to the component that is no longer available.
47      *
48      */
49     public String JavaDoc getLookupKey()
50     {
51         return m_Key;
52     }
53 }
Popular Tags