KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > fortress > impl > handler > ComponentHandler


1 /*
2  * Copyright 2003-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
18 package org.apache.avalon.fortress.impl.handler;
19
20 /**
21  * The ComponentHandler interface marks the ComponentHandler implementations.
22  * The desire for a ComponentHandler is to manage the instances of a
23  * Component.
24  *
25  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
26  * @version CVS $Revision: 1.8 $ $Date: 2004/02/28 15:16:25 $
27  * @since 4.0
28  */

29 public interface ComponentHandler
30 {
31     /**
32      * Return the component's class that this handler is trying to create.
33      * Used for deubug information.
34      *
35      * @return the <code>Class</code> object for the component
36      */

37     Class JavaDoc getComponentClass();
38
39     /**
40      * Actually prepare the handler and make it ready to
41      * handle component access.
42      *
43      * @exception Exception if unable to prepare handler
44      */

45     void prepareHandler()
46         throws Exception JavaDoc;
47
48     /**
49      * Gets the current reference to a Component according to the policy of
50      * the implementation.
51      * @exception Exception if unable to ge tthe compoennt reference
52      */

53     Object JavaDoc get() throws Exception JavaDoc;
54
55     /**
56      * Puts the reference back in the ComponentHandler according to the
57      * policy of the implementation.
58      * @param component the component to return to the handler
59      */

60     void put( Object JavaDoc component );
61 }
62
Popular Tags