| java.lang.Object
 org.apache.beehive.controls.runtime.generator.apt.ControlClientManifest
| ControlClientManifest | | public class ControlClientManifest (Code) | | The controls client manifest (aka "client manifest") surfaces the set of
control types used by a client, and make the assembly process more
efficient. The control client annotation processor generates a client
manifest documenting the set of used control types. This manifest is a
java.util.Properties file that specifies:
- classname of the control client
- classnames of each control type used by that control client (the set
identified by @Control and @ControlReference usages) and the
corresponding default implementation binding
Example client manifest:
FooImpl.controls.properties
---------------------------
.client.name=org.acme.controls.FooImpl
org.acme.controls.CustomerDbBean=org.apache.beehive.controls.scl.DatabaseControlImpl
org.acme.controls.DailyTimerBean=org.apache.beehive.controls.scl.TimerControlImpl
The manifest is a generated artifact and is not user-editable. Ideally, the apt
environment optimizes the writing of the manifest such that it's only written
to disk when changes occur (allowing external build tools to use the timestamp of
the manifest to determine whether assembly on a client needs to occur).
|
| BEEHIVE_VERSION_PROP | | final public static String BEEHIVE_VERSION_PROP(Code) | | |
| CLIENT_NAME_PROP | | final public static String CLIENT_NAME_PROP(Code) | | |
| FILE_EXTENSION | | final public static String FILE_EXTENSION(Code) | | |
| ControlClientManifest | | public ControlClientManifest(String client)(Code) | | Creates a new ControlClientManifest
Parameters:
client - the fully qualified classname of the control client |
| addControlType | | public void addControlType(String intf, String impl)(Code) | | Adds a new control type to the manifest
Parameters:
intf - fully qualified name of the control type
Parameters:
impl - fully qualified name of the default implementation for the control type |
| emit | | public void emit(Filer f, String pkg, File mf, String csn) throws IOException(Code) | | Emits the manifest via an apt Filer implementation
Parameters:
f - an apt Filer
Parameters:
pkg - the package structure to place the manifest in
Parameters:
mf - the name of the manifest
throws:
IOException - |
| getControlClient | | public String getControlClient()(Code) | | the name of the control client in this manifest |
| getControlTypes | | public List<String> getControlTypes()(Code) | | a list of all control types listed in the manifest |
| getDefaultImpl | | public String getDefaultImpl(String controlType)(Code) | |
Parameters:
controlType - the default implementation for the control type listed in the manifest |
|
|