From d462fb3a13765b25488065d6248c2c5cfd023ffa Mon Sep 17 00:00:00 2001
From: Mahmoud Ben Hassine <mbenhassine@pivotal.io>
Date: Sun, 3 May 2020 17:15:40 +0200
Subject: [PATCH] Add note that it's not intended to remove facts using
 Facts#iterator

Issue #268
---
 .../src/main/java/org/jeasy/rules/api/Facts.java            | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/easy-rules-core/src/main/java/org/jeasy/rules/api/Facts.java b/easy-rules-core/src/main/java/org/jeasy/rules/api/Facts.java
index 0394bc2..55b8811 100644
--- a/easy-rules-core/src/main/java/org/jeasy/rules/api/Facts.java
+++ b/easy-rules-core/src/main/java/org/jeasy/rules/api/Facts.java
@@ -89,6 +89,12 @@ public class Facts implements Iterable<Map.Entry<String, Object>> {
         return new HashMap<>(facts);
     }
 
+    /**
+     * Return an iterator on the set of facts. It is not intended to remove
+     * facts using this iterator outside of the rules engine (aka other than doing it through rules)
+     * 
+     * @return an iterator on the set of facts
+     */
     @Override
     public Iterator<Map.Entry<String, Object>> iterator() {
         return facts.entrySet().iterator();