|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectControlClientManifest
public class ControlClientManifest
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).
Field Summary | |
---|---|
static String |
BEEHIVE_VERSION_PROP
|
static String |
CLIENT_NAME_PROP
|
static String |
FILE_EXTENSION
|
Constructor Summary | |
---|---|
ControlClientManifest(File f)
Loads a ControlClientManifest from an existing manifest file. |
|
ControlClientManifest(String client)
Creates a new ControlClientManifest |
Method Summary | |
---|---|
void |
addControlType(String intf,
String impl)
Adds a new control type to the manifest |
void |
emit(Filer f,
String pkg,
File mf,
String csn)
Emits the manifest via an apt Filer implementation |
String |
getControlClient()
|
List<String> |
getControlTypes()
|
String |
getDefaultImpl(String controlType)
|
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CLIENT_NAME_PROP
public static final String BEEHIVE_VERSION_PROP
public static final String FILE_EXTENSION
Constructor Detail |
---|
public ControlClientManifest(File f) throws FileNotFoundException, IOException
f
- the manifest file
FileNotFoundException
IOException
public ControlClientManifest(String client)
client
- the fully qualified classname of the control clientMethod Detail |
---|
public String getControlClient()
public void addControlType(String intf, String impl)
intf
- fully qualified name of the control typeimpl
- fully qualified name of the default implementation for the control typepublic List<String> getControlTypes()
public String getDefaultImpl(String controlType)
controlType
-
public void emit(Filer f, String pkg, File mf, String csn) throws IOException
f
- an apt Filerpkg
- the package structure to place the manifest inmf
- the name of the manifest
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |