001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle; 021 022import java.lang.annotation.ElementType; 023import java.lang.annotation.Inherited; 024import java.lang.annotation.Retention; 025import java.lang.annotation.RetentionPolicy; 026import java.lang.annotation.Target; 027 028/** 029 * This annotation means that the check contains file-related context and therefore 030 * cannot be used from the others threads at the same time. 031 * This annotation should be used when the check holds a thread-unsafe state. 032 * Checker guarantees that the whole file processed inside the same thread. 033 * Checker guarantees that the whole file processed with the same check instance. 034 * Checker guarantees that each check instance processes only one file at the same time. 035 * Checker guarantees that all check instances have equal (but not the same) configuration. 036 * It means, that if a check holds a property of type "array of strings", 037 * the property value will not be shared across check instances. 038 * Instead, each check instance will hold its own array instance. 039 * Checker does not guarantee that each file will have its own thread - 040 * there might be a list of files, which will be executed on the same thread. 041 * Checker does not guarantee that each file will have its own check instance - 042 * there might be a list of files, which will be checked by the same instance. 043 * Note: Checks with such annotation will be executed in mode how all Checks worked 044 * before MT mode is introduced. 045 * 046 * @noinspection ClassIndependentOfModule 047 * @noinspectionreason ClassIndependentOfModule - we keep this annotation at top level by design 048 */ 049@Retention(RetentionPolicy.RUNTIME) 050@Target(ElementType.TYPE) 051@Inherited 052public @interface FileStatefulCheck { 053 054 // this annotation does not have properties 055 056}