From c0b1fee700386d24c6ea5cabe1ef406df2c67930 Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flo@geekplace.eu>
Date: Sat, 25 Aug 2018 12:55:51 +0200
Subject: [PATCH] Add "rule of thumb" to StanzaFilter javadoc

---
 .../java/org/jivesoftware/smack/filter/StanzaFilter.java     | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java
index e747e87dc..914f3c3ab 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/filter/StanzaFilter.java
@@ -41,6 +41,11 @@ import org.jivesoftware.smack.packet.Stanza;
  * // Create a new stanza collector using the filter we created.
  * StanzaCollector myCollector = connection.createStanzaCollector(myFilter);
  * </pre>
+ * <p>
+ * As a rule of thumb: If you have a predicate method, that is, a method which takes a single Stanza as argument, is pure
+ * (side effect free) and returns only a boolean, then it is a good indicator that the logic should be put into a
+ * {@link StanzaFilter} (and be referenced in {@link org.jivesoftware.smack.StanzaListener}).
+ * </p>
  *
  * @see org.jivesoftware.smack.StanzaCollector
  * @see org.jivesoftware.smack.StanzaListener