View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle;
21  
22  import java.lang.annotation.ElementType;
23  import java.lang.annotation.Inherited;
24  import java.lang.annotation.Retention;
25  import java.lang.annotation.RetentionPolicy;
26  import java.lang.annotation.Target;
27  
28  /**
29   * This annotation means that the check does not contain mutable state and
30   * may be safely used from others threads at the same time.
31   * The check does not contain mutable state, if it does not change any field values at the
32   * execution stage (but it still can set properties at the initialization stage).
33   * Checker guarantees that there will be exactly one check instance during the audit.
34   * This also means, that all files will be processed by the same check instance.
35   *
36   * @noinspection ClassIndependentOfModule
37   * @noinspectionreason ClassIndependentOfModule - we keep this annotation at top level by design
38   */
39  @Retention(RetentionPolicy.RUNTIME)
40  @Target(ElementType.TYPE)
41  @Inherited
42  public @interface StatelessCheck {
43  
44      // this annotation does not have properties
45  
46  }