KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > ContainerListener


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.kernel;
65
66 import com.jcorporate.expresso.kernel.exception.ContainerVetoException;
67
68 import java.util.EventListener JavaDoc;
69
70 /**
71  * This class is to provide for event notifications whenever a parent
72  * container changes. Event Handers should work hard to be 'quick' about their
73  * processing so that they don't hold up the hold system while events are
74  * getting handled
75  * <p><b>Also Please Note:</b> Implementers of the Container Listener should
76  * ideally have their event handlers marked <b>synchronized</b>.</p>
77  *
78  * @author Michael Rimov
79  */
80 public interface ContainerListener extends EventListener JavaDoc {
81
82     /**
83      * Called whenever a new component is added to the container. The listener
84      * has the opportunity to strenusously object to the component being added
85      * by throwing a ContainerVetoException. This should only occur whenever
86      * installing the new component would seriously harm the operation of the
87      * current controller... ie extreme cases only.
88      *
89      * @param newComponent the new component instance getting installed.
90      * @throws ContainerVetoException if the component should NOT be installed
91      * for some reason or another.
92      */
93     public void onAdd(ExpressoComponent newComponent)
94             throws ContainerVetoException;
95
96
97     /**
98      * Called whenever a component is removed from the container. If the removal
99      * if the specified component causes SERIOUS problem with the operation of the
100      * current component, the component can throw a ContainerVetoException, however
101      * this should only occur in very rare cases.
102      *
103      * @param removingComponent The component being removed
104      */
105     public void onRemove(ExpressoComponent removingComponent)
106             throws ContainerVetoException;
107
108
109     /**
110      * Called whenever a component is installed into a component container.
111      * Since add() is called first, we don't have the option to throw
112      * ContainerVetoException since in onAdd is the chance to do so
113      *
114      * @param installingComponent the component that is getting installed
115      * @param log The InstallLog that allows us to do any final 'output notes'
116      */
117     public void onInstall(ExpressoComponent installingComponent, InstallLog log);
118
119
120     /**
121      * Called whenever a component is uninstalled from the ComponentContainer
122      *
123      * @param uninstallComponent the component that is getting uninstalled
124      * @param log The InstallLog that allows us to do any final 'output notes'
125      */
126     public void onUninstall(ExpressoComponent uninstallComponent, InstallLog log);
127
128 }
Popular Tags