01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: * $Header:$
18: */
19: package org.apache.beehive.controls.api.assembly;
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: * A ControlAssembler implementation's assemble method is called once
37: * per control assembler per module per assembly-time pass. The call
38: * passes a ControlAssemblyContext, from which information such as the
39: * list of client classes in the module that use the control can be
40: * obtained.
41: */
42: void assemble(ControlAssemblyContext cac)
43: throws ControlAssemblyException;
44: }
|