001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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 global context,
030 * which will be updated while Checkstyle processes files. This also means,
031 * that all files will be processed by the same check instance.
032 * This annotation should be used, if a check accumulates some information during the audit,
033 * and processed only once at the end of the audit (however, the check still
034 * can produce some messages, while collecting information).
035 * The check methods and fields should be thread safe, because they may be accessed from others
036 * threads at the same time.
037 * Checker guarantees that there will be exactly one check instance
038 * This is simular to multi-file validation, which checkstyle does not support fully yet.
039 * Please refer to https://github.com/checkstyle/checkstyle/issues/3540 for details.
040 * @author Andrew Kuchev
041 * @noinspection AnnotationClass, ClassIndependentOfModule, unused
042 */
043@Retention(RetentionPolicy.RUNTIME)
044@Target(ElementType.TYPE)
045@Inherited
046public @interface GlobalStatefulCheck {
047    // this annotation does not have properties
048}