From 11775ed6b089c88a1139d7a7b9fbc78ec73a210e Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flo@geekplace.eu>
Date: Mon, 15 Apr 2019 09:46:43 +0200
Subject: [PATCH] Add checkstyle rule for 'synchronized' on
 Manager.getInstanceFor()

---
 config/checkstyle.xml                               | 13 +++++++++++++
 .../org/jivesoftware/smackx/mam/MamManager.java     |  2 ++
 2 files changed, 15 insertions(+)

diff --git a/config/checkstyle.xml b/config/checkstyle.xml
index 041e31ffb..d925f4909 100644
--- a/config/checkstyle.xml
+++ b/config/checkstyle.xml
@@ -6,6 +6,11 @@
 	<module name="SuppressionFilter">
 		<property name="file" value="config/suppressions.xml"/>
 	</module>
+	<module name="SuppressWithPlainTextCommentFilter">
+		<property name="offCommentFormat" value="CHECKSTYLE\:OFF\:(\w+)"/>
+		<property name="onCommentFormat" value="CHECKSTYLE\:ON\:(\w+)"/>
+		<property name="checkFormat" value="$1"/>
+	</module>
 	<module name="Header">
 		<property name="headerFile" value="config/${checkstyleLicenseHeader}.txt"/>
 		<property name="ignoreLines" value="3"/>
@@ -61,6 +66,14 @@
 		<property name="format" value="^\s*//[^\s]"/>
 		<property name="message" value="Comment start ('//') followed by non-space character. You would not continue after a punctuation without a space, would you?"/>
 	</module>
+	<!-- Check for synchronized keyword on Manager's static
+	     getInstanceFor() method. Note that if XMPPConnection is every
+	     replaced with something else, then we need to change it here
+	     too. -->
+	<module name="RegexpSingleline">
+		<property name="format" value="^\s*public(?!.*synchronized).*getInstanceFor\(XMPPConnection.*$"/>
+		<property name="message" value="getInstanceFor() should be synchronized"/>
+	</module>
 	<module name="JavadocPackage"/>
 	<module name="TreeWalker">
 		<module name="SuppressionCommentFilter"/>
diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java
index ba3af51aa..2c72c8229 100644
--- a/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java
+++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java
@@ -178,7 +178,9 @@ public final class MamManager extends Manager {
      * @param connection the XMPP connection to get the archive for.
      * @return the instance of MamManager.
      */
+    // CHECKSTYLE:OFF:RegexpSingleline
     public static MamManager getInstanceFor(XMPPConnection connection) {
+    // CHECKSTYLE:ON:RegexpSingleline
         return getInstanceFor(connection, (Jid) null);
     }