[jboss-svn-commits] JBL Code SVN: r30802 - labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime.

[jboss-svn-commits at lists.jboss.org]

Author: mark.proctor at jboss.com
Date: 2009-12-22 20:34:56 -0500 (Tue, 22 Dec 2009)
New Revision: 30802

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/ExitPoint.java
Log:
-added javadocs to ExitPoint

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/ExitPoint.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/ExitPoint.java	2009-12-22 18:17:48 UTC (rev 30801)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/ExitPoint.java	2009-12-23 01:34:56 UTC (rev 30802)
@@ -1,5 +1,31 @@
 package org.drools.runtime;
 
+/**
+ * <p>
+ * An exit point provides a mechanism to send objects from the working memory to some external process 
+ * or function.  For instance, an exit point can be used to inform some piece of code that an object 
+ * matches a rule.  
+ * </p>
+ *
+ * <p>
+ * To create an exit point, implement the interface and register it with the KnowledgeRuntime:
+ * </p>
+ * <pre>
+ * ...
+ * ksession.registerExitPoint("my-exit-point", new MyExitPointImpl());
+ * </pre>
+ * 
+ * <p>
+ * Exit points are invoked from the consequence side of a rule:
+ * </p>
+ * <pre>
+ * when
+ *   ...
+ * then
+ *   exitPoint["my-exit-point"].insert(...);
+ * </pre>
+ */
+
 public interface ExitPoint {
     void insert(Object object);
 }