KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > fractal > julia > UseComponentMixin


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;
25
26 import org.objectweb.fractal.api.Component;
27 import org.objectweb.fractal.api.factory.InstantiationException;
28
29 /**
30  * Provides a {@link Component} field to a {@link Controller}.
31  * <br>
32  * <br>
33  * <b>Requirements</b>
34  * <ul>
35  * <li>the component to which this controller belongs must provide the {@link
36  * Component} interface.</li>
37  * </ul>
38  */

39
40 public abstract class UseComponentMixin implements Controller {
41
42   // -------------------------------------------------------------------------
43
// Private constructor
44
// -------------------------------------------------------------------------
45

46   private UseComponentMixin () {
47   }
48
49   // -------------------------------------------------------------------------
50
// Fields and methods added and overriden by the mixin class
51
// -------------------------------------------------------------------------
52

53   /**
54    * The {@link Component} interface of the component to which this controller
55    * object belongs.
56    */

57
58   public Component weaveableC;
59
60   /**
61    * The {@link Component} interface of the component to which this controller
62    * object belongs.
63    */

64
65   public Component weaveableOptC;
66
67   /**
68    * Initializes the fields of this mixin and then calls the overriden method.
69    *
70    * @param ic information about the component to which this controller object
71    * belongs.
72    * @throws InstantiationException if the initialization fails.
73    */

74
75   public void initFcController (final InitializationContext ic)
76     throws InstantiationException JavaDoc
77   {
78     weaveableC = (Component)ic.getInterface("component");
79     weaveableOptC = weaveableC;
80     _super_initFcController(ic);
81   }
82
83   // -------------------------------------------------------------------------
84
// Fields and methods required by the mixin class in the base class
85
// -------------------------------------------------------------------------
86

87   /**
88    * The {@link Controller#initFcController initFcController} method overriden
89    * by this mixin.
90    *
91    * @param ic information about the component to which this controller object
92    * belongs.
93    * @throws InstantiationException if the initialization fails.
94    */

95
96   public abstract void _super_initFcController (InitializationContext ic)
97     throws InstantiationException JavaDoc;
98 }
99
Popular Tags