Issue checkstyle#4883: Add MT check markers

config/import-control.xml

@@ -40,6 +40,11 @@
   <allow pkg="org.antlr.v4.runtime" local-only="true"/>
   <allow class="com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser.+"
           local-only="true" regex="true"/>
+  <allow class="java.lang.annotation.ElementType" local-only="true"/>
+  <allow class="java.lang.annotation.Inherited" local-only="true"/>
+  <allow class="java.lang.annotation.Retention" local-only="true"/>
+  <allow class="java.lang.annotation.RetentionPolicy" local-only="true"/>
+  <allow class="java.lang.annotation.Target" local-only="true"/>
 
   <!-- allowed till https://github.com/checkstyle/checkstyle/issues/3455 -->
   <allow class="com.google.common.base.CaseFormat" local-only="true"/>

config/intellij-idea-inspections.xml

@@ -2144,6 +2144,9 @@ isolated classes and we cannot put them to separate package as it will affect us
                 <option value="ThisEscapedInObjectConstruction" />
                 <!-- it will makes code too complicated in some cases -->
                 <option value="MultipleReturnPointsPerMethod" />
+                <!-- till #4883 -->
+                <option value="ClassIndependentOfModule" />
+                <option value="unused" />
             </list>
         </option>
     </inspection_tool>

src/main/java/com/puppycrawl/tools/checkstyle/FileStatefulModule.java

@@ -0,0 +1,48 @@
+////////////////////////////////////////////////////////////////////////////////
+// checkstyle: Checks Java source code for adherence to a set of rules.
+// Copyright (C) 2001-2017 the original author or authors.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+////////////////////////////////////////////////////////////////////////////////
+
+package com.puppycrawl.tools.checkstyle;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation means that the module contains file-related context and therefore
+ * cannot be used from the separate threads at the same time.
+ * This annotation should be used when a module holds a thread-unsafe state.
+ * It is guaranteed that the whole file will be processed inside the same thread.
+ * It is guaranteed that the whole file will be processed with the same module instance.
+ * It is guaranteed that each module instance processes only one file at the same time.
+ * It is guaranteed that all module clones will have equal (but not the same) configuration.
+ * It means, that check cloning will be performed after the check instance is configured.
+ * It is not guaranteed that each file will have it's own thread - there might be a list of files,
+ * which will be executed on the same thread.
+ * It is not guaranteed that each file will have it's own module instance - there might be a
+ * list of files, which will be checked by the same instance.
+ * @author Andrew Kuchev
+ * @noinspection ClassIndependentOfModule, unused
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Inherited
+public @interface FileStatefulModule {
+}

src/main/java/com/puppycrawl/tools/checkstyle/GlobalStatefulModule.java

@@ -0,0 +1,47 @@
+////////////////////////////////////////////////////////////////////////////////
+// checkstyle: Checks Java source code for adherence to a set of rules.
+// Copyright (C) 2001-2017 the original author or authors.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+////////////////////////////////////////////////////////////////////////////////
+
+package com.puppycrawl.tools.checkstyle;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation means that the module contains global context,
+ * which will be updated across the entire application's lifetime.
+ * across the entire application lifetime. This also means, that all files will be processed
+ * by the same module instance.
+ * This annotation should be used, if a module accumulates some information across the application
+ * lifetime, and processed only once at the end of application lifetime (however, the module still
+ * can produce some messages, while collecting information).
+ * The check methods and fields should be thread safe, because they may be accessed from separate
+ * threads at the same time.
+ * It is guaranteed that there will be exactly one module instance
+ * This is simular to multi-file validation, which checkstyle does not support fully yet.
+ * @author Andrew Kuchev
+ * @noinspection ClassIndependentOfModule, unused
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Inherited
+public @interface GlobalStatefulModule {
+}

src/main/java/com/puppycrawl/tools/checkstyle/StatelessModule.java

@@ -0,0 +1,45 @@
+////////////////////////////////////////////////////////////////////////////////
+// checkstyle: Checks Java source code for adherence to a set of rules.
+// Copyright (C) 2001-2017 the original author or authors.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+////////////////////////////////////////////////////////////////////////////////
+
+package com.puppycrawl.tools.checkstyle;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * This annotation means that the module does not contain mutable state and
+ * may be safely used from separate threads at the same time.
+ * A module does not contain mutable state, if it does not change any field values at the execution
+ * stage (but it still can set properties at the initialization stage). The best practice is to use
+ * final fields where possible and carefully review all mutable fields. Note, that a final list
+ * is still mutable, therefore each mutable container must also be carefully reviewed.
+ * It is guaranteed that there will be exactly one module instance
+ * across the entire application lifetime. This also means, that all files will be processed
+ * by the same module instance.
+ * @author Andrew Kuchev
+ * @noinspection ClassIndependentOfModule, unused
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Inherited
+public @interface StatelessModule {
+}