KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > fractal > julia > control > lifecycle > UseLifeCycleControllerMixin


1 /***
2  * Julia: France Telecom's implementation of the Fractal API
3  * Copyright (C) 2001-2002 France Telecom R&D
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: Eric.Bruneton@rd.francetelecom.com
20  *
21  * Author: Eric Bruneton
22  */
23
24 package org.objectweb.fractal.julia.control.lifecycle;
25
26 import org.objectweb.fractal.api.control.LifeCycleController;
27 import org.objectweb.fractal.api.factory.InstantiationException;
28
29 import org.objectweb.fractal.julia.Controller;
30 import org.objectweb.fractal.julia.InitializationContext;
31
32 /**
33  * Provides a {@link LifeCycleController} field to a {@link Controller}.
34  * <br>
35  * <br>
36  * <b>Requirements</b>
37  * <ul>
38  * <li>none (the component to which this controller belongs may provide the
39  * {@link LifeCycleController} interface, but this is not mandatory).</li>
40  * </ul>
41  */
42
43 public abstract class UseLifeCycleControllerMixin implements Controller {
44
45   // -------------------------------------------------------------------------
46 // Private constructor
47 // -------------------------------------------------------------------------
48
49   private UseLifeCycleControllerMixin () {
50   }
51
52   // -------------------------------------------------------------------------
53 // Fields and methods added and overriden by the mixin class
54 // -------------------------------------------------------------------------
55
56   /**
57    * The {@link LifeCycleController} interface of the component to which this
58    * controller object belongs.
59    */
60
61   public LifeCycleController weaveableOptLC;
62
63   /**
64    * Initializes the fields of this mixin and then calls the overriden method.
65    *
66    * @param ic information about the component to which this controller object
67    * belongs.
68    * @throws InstantiationException if the initialization fails.
69    */
70
71   public void initFcController (final InitializationContext ic)
72     throws InstantiationException JavaDoc
73   {
74     weaveableOptLC =
75       (LifeCycleController)ic.getOptionalInterface("lifecycle-controller");
76     _super_initFcController(ic);
77   }
78
79   // -------------------------------------------------------------------------
80 // Fields and methods required by the mixin class in the base class
81 // -------------------------------------------------------------------------
82
83   /**
84    * The {@link Controller#initFcController initFcController} method overriden
85    * by this mixin.
86    *
87    * @param ic information about the component to which this controller object
88    * belongs.
89    * @throws InstantiationException if the initialization fails.
90    */
91   
92   public abstract void _super_initFcController (InitializationContext ic)
93     throws InstantiationException JavaDoc;
94 }
95
Popular Tags