KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > core > component > lifecycle > Initializable


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */

17
18 package org.sape.carbon.core.component.lifecycle;
19
20 import org.sape.carbon.core.component.Component;
21
22 /**
23  * This interface should be implemented by Components that wish to provide a
24  * callback method to participate in container initialize operations. Work
25  * that is usually performed in the constructor can be placed here so that
26  * the container has more control. Also implement this interface if your
27  * Functional Implementation requires a reference to itself.
28  *
29  * Copyright 2002 Sapient
30  * @since carbon 1.0
31  * @author Chris Herron, January 2002
32  * @version $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/05/05 21:21:13 $)
33  */

34 public interface Initializable {
35     /**
36      * Initialize the component. Called immediately after the Component's
37      * constructor. On return, the container may start the component.
38      *
39      * @param thisComponent the reference to the component that this object
40      * is a part of. Store this referece within your Functional Implementation
41      * for future use.
42      *
43      * @throws Exception when there is a failure to initialize the component
44      */

45     void initialize(Component thisComponent) throws Exception JavaDoc;
46 }
47
Popular Tags