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

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

Author: mark.proctor at jboss.com
Date: 2009-05-13 18:41:17 -0400 (Wed, 13 May 2009)
New Revision: 26519

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/WorkingMemoryEntryPoint.java
Log:
JBRULES-2057 Collection returned by StatefulKnowledgeSession.getObjects() doesn't conform to standard collection behaviour

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/WorkingMemoryEntryPoint.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/WorkingMemoryEntryPoint.java	2009-05-13 22:31:29 UTC (rev 26518)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/WorkingMemoryEntryPoint.java	2009-05-13 22:41:17 UTC (rev 26519)
@@ -84,8 +84,19 @@
     Object getObject(FactHandle factHandle);
 
     /**
-     * Returns all facts from the current session.
+     * <p>
+     * Returns all facts from the current session as a Collection.
+     * </p>
      * 
+     * <p>This class is <i>not</i> a general-purpose <tt>Collection</tt>
+     * implementation!  While this class implements the <tt>Collection</tt> interface, it
+     * intentionally violates <tt>Collection</tt> general contract, which mandates the
+     * use of the <tt>equals</tt> method when comparing objects.</p>
+     * 
+     * <p>Instead the approach used when comparing objects with the <tt>contains(Object)</tt>
+     * method is dependent on the WorkingMemory configuration, where it can be configured for <tt>Identity</tt>
+     * or for <tt>Equality</tt>.</p> 
+     * 
      * @return
      */
     Collection< Object > getObjects();