Author: gertv
Date: Wed Dec 1 14:12:25 2010
New Revision: 1041014
URL: http://svn.apache.org/viewvc?rev=1041014&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation
Modified:
servicemix/components/engines/servicemix-drools/trunk/pom.xml
servicemix/components/engines/servicemix-drools/trunk/src/main/java/org/apache/servicemix/drools/DroolsEndpoint.java
Modified: servicemix/components/engines/servicemix-drools/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-drools/trunk/pom.xml?rev=1041014&r1=1041013&r2=1041014&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-drools/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-drools/trunk/pom.xml Wed Dec 1
14:12:25 2010
@@ -149,6 +149,13 @@
</exclusion>
</exclusions>
</dependency>
+
+ <!-- documentation -->
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-common</artifactId>
+ <classifier>sources</classifier>
+ </dependency>
</dependencies>
<build>
Modified:
servicemix/components/engines/servicemix-drools/trunk/src/main/java/org/apache/servicemix/drools/DroolsEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-drools/trunk/src/main/java/org/apache/servicemix/drools/DroolsEndpoint.java?rev=1041014&r1=1041013&r2=1041014&view=diff
==============================================================================
---
servicemix/components/engines/servicemix-drools/trunk/src/main/java/org/apache/servicemix/drools/DroolsEndpoint.java
(original)
+++
servicemix/components/engines/servicemix-drools/trunk/src/main/java/org/apache/servicemix/drools/DroolsEndpoint.java
Wed Dec 1 14:12:25 2010
@@ -100,6 +100,8 @@ public class DroolsEndpoint extends Prov
}
/**
+ * Set the rule base to be used for handling the exchanges
+ *
* @param ruleBase the ruleBase to set
*/
public void setRuleBase(RuleBase ruleBase) {
@@ -114,6 +116,8 @@ public class DroolsEndpoint extends Prov
}
/**
+ * Specifies the resource location to load the rule base from (.drl file)
+ *
* @param ruleBaseResource the ruleBaseResource to set
*/
public void setRuleBaseResource(Resource ruleBaseResource) {
@@ -128,6 +132,8 @@ public class DroolsEndpoint extends Prov
}
/**
+ * Specifies a URL to load the rule base from (.drl file)
+ *
* @param ruleBaseURL the ruleBaseURL to set
*/
public void setRuleBaseURL(URL ruleBaseURL) {
@@ -142,6 +148,8 @@ public class DroolsEndpoint extends Prov
}
/**
+ * The namespace context to use when evaluating the rules.
+ *
* @param namespaceContext the namespaceContext to set
*/
public void setNamespaceContext(NamespaceContext namespaceContext) {
@@ -156,6 +164,8 @@ public class DroolsEndpoint extends Prov
}
/**
+ * The global variables that are available while evaluating the rule base.
+ *
* @param variables the variables to set
*/
public void setGlobals(Map<String, Object> variables) {
@@ -173,7 +183,9 @@ public class DroolsEndpoint extends Prov
/**
* Set auto-reply to <code>true</code> to ensure that every exchange is
being replied to.
- * This way, you can avoid having to end every Drools rule with
jbi.answer()
+ * This way, you can avoid having to end every Drools rule with
jbi.answer().
+ *
+ * Defaults to <code>false</code>
*
* @param autoReply <code>true</code> for auto-replying on incoming
exchanges
*/
@@ -325,6 +337,11 @@ public class DroolsEndpoint extends Prov
return defaultTargetService;
}
+ /**
+ * The default service that the exchange will be sent to if none of the
rules have handled it.
+ *
+ * @param defaultTargetService
+ */
public void setDefaultTargetService(QName defaultTargetService) {
this.defaultTargetService = defaultTargetService;
}
@@ -333,6 +350,11 @@ public class DroolsEndpoint extends Prov
return defaultTargetURI;
}
+ /**
+ * The default endpoint URI that the exchange will be sent to if none of
the rules have handled it.
+ *
+ * @param defaultTargetURI
+ */
public void setDefaultTargetURI(String defaultTargetURI) {
this.defaultTargetURI = defaultTargetURI;
}
@@ -341,6 +363,11 @@ public class DroolsEndpoint extends Prov
return assertedObjects;
}
+ /**
+ * List of additional objects to be inserted into the drools working
memory for evaluating rules.
+ *
+ * @param assertedObjects
+ */
public void setAssertedObjects(List<Object> assertedObjects) {
this.assertedObjects = assertedObjects;
}
