/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * $Header:$
 */
package org.apache.beehive.controls.api.assembly;

/**
 * Control implementations may need to do build-time work on or impacted by
 * their control client(s), such as side-effecting their client's deployment
 * descriptors, or generating additional files that are implementation-
 * specific.
 *
 * The build phase where this work is done is called assembly, and occurs
 * at the granularity level of the J2EE module.
 * The control author participates in this phase by authoring classes that
 * implement the ControlAssembler interface, and associating such classes
 * with control implementations.  Instances of ControlAssembler are then
 * called at assembly-time by build tools.
 */
public interface ControlAssembler
{
    /**
     * A ControlAssembler implementation's assemble method is called once
     * per control assembler per module per assembly-time pass.  The call
     * passes a ControlAssemblyContext, from which information such as the
     * list of client classes in the module that use the control can be
     * obtained.
     */
    void assemble(ControlAssemblyContext cac) throws ControlAssemblyException;
}