summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Liebig2008-03-14 03:20:33 (EDT)
committerStefan Liebig2008-03-14 03:20:33 (EDT)
commitbfff67a69400e8f626e93dab72f3dae8713c2f7b (patch)
treed4d80f671d9b1ab6af2ebd53f17c42cd52215a79
parentfb4da26cc6bcf0730c0f58bcd38cef42614eabae (diff)
downloadorg.eclipse.riena-bfff67a69400e8f626e93dab72f3dae8713c2f7b.zip
org.eclipse.riena-bfff67a69400e8f626e93dab72f3dae8713c2f7b.tar.gz
org.eclipse.riena-bfff67a69400e8f626e93dab72f3dae8713c2f7b.tar.bz2
javadoc
-rw-r--r--org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionId.java16
-rw-r--r--org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionInjector.java19
2 files changed, 33 insertions, 2 deletions
diff --git a/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionId.java b/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionId.java
index 1958b00..75598b4 100644
--- a/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionId.java
+++ b/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionId.java
@@ -59,6 +59,8 @@ public class ExtensionId {
public static final int UNBOUNDED = Integer.MAX_VALUE;
/**
+ * Create an extension id for the given extension point id.
+ *
* @param extensionPointId
*/
public ExtensionId(String extensionPointId) {
@@ -67,6 +69,10 @@ public class ExtensionId {
}
/**
+ * Define the interface type used as a bean for injecting. <br>
+ * If not defined the extension injector tries to figure it out by
+ * reflection and the name of the ´bind´ method.
+ *
* @param interfaceType
* @return
*/
@@ -79,6 +85,8 @@ public class ExtensionId {
}
/**
+ * Inject the ´extensions´ into the specified target object.
+ *
* @param target
*/
public ExtensionInjector injectInto(Object target) {
@@ -87,6 +95,11 @@ public class ExtensionId {
}
/**
+ * Defines the minimum and the maximum occurrences of extensions allowed for
+ * the extension point. These values should correspond to the definitions
+ * within the extension point schema.<br>
+ * Future implementations might retrieve these values from the schema.
+ *
* @param min
* @param max
* @return
@@ -101,6 +114,9 @@ public class ExtensionId {
}
/**
+ * Defines that the minimum and the maximum occurrences of extensions is the
+ * same.
+ *
* @param exactly
* @return
*/
diff --git a/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionInjector.java b/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionInjector.java
index 7a71676..d3b0d9a 100644
--- a/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionInjector.java
+++ b/org.eclipse.riena.core/src/org/eclipse/riena/core/extension/ExtensionInjector.java
@@ -60,11 +60,21 @@ public class ExtensionInjector {
this.target = target;
}
+ /**
+ * Start the extension injector.<br>
+ * Started with this the extension injector will NOT modify the values with
+ * ConfigurationPlugin.
+ *
+ * @return
+ */
public ExtensionInjector andStart() {
return andStart(null);
}
/**
+ * Start the extension injector.<br>
+ * Started with this the extension injector WILL modify the values with
+ * ConfigurationPlugin.
*
* @param context
*/
@@ -95,7 +105,10 @@ public class ExtensionInjector {
}
/**
- * @param updateMethodName
+ * Define the bind method name.<br>
+ * If not given ´update´ will be assumed.
+ *
+ * @param bindMethodName
*/
public ExtensionInjector bind(String bindMethodName) {
Assert.isNotNull(bindMethodName, "Bind method name must not be null");
@@ -105,6 +118,8 @@ public class ExtensionInjector {
}
/**
+ * Explicitly forbid tracking of changes of the extensions.
+ *
* @return
*/
public ExtensionInjector doNotTrack() {
@@ -115,7 +130,7 @@ public class ExtensionInjector {
}
/**
- *
+ * Stop the extension injector.
*/
public void stop() {
if (!started)