KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > controls > api > assembly > ControlAssembler


1 package org.apache.beehive.controls.api.assembly;
2
3 /*
4  * Copyright 2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * $Header:$
19  */
20
21 /**
22  * Control implementations may need to do build-time work on or impacted by
23  * their control client(s), such as side-effecting their client's deployment
24  * descriptors, or generating additional files that are implementation-
25  * specific.
26  *
27  * The build phase where this work is done is called assembly, and occurs
28  * at the granularity level of the J2EE module.
29  * The control author participates in this phase by authoring classes that
30  * implement the ControlAssembler interface, and associating such classes
31  * with control implementations. Instances of ControlAssembler are then
32  * called at assembly-time by build tools.
33  */
34 public interface ControlAssembler
35 {
36     /**
37      * A ControlAssembler implementation's assemble method is called once
38      * per control assembler per module per assembly-time pass. The call
39      * passes a ControlAssemblyContext, from which information such as the
40      * list of client classes in the module that use the control can be
41      * obtained.
42      */
43     void assemble(ControlAssemblyContext cac) throws ControlAssemblyException;
44 }
45
46
Popular Tags