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.internal.testmodules;
21  
22  import java.io.File;
23  
24  import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
25  import com.puppycrawl.tools.checkstyle.api.FileText;
26  
27  /**
28   * TestFileSetCheck.
29   *
30   * @noinspection ClassOnlyUsedInOnePackage
31   * @noinspectionreason ClassOnlyUsedInOnePackage - class is internal tool, and only used in testing
32   */
33  public class TestFileSetCheck extends AbstractFileSetCheck {
34  
35      private boolean called;
36  
37      @Override
38      protected void processFiltered(File file, FileText fileText) {
39          called = true;
40      }
41  
42      /**
43       * Checks if {@link #processFiltered(File, FileText)} was called.
44       *
45       * @return {@code true} if it was called.
46       */
47      public boolean wasCalled() {
48          return called;
49      }
50  
51      /**
52       * Resets the check for testing.
53       */
54      public void resetCheck() {
55          called = false;
56      }
57  
58  }